IDimensionBuilder Struct Reference

Configuration component of Dimension objects. Contains setter methods that allow for Dimension parameter configuration, and a build method that builds the Dimension. More...

Inheritance diagram for IDimensionBuilder:

Collaboration diagram for IDimensionBuilder:

Detailed Description

Configuration component of Dimension objects. Contains setter methods that allow for Dimension parameter configuration, and a build method that builds the Dimension.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	build (IDimension **dimension)=0
	Builds and returns a Dimension object using the currently set values of the Builder. More...
virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the name of the dimension. More...
virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the name of the dimension. More...
virtual ErrCode INTERFACE_FUNC	setUnit (IUnit *unit)=0
	Sets the unit of the dimension's labels. More...
virtual ErrCode INTERFACE_FUNC	getUnit (IUnit **unit)=0
	Gets the unit of the dimension's labels. More...
virtual ErrCode INTERFACE_FUNC	setRule (IDimensionRule *rule)=0
	Sets the rule that defines the labels and size of the dimension. More...
virtual ErrCode INTERFACE_FUNC	getRule (IDimensionRule **rule)=0
	Gets the rule that defines the labels and size of the dimension. 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 ( IDimension **  dimension )

pure virtual

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

Parameters

[out]

dimension

The built Dimension.

getName()

virtual ErrCode INTERFACE_FUNC getName ( IString **  name )

pure virtual

Gets the name of the dimension.

Parameters

[out]

name

The name of the dimension.

getRule()

virtual ErrCode INTERFACE_FUNC getRule ( IDimensionRule **  rule )

pure virtual

Gets the rule that defines the labels and size of the dimension.

Parameters

[out]

rule

The dimension rule.

getUnit()

virtual ErrCode INTERFACE_FUNC getUnit ( IUnit **  unit )

pure virtual

Gets the unit of the dimension's labels.

Parameters

[out]

unit

The unit of the dimension.

setName()

virtual ErrCode INTERFACE_FUNC setName ( IString *  name )

pure virtual

Sets the name of the dimension.

Parameters

name	The name of the dimension.

The name that best describes the dimension, in example "Frequency" for spectrum data.

setRule()

virtual ErrCode INTERFACE_FUNC setRule ( IDimensionRule *  rule )

pure virtual

Sets the rule that defines the labels and size of the dimension.

Parameters

rule	The dimension rule.

Return values

OPENDAQ_ERR_FROZEN

if the dimension object is frozen.

The rule takes as input the index of data value in a sample and produces a label associated with that index.

setUnit()

virtual ErrCode INTERFACE_FUNC setUnit ( IUnit *  unit )

pure virtual

Sets the unit of the dimension's labels.

Parameters

unit	The unit of the dimension.