Factories

Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, LinearScaling, IScaling, INumber *, scale, INumber *, offset, SampleType, inputDataType, ScaledSampleType, outputDataType) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Scaling with a Linear scaling type configuration. The returned Scaling object is already frozen. More...
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, ScalingBuilder, IScalingBuilder) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Scaling builder object with no parameters configured. More...
ScalingPtr	LinearScaling (const NumberPtr &scale, const NumberPtr &offset, SampleType inputDataType=SampleType::Float64, ScaledSampleType outputDataType=ScaledSampleType::Float64)
	Creates a Scaling with a Linear scaling type configuration. More...
ScalingPtr	Scaling (SampleType inputDataType, ScaledSampleType outputDataType, ScalingType scalingType, const DictPtr< IString, IBaseObject > &params)
	Creates a Scaling object with given input/output types, Scaling type and parameters. More...
ScalingPtr	ScalingFromBuilder (const ScalingBuilderPtr &builder)
	Creates a Scaling object from Builder. More...
ScalingBuilderPtr	ScalingBuilder ()
	Creates a Scaling builder object with no parameters configured.
ScalingBuilderPtr	ScalingBuilderCopy (const ScalingPtr &scaling)
	Scaling builder copy factory that creates a configurable Scaling object from a non-configurable one. More...

Function Documentation

LinearScaling()

ScalingPtr LinearScaling ( const NumberPtr &  scale, const NumberPtr &  offset, SampleType  inputDataType = SampleType::Float64, ScaledSampleType  outputDataType = ScaledSampleType::Float64  )

inline

Creates a Scaling with a Linear scaling type configuration.

Parameters

scale	Coefficient by which the input data is to be multiplied.
offset	Constant that is added to the scale * value multiplication result.
inputDataType	The scaling's input data type.
outputDataType	The scaling's output data type.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		LinearScaling	,
		IScaling	,
		INumber *	,
		scale	,
		INumber *	,
		offset	,
		SampleType	,
		inputDataType	,
		ScaledSampleType	,
		outputDataType
	)

Creates a Scaling with a Linear scaling type configuration. The returned Scaling object is already frozen.

Parameters

scale	Coefficient by which the input data is to be multiplied.
offset	Constant that is added to the scale * value multiplication result.
inputDataType	The scaling's input data type.
outputDataType	The scaling's output data type.

Creates a Scaling object with given input/output types, Scaling type and parameters.

Parameters

inputDataType	The type of input data expected by the rule.
outputDataType	The data type output by the rule after calculation.
scalingType	The type of the scaling.
parameters	Tha parameters of the Dimension rule.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		ScalingBuilder	,
		IScalingBuilder
	)

Creates a Scaling builder object with no parameters configured.

Scaling builder copy factory that creates a configurable Scaling object from a non-configurable one.

Parameters

scalingToCopy

The scaling of which configuration should be copied.

Scaling()

ScalingPtr Scaling ( SampleType  inputDataType, ScaledSampleType  outputDataType, ScalingType  scalingType, const DictPtr< IString, IBaseObject > &  params  )

inline

Creates a Scaling object with given input/output types, Scaling type and parameters.

Parameters

type	The type of the Dimension rule.
parameters	Tha parameters of the Dimension rule.
outputDataType	The data type output by the rule after calculation.
inputDataType	The type of input data expected by the rule.

ScalingBuilderCopy()

ScalingBuilderPtr ScalingBuilderCopy ( const ScalingPtr &  scaling )

inline

Scaling builder copy factory that creates a configurable Scaling object from a non-configurable one.

Parameters

scaling

The scaling of which configuration should be copied.

ScalingFromBuilder()

ScalingPtr ScalingFromBuilder ( const ScalingBuilderPtr &  builder )

inline

Creates a Scaling object from Builder.

Parameters

builder

Scaling Builder