openDAQ
Open data acquisition platform
+ Collaboration diagram for Factories:

Detailed Description

Functions

 OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, Dimension, IDimension, IDimensionRule *, rule, IUnit *, unit, IString *, name) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
 Creates a dimension object of which labels and size are defined via rule. More...
 
 OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DimensionBuilder, IDimensionBuilder) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
 Creates a Dimension builder object with no configuration parameters. More...
 
DimensionBuilderPtr DimensionBuilder ()
 Creates a Dimension Config object with no configuration parameters.
 
DimensionPtr Dimension (const DimensionRulePtr &rule, const UnitPtr &unit=nullptr, const StringPtr &name="")
 Creates a dimension object of which labels and size are defined via rule. More...
 
DimensionPtr DimensionFromBuilder (const DimensionBuilderPtr &builder)
 Creates a Dimension using Builder. More...
 
DimensionBuilderPtr DimensionBuilderCopy (const DimensionPtr &dimension)
 Creates a builder copy of the dimension object passed as parameter. More...
 
StructTypePtr DimensionStructType ()
 Creates the Struct type object that defines the Dimension struct.
 

Function Documentation

◆ Dimension()

DimensionPtr Dimension ( const DimensionRulePtr rule,
const UnitPtr unit = nullptr,
const StringPtr name = "" 
)
inline

Creates a dimension object of which labels and size are defined via rule.

Parameters
ruleThe rule via which labels are defined.
unitThe unit of the dimension's labels.
nameThe name the dimension.

◆ DimensionBuilderCopy()

DimensionBuilderPtr DimensionBuilderCopy ( const DimensionPtr dimension)
inline

Creates a builder copy of the dimension object passed as parameter.

Parameters
dimensionThe dimension object to be copied.

◆ DimensionFromBuilder()

DimensionPtr DimensionFromBuilder ( const DimensionBuilderPtr builder)
inline

Creates a Dimension using Builder.

Parameters
builderDimension Builder

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE ( LIBRARY_FACTORY  ,
Dimension  ,
IDimension  ,
IDimensionRule ,
rule  ,
IUnit ,
unit  ,
IString ,
name   
)

Creates a dimension object of which labels and size are defined via rule.

Parameters
ruleThe rule via which labels are defined.
unitThe unit of the dimension's labels.
nameThe name the dimension.

Creates a Dimension using Builder

Parameters
builderDimension Builder

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE ( LIBRARY_FACTORY  ,
DimensionBuilder  ,
IDimensionBuilder   
)

Creates a Dimension builder object with no configuration parameters.

Creates a builder copy of the dimension object passed as parameter.

Parameters
dimensionToCopyThe dimension object to be copied.