TSLUnitOfMeasure Class Reference

Inheritance diagram for TSLUnitOfMeasure:

Detailed Description

Any of the systems devised to measure some physical quantity such distance or area or a system devised to measure such things as the passage of time.

The classes of UnitOfMeasure are determined by the member "measureType." Subclasses are not needed for implementation, but their use makes type constraints on measure valued attributes easier to specify.

– conversionToISOstandardUnit is not null only if the conversion is a simple scale

Public Member Functions
	TSLUnitOfMeasure ()
	TSLUnitOfMeasure (const TSLUnitOfMeasure &right)
virtual	~TSLUnitOfMeasure ()
TSLUnitOfMeasure &	operator= (const TSLUnitOfMeasure &right)
void	measureType (TSLMeasureType input)
void	nameStandardUnit (TSLCharacterString *input, bool assumeOwnership=true)
void	nameStandardUnit (const char *input)
void	scaleToStandardUnit (double *input, bool assumeOwnership=true)
void	offsetToStandardUnit (double *input, bool assumeOwnership=true)
void	formula (TSLCharacterString *input, bool assumeOwnership=true)
void	formula (const char *input)
void	subunit (TSLSubUnitsPerUnit *val, bool assumeOwnership=true)
virtual TSLUnitOfMeasure *	clone () const
virtual bool	serialize (void *outputStreamOfXML, int indentation=-1, bool isRootHandler=true) const
const TSLCharacterString &	uomName () const
TSLCharacterString &	uomName ()
void	uomName (const TSLCharacterString &input)
void	uomName (const char *input)
const TSLCharacterString &	uomSymbol () const
TSLCharacterString &	uomSymbol ()
void	uomSymbol (const TSLCharacterString &input)
void	uomSymbol (const char *input)
TSLMeasureType	measureType () const
const TSLCharacterString *	nameStandardUnit () const
TSLCharacterString *	nameStandardUnit ()
const double *	scaleToStandardUnit () const
double *	scaleToStandardUnit ()
const double *	offsetToStandardUnit () const
double *	offsetToStandardUnit ()
const TSLCharacterString *	formula () const
TSLCharacterString *	formula ()
const TSLSubUnitsPerUnit *	subunit () const
TSLSubUnitsPerUnit *	subunit ()

Static Public Member Functions
static TSLUnitOfMeasure *	create ()

Constructor & Destructor Documentation

TSLUnitOfMeasure() [1/2]

TSLUnitOfMeasure::TSLUnitOfMeasure

(

)

The default constructor.

TSLUnitOfMeasure() [2/2]

TSLUnitOfMeasure::TSLUnitOfMeasure

(

const TSLUnitOfMeasure &

right

)

The copy constructor.

~TSLUnitOfMeasure()

virtual TSLUnitOfMeasure::~TSLUnitOfMeasure ( )

virtual

The destructor.

Member Function Documentation

clone()

virtual TSLUnitOfMeasure * TSLUnitOfMeasure::clone ( ) const

virtual

Clone method for derived or derived from classes. Creates object on the heap, so the pointer must be deleted

Reimplemented in TSLUomAngle, TSLUomArea, TSLUomCurrency, TSLUomLength, TSLUomScale, TSLUomTime, TSLUomVelocity, TSLUomVolume, and TSLUomWeight.

create()

static TSLUnitOfMeasure * TSLUnitOfMeasure::create ( )

static

formula() [1/4]

TSLCharacterString * TSLUnitOfMeasure::formula ( )

inline

Returns the formula attribute.

formula() [2/4]

const TSLCharacterString * TSLUnitOfMeasure::formula ( ) const

inline

Returns the formula attribute.

formula() [3/4]

void TSLUnitOfMeasure::formula

(

const char *

input

)

Overload to allow assignment of string as a literal.

formula() [4/4]

void TSLUnitOfMeasure::formula	(	TSLCharacterString *	input,
		bool	assumeOwnership = true )

Sets the formula attribute.

measureType() [1/2]

TSLMeasureType TSLUnitOfMeasure::measureType ( ) const

inline

Returns the measureType attribute. Returns TSLMeasureTypeNULL if uninitialised.

measureType() [2/2]

void TSLUnitOfMeasure::measureType

(

TSLMeasureType

input

)

Sets the measureType attribute. TSLMeasureTypeNULL is not valid.

nameStandardUnit() [1/4]

TSLCharacterString * TSLUnitOfMeasure::nameStandardUnit ( )

inline

Returns the nameStandardUnit attribute.

nameStandardUnit() [2/4]

const TSLCharacterString * TSLUnitOfMeasure::nameStandardUnit ( ) const

inline

Returns the nameStandardUnit attribute.

nameStandardUnit() [3/4]

void TSLUnitOfMeasure::nameStandardUnit

(

const char *

input

)

Overload to allow assignment of string as a literal.

nameStandardUnit() [4/4]

void TSLUnitOfMeasure::nameStandardUnit	(	TSLCharacterString *	input,
		bool	assumeOwnership = true )

Sets the nameStandardUnit attribute.

offsetToStandardUnit() [1/3]

double * TSLUnitOfMeasure::offsetToStandardUnit ( )

inline

Returns the offsetToStandardUnit attribute.

offsetToStandardUnit() [2/3]

const double * TSLUnitOfMeasure::offsetToStandardUnit ( ) const

inline

Returns the offsetToStandardUnit attribute.

offsetToStandardUnit() [3/3]

void TSLUnitOfMeasure::offsetToStandardUnit	(	double *	input,
		bool	assumeOwnership = true )

Sets the offsetToStandardUnit attribute.

operator=()

TSLUnitOfMeasure & TSLUnitOfMeasure::operator=

(

const TSLUnitOfMeasure &

right

)

Assignment operator.

scaleToStandardUnit() [1/3]

double * TSLUnitOfMeasure::scaleToStandardUnit ( )

inline

Returns the scaleToStandardUnit attribute.

scaleToStandardUnit() [2/3]

const double * TSLUnitOfMeasure::scaleToStandardUnit ( ) const

inline

Returns the scaleToStandardUnit attribute.

scaleToStandardUnit() [3/3]

void TSLUnitOfMeasure::scaleToStandardUnit	(	double *	input,
		bool	assumeOwnership = true )

Sets the scaleToStandardUnit attribute.

serialize()

virtual bool TSLUnitOfMeasure::serialize ( void * outputStreamOfXML, int indentation = -1, bool isRootHandler = true ) const

virtual

Reimplemented in TSLUomAngle, TSLUomArea, TSLUomCurrency, TSLUomLength, TSLUomScale, TSLUomTime, TSLUomVelocity, TSLUomVolume, and TSLUomWeight.

subunit() [1/3]

TSLSubUnitsPerUnit * TSLUnitOfMeasure::subunit ( )

inline

subunit() [2/3]

const TSLSubUnitsPerUnit * TSLUnitOfMeasure::subunit ( ) const

inline

subunit() [3/3]

void TSLUnitOfMeasure::subunit	(	TSLSubUnitsPerUnit *	val,
		bool	assumeOwnership = true )

uomName() [1/4]

TSLCharacterString & TSLUnitOfMeasure::uomName ( )

inline

Returns the uomName attribute.

uomName() [2/4]

const TSLCharacterString & TSLUnitOfMeasure::uomName ( ) const

inline

Returns the uomName attribute.

uomName() [3/4]

void TSLUnitOfMeasure::uomName ( const char * input )

inline

Overload to allow assignment of string as a literal.

uomName() [4/4]

void TSLUnitOfMeasure::uomName ( const TSLCharacterString & input )

inline

Sets the uomName attribute.

uomSymbol() [1/4]

TSLCharacterString & TSLUnitOfMeasure::uomSymbol ( )

inline

Returns the uomSymbol attribute.

uomSymbol() [2/4]

const TSLCharacterString & TSLUnitOfMeasure::uomSymbol ( ) const

inline

Returns the uomSymbol attribute.

uomSymbol() [3/4]

void TSLUnitOfMeasure::uomSymbol ( const char * input )

inline

Overload to allow assignment of string as a literal.

uomSymbol() [4/4]

void TSLUnitOfMeasure::uomSymbol ( const TSLCharacterString & input )

inline

Sets the uomSymbol attribute.