IScalingBuilder Struct Reference

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

Inheritance diagram for IScalingBuilder:

Collaboration diagram for IScalingBuilder:

Detailed Description

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

Public Member Functions
virtual ErrCode INTERFACE_FUNC	build (IScaling **scaling)=0
	Builds and returns a Scaling object using the currently set values of the Builder. More...
virtual ErrCode INTERFACE_FUNC	setInputDataType (SampleType type)=0
	Sets the scaling's input data type. More...
virtual ErrCode INTERFACE_FUNC	getInputDataType (SampleType *type)=0
	Gets the scaling's input data type. More...
virtual ErrCode INTERFACE_FUNC	setOutputDataType (ScaledSampleType type)=0
	Sets the scaling's output data type. More...
virtual ErrCode INTERFACE_FUNC	getOutputDataType (ScaledSampleType *type)=0
	Gets the scaling's output data type. More...
virtual ErrCode INTERFACE_FUNC	setScalingType (ScalingType type)=0
	Sets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated. More...
virtual ErrCode INTERFACE_FUNC	getScalingType (ScalingType *type)=0
	Gets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated. More...
virtual ErrCode INTERFACE_FUNC	setParameters (IDict *parameters)=0
	Gets the list of parameters that are used to calculate the scaling in conjunction with the input data. More...
virtual ErrCode INTERFACE_FUNC	getParameters (IDict **parameters)=0
	Gets the list of parameters that are used to calculate the scaling in conjunction with the input data. More...
virtual ErrCode INTERFACE_FUNC	addParameter (IString *name, IBaseObject *parameter)=0
	Adds a string-object pair parameter to the Dictionary of Scaling parameters. More...
virtual ErrCode INTERFACE_FUNC	removeParameter (IString *name)=0
	Removes the parameter with the given name from the Dictionary of Scaling parameters.
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

addParameter()

virtual ErrCode INTERFACE_FUNC addParameter ( IString *  name, IBaseObject *  parameter  )

pure virtual

Adds a string-object pair parameter to the Dictionary of Scaling parameters.

Parameters

name	The string-type name of the parameter.
parameter	The object-type parameter.

build()

virtual ErrCode INTERFACE_FUNC build ( IScaling **  scaling )

pure virtual

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

Parameters

[out]

scaling

The built Scaling object.

getInputDataType()

virtual ErrCode INTERFACE_FUNC getInputDataType ( SampleType *  type )

pure virtual

Gets the scaling's input data type.

Parameters

[out]

type

The input data type.

getOutputDataType()

virtual ErrCode INTERFACE_FUNC getOutputDataType ( ScaledSampleType *  type )

pure virtual

Gets the scaling's output data type.

Parameters

[out]

type

The output data type

getParameters()

virtual ErrCode INTERFACE_FUNC getParameters ( IDict **  parameters )

pure virtual

Gets the list of parameters that are used to calculate the scaling in conjunction with the input data.

Parameters

[out]

parameters

The list of parameters. All elements are Number types.

getScalingType()

virtual ErrCode INTERFACE_FUNC getScalingType ( ScalingType *  type )

pure virtual

Gets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated.

Parameters

[out]

type

The type of the scaling.

setInputDataType()

virtual ErrCode INTERFACE_FUNC setInputDataType ( SampleType  type )

pure virtual

Sets the scaling's input data type.

Parameters

type	The input data type.

The input data type corresponds to the raw data passed through the signal path in data packets.

setOutputDataType()

virtual ErrCode INTERFACE_FUNC setOutputDataType ( ScaledSampleType  type )

pure virtual

Sets the scaling's output data type.

Parameters

type	The output data type

The output data type corresponds to the type specified in the value descriptor of a signal, and is the type in which said signal's data should be read in after having the scaling applied to it.

setParameters()

virtual ErrCode INTERFACE_FUNC setParameters ( IDict *  parameters )

pure virtual

Gets the list of parameters that are used to calculate the scaling in conjunction with the input data.

Parameters

parameters

The list of parameters. All elements are Number types.

Return values

OPENDAQ_ERR_FROZEN

if the object is frozen.

setScalingType()

virtual ErrCode INTERFACE_FUNC setScalingType ( ScalingType  type )

pure virtual

Sets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated.

Parameters

type	The type of the scaling.