IUnitBuilder Struct Reference

Builder component of Unit objects. Contains setter methods to configure the Unit parameters, and a build method that builds the Unit object. More...

Inheritance diagram for IUnitBuilder:

Collaboration diagram for IUnitBuilder:

Detailed Description

Builder component of Unit objects. Contains setter methods to configure the Unit parameters, and a build method that builds the Unit object.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	build (IUnit **unit)=0
	Builds and returns a Unit object using the currently set values of the Builder. More...
virtual ErrCode INTERFACE_FUNC	setId (Int id)=0
	Sets the unit ID as defined in Codes for Units of Measurement used in International Trade. More...
virtual ErrCode INTERFACE_FUNC	getId (Int *id)=0
	Gets the unit ID as defined in Codes for Units of Measurement used in International Trade. More...
virtual ErrCode INTERFACE_FUNC	setSymbol (IString *symbol)=0
	Sets the symbol of the unit, i.e. "m/s". More...
virtual ErrCode INTERFACE_FUNC	getSymbol (IString **symbol)=0
	Gets the symbol of the unit, i.e. "m/s". More...
virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the full name of the unit, i.e. "meters per second". More...
virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the full name of the unit, i.e. "meters per second". More...
virtual ErrCode INTERFACE_FUNC	setQuantity (IString *quantity)=0
	Sets the quantity represented by the unit, i.e. "Velocity". More...
virtual ErrCode INTERFACE_FUNC	getQuantity (IString **quantity)=0
	Gets the quantity represented by the unit, i.e. "Velocity". More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

build()

virtual ErrCode INTERFACE_FUNC build ( IUnit **  unit )

pure virtual

Builds and returns a Unit object using the currently set values of the Builder.

Parameters

[out]

unit

The built Unit.

getId()

virtual ErrCode INTERFACE_FUNC getId ( Int *  id )

pure virtual

Gets the unit ID as defined in Codes for Units of Measurement used in International Trade.

Parameters

[out]

id

The unit ID.

Returns -1 if the unit id is not available.

getName()

virtual ErrCode INTERFACE_FUNC getName ( IString **  name )

pure virtual

Gets the full name of the unit, i.e. "meters per second".

Parameters

[out]

name

The unit's full name.

nullptr if not set.

getQuantity()

virtual ErrCode INTERFACE_FUNC getQuantity ( IString **  quantity )

pure virtual

Gets the quantity represented by the unit, i.e. "Velocity".

Parameters

[out]

quantity

The unit's quantity.

nullptr if not set.

getSymbol()

virtual ErrCode INTERFACE_FUNC getSymbol ( IString **  symbol )

pure virtual

Gets the symbol of the unit, i.e. "m/s".

Parameters

[out]

symbol

The unit's symbol.

setId()

virtual ErrCode INTERFACE_FUNC setId ( Int  id )

pure virtual

Sets the unit ID as defined in Codes for Units of Measurement used in International Trade.

Parameters

id	The unit ID.

The ID should be -1 if the unit is not available.

setName()

virtual ErrCode INTERFACE_FUNC setName ( IString *  name )

pure virtual

Sets the full name of the unit, i.e. "meters per second".

Parameters

name	The unit's full name.

setQuantity()

virtual ErrCode INTERFACE_FUNC setQuantity ( IString *  quantity )

pure virtual

Sets the quantity represented by the unit, i.e. "Velocity".

Parameters

quantity

The unit's quantity.

setSymbol()

virtual ErrCode INTERFACE_FUNC setSymbol ( IString *  symbol )

pure virtual

Sets the symbol of the unit, i.e. "m/s".

Parameters

symbol

The unit's symbol.