Factories

Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, LinearDataRule, IDataRule, INumber *, delta, INumber *, start) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a DataRule with a Linear rule type configuration. More...
IDataRule	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, ExplicitDataRule, IDataRule, OPENDAQ_FACTORY_PARAMS()) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a DataRule with an Explicit rule type configuration and no parameters. More...
IDataRule INumber INumber maxExpectedDelta	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DataRule, IDataRule, DataRuleType, ruleType, IDict *, parameters) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a DataRule with an Explicit rule type configuration and parameters. More...
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DataRuleBuilder, IDataRuleBuilder) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Data rule builder with no parameters. More...
DataRulePtr	DataRule (DataRuleType type, const DictPtr< IString, IBaseObject > &parameters)
	Creates a DataRuleConfig with no parameters.
DataRulePtr	DataRuleFromBuilder (const DataRuleBuilderPtr &builder)
	Creates a DataRulePtr from Builder. More...
DataRulePtr	LinearDataRule (const NumberPtr &delta, const NumberPtr &start)
	Creates a DataRule with a Linear rule type configuration. More...
DataRulePtr	ExplicitDataRule ()
	Creates a DataRule with an Explicit rule type configuration and no parameters.
DataRulePtr	ExplicitDomainDataRule (const NumberPtr &minExpectedDelta=0, const NumberPtr &maxExpectedDelta=0)
	Creates a DataRule with an Explicit rule type configuration two optional parameters. More...
DataRuleBuilderPtr	DataRuleBuilder ()
	Creates a Data rule builder with no parameters.
DataRuleBuilderPtr	DataRuleBuilderCopy (const DataRulePtr &rule)
	Dat rule copy factory that creates a Data rule builder object from a non-configurable Data rule. More...
StructTypePtr	DataRuleStructType ()
	Creates the Struct type object that defines the Data rule struct.

Variables
	ConstantDataRule ()
	Creates a DataRule with a Constant rule type configuration.

Function Documentation

DataRuleBuilderCopy()

DataRuleBuilderPtr DataRuleBuilderCopy ( const DataRulePtr &  rule )

inline

Dat rule copy factory that creates a Data rule builder object from a non-configurable Data rule.

Parameters

rule	The rule of which configuration should be copied.

DataRuleFromBuilder()

DataRulePtr DataRuleFromBuilder ( const DataRuleBuilderPtr &  builder )

inline

Creates a DataRulePtr from Builder.

Parameters

builder

DataRule Builder

ExplicitDomainDataRule()

DataRulePtr ExplicitDomainDataRule ( const NumberPtr &  minExpectedDelta = 0, const NumberPtr &  maxExpectedDelta = 0  )

inline

Creates a DataRule with an Explicit rule type configuration two optional parameters.

Parameters

minExpectedDelta	The lowest expected distance between two samples.
maxExpectedDelta	The highest expected distance between two samples.

Most often used for domain signals to specify estimates on how close together/far apart two subsequent samples might be.

LinearDataRule()

DataRulePtr LinearDataRule ( const NumberPtr &  delta, const NumberPtr &  start  )

inline

Creates a DataRule 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.

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.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/4]

IDataRule INumber INumber maxExpectedDelta OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		DataRule	,
		IDataRule	,
		DataRuleType	,
		ruleType	,
		IDict *	,
		parameters
	)

Creates a DataRule with an Explicit rule type configuration and parameters.

Parameters

ruleType	.
parameters	.

Creates a DataRulePtr from Builder.

Parameters

builder

DataRule Builder

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/4]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		DataRuleBuilder	,
		IDataRuleBuilder
	)

Creates a Data rule builder with no parameters.

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

Parameters

ruleToCopy

The rule of which configuration should be copied.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/4]

IDataRule OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		ExplicitDataRule	,
		IDataRule	,
		OPENDAQ_FACTORY_PARAMS()
	)

Creates a DataRule with an Explicit rule type configuration and no parameters.

Creates a DataRule with an Explicit rule type configuration two optional parameters.

Parameters

minExpectedDelta	The lowest expected distance between two samples.
maxExpectedDelta	The highest expected distance between two samples.

Most often used for domain signals to specify estimates on how close together/far apart two subsequent samples might be.

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/4]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		LinearDataRule	,
		IDataRule	,
		INumber *	,
		delta	,
		INumber *	,
		start
	)

Creates a DataRule 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.

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 DataRule with a Constant rule type configuration.