Factories

Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, LinearDimensionRule, IDimensionRule, INumber *, delta, INumber *, start, SizeT, size) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Rule with a Linear rule type configuration. More...
IList list	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, LogarithmicDimensionRule, IDimensionRule, INumber *, delta, INumber *, start, INumber *, base, SizeT, size) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Rule with a Logarithmic rule type configuration. More...
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DimensionRuleBuilder, IDimensionRuleBuilder) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a DataRuleConfig with no parameters. More...
DimensionRulePtr	LinearDimensionRule (const NumberPtr &delta, const NumberPtr &start, const SizeT &size)
	Creates a Rule with a Linear rule type configuration. More...
DimensionRulePtr	ListDimensionRule (const ListPtr< INumber > &list)
	Creates a Rule with a List rule type configuration. More...
DimensionRulePtr	LogarithmicDimensionRule (const NumberPtr &delta, const NumberPtr &start, const NumberPtr &base, const SizeT &size)
	Creates a Rule with a Logarithmic rule type configuration. More...
DimensionRulePtr	DimensionRule (DimensionRuleType type, const DictPtr< IString, IBaseObject > parameters)
	Creates a Rule with a given type and parameters. More...
DimensionRuleBuilderPtr	DimensionRuleBuilder ()
	Creates a Data rule builder with no parameters.
DimensionRuleBuilderPtr	DimensionRuleBuilderCopy (const DimensionRulePtr &rule)
	Dimension rule copy factory that creates a builder Rule object from a possibly non-configurable Rule. More...
StructTypePtr	DimensionRuleStructType ()
	Creates the Struct type object that defines the Dimension rule struct.
DimensionRulePtr	DimensionRuleFromBuilder (const DimensionRuleBuilderPtr &builder)
	Creates a DimensionRule using Builder. More...

Function Documentation

DimensionRule()

DimensionRulePtr DimensionRule ( DimensionRuleType  type, const DictPtr< IString, IBaseObject >  parameters  )

inline

Creates a Rule with a given type and parameters.

Parameters

type	The type of the Dimension rule
parameters	Tha parameters of the Dimension rule

DimensionRuleBuilderCopy()

DimensionRuleBuilderPtr DimensionRuleBuilderCopy ( const DimensionRulePtr &  rule )

inline

Dimension rule copy factory that creates a builder Rule object from a possibly non-configurable Rule.

Parameters

ruleToCopy

The rule of which configuration should be copied.

DimensionRuleFromBuilder()

DimensionRulePtr DimensionRuleFromBuilder ( const DimensionRuleBuilderPtr &  builder )

inline

Creates a DimensionRule using Builder.

Parameters

builder

DimensionRule Builder

LinearDimensionRule()

DimensionRulePtr LinearDimensionRule ( const NumberPtr &  delta, const NumberPtr &  start, const SizeT &  size  )

inline

Creates a Rule with a Linear rule type configuration.

Parameters

delta	Coefficient by which the input data is to be multiplied.
start	Constant that is added to the scale * value multiplication result.
size	The size of the dimension described by the rule

The scale and offset are stored within the parameters member of the Rule object with the scale being at the first position of the list, and the offset at the second.

ListDimensionRule()

DimensionRulePtr ListDimensionRule ( const ListPtr< INumber > &  list )

inline

Creates a Rule with a List rule type configuration.

Parameters

list	The list of dimension labels.

The list is stored within the parameters member of the Rule object.

LogarithmicDimensionRule()

DimensionRulePtr LogarithmicDimensionRule ( const NumberPtr &  delta, const NumberPtr &  start, const NumberPtr &  base, const SizeT &  size  )

inline

Creates a Rule with a Logarithmic rule type configuration.

Parameters

delta	Coefficient by which the input data is to be multiplied.
start	Constant that is added to the scale * value multiplication result.
base	The base of the logarithm.
size	The size of the dimension described by the rule.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/3]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		DimensionRuleBuilder	,
		IDimensionRuleBuilder
	)

Creates a DataRuleConfig with no parameters.

Dimension rule copy factory that creates a builder Rule object from a possibly non-configurable Rule.

Parameters

ruleToCopy

The rule of which configuration should be copied.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/3]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		LinearDimensionRule	,
		IDimensionRule	,
		INumber *	,
		delta	,
		INumber *	,
		start	,
		SizeT	,
		size
	)

Creates a Rule with a Linear rule type configuration.

Parameters

delta	Coefficient by which the input data is to be multiplied.
start	Constant that is added to the scale * value multiplication result.
size	The size of the dimension described by the rule

The scale and offset are stored within the parameters member of the Rule object with the scale being at the first position of the list, and the offset at the second.

Creates a Rule with a List rule type configuration.

Parameters

list	The list of dimension labels.

The list is stored within the parameters member of the Rule object.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/3]

IList list OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		LogarithmicDimensionRule	,
		IDimensionRule	,
		INumber *	,
		delta	,
		INumber *	,
		start	,
		INumber *	,
		base	,
		SizeT	,
		size
	)

Creates a Rule with a Logarithmic rule type configuration.

Parameters

delta	Coefficient by which the input data is to be multiplied.
start	Constant that is added to the scale * value multiplication result.
base	The base of the logarithm.
size	The size of the dimension described by the rule.

Creates a Rule with a given type and parameters.

Parameters

type	The type of the Dimension rule
parameters	Tha parameters of the Dimension rule