openDAQ
Open data acquisition platform
+ Collaboration diagram for Factories:

Detailed Description

Functions

 OPENDAQ_DECLARE_CLASS_FACTORY (LIBRARY_FACTORY, ArgumentInfo, IString *, name, CoreType, type)
 Creates an Argument info object with the specified name and type. More...
 
 OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, ListArgumentInfo, IArgumentInfo, IString *, name, CoreType, itemType)
 Creates a list-type Argument info object with the specified name and item type. More...
 
 OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DictArgumentInfo, IArgumentInfo, IString *, name, CoreType, keyType, CoreType, itemType)
 Creates a dict-type Argument info object with the specified name, key type and item type. More...
 
ArgumentInfoPtr ArgumentInfo (const StringPtr &name, CoreType type)
 Creates an Argument info object with the specified name and type. More...
 
ArgumentInfoPtr ListArgumentInfo (const StringPtr &name, CoreType itemType)
 Creates a list-type Argument info object with the specified name and item type. More...
 
ArgumentInfoPtr DictArgumentInfo (const StringPtr &name, CoreType keyType, CoreType itemType)
 Creates a dict-type Argument info object with the specified name, key type and item type. More...
 
StructTypePtr ArgumentInfoStructType ()
 Creates the Struct type object that defines the Argument info struct.
 

Function Documentation

◆ ArgumentInfo()

ArgumentInfoPtr ArgumentInfo ( const StringPtr name,
CoreType  type 
)
inline

Creates an Argument info object with the specified name and type.

Parameters
nameThe name of the argument.
typeThe type expected of the argument.

◆ DictArgumentInfo()

ArgumentInfoPtr DictArgumentInfo ( const StringPtr name,
CoreType  keyType,
CoreType  itemType 
)
inline

Creates a dict-type Argument info object with the specified name, key type and item type.

Parameters
nameThe name of the argument.
keyTypeCorresponds to the expected type of key in the dictionary argument.
itemTypeCorresponds to the expected type of items in the dictionary argument.

◆ ListArgumentInfo()

ArgumentInfoPtr ListArgumentInfo ( const StringPtr name,
CoreType  itemType 
)
inline

Creates a list-type Argument info object with the specified name and item type.

Parameters
nameThe name of the argument.
itemTypeCorresponds to the expected type of items in the list argument.

◆ OPENDAQ_DECLARE_CLASS_FACTORY()

OPENDAQ_DECLARE_CLASS_FACTORY ( LIBRARY_FACTORY  ,
ArgumentInfo  ,
IString ,
name  ,
CoreType  ,
type   
)

Creates an Argument info object with the specified name and type.

Parameters
nameThe name of the argument.
typeThe type expected of the argument.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE ( LIBRARY_FACTORY  ,
DictArgumentInfo  ,
IArgumentInfo  ,
IString ,
name  ,
CoreType  ,
keyType  ,
CoreType  ,
itemType   
)

Creates a dict-type Argument info object with the specified name, key type and item type.

Parameters
nameThe name of the argument.
keyTypeCorresponds to the expected type of key in the dictionary argument.
itemTypeCorresponds to the expected type of items in the dictionary argument.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/2]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE ( LIBRARY_FACTORY  ,
ListArgumentInfo  ,
IArgumentInfo  ,
IString ,
name  ,
CoreType  ,
itemType   
)

Creates a list-type Argument info object with the specified name and item type.

Parameters
nameThe name of the argument.
itemTypeCorresponds to the expected type of items in the list argument.