Dawn Framework 1.0
Universal data acquisition framework for embedded systems
Static Public Member Functions | List of all members
dawn::CIOCommon::IOObjectIdHelper< CLASS_ID, DEFAULT_DTYPE > Class Template Reference

Template helper for creating ObjectIDs for I/O types. More...

#include <common.hxx>

Static Public Member Functions

static SObjectId::ObjectId create (bool ts, uint16_t inst)
 Create ObjectID with default data type.
 
static SObjectId::ObjectId create (SObjectId::EObjectDataType dtype, bool ts, uint16_t inst)
 Create ObjectID with custom data type.
 

Detailed Description

template<uint16_t CLASS_ID, uint8_t DEFAULT_DTYPE>
class dawn::CIOCommon::IOObjectIdHelper< CLASS_ID, DEFAULT_DTYPE >

Template helper for creating ObjectIDs for I/O types.

Template Parameters
CLASS_IDThe I/O class identifier (e.g., IO_CLASS_ADC_FETCH)
DEFAULT_DTYPEDefault data type for this I/O

Definition at line 235 of file common.hxx.

Member Function Documentation

◆ create() [1/2]

template<uint16_t CLASS_ID, uint8_t DEFAULT_DTYPE>
static SObjectId::ObjectId dawn::CIOCommon::IOObjectIdHelper< CLASS_ID, DEFAULT_DTYPE >::create ( bool  ts,
uint16_t  inst 
)
inlinestatic

Create ObjectID with default data type.

Parameters
tsEnable timestamp support if true.
instInstance number (0 to MAX_INSTANCE-1).
Returns
ObjectID for the I/O instance.

Definition at line 246 of file common.hxx.

References dawn::CIOCommon::IO_FLAGS_TS, dawn::SObjectId::objectId(), and dawn::SObjectId::OBJTYPE_IO.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ create() [2/2]

template<uint16_t CLASS_ID, uint8_t DEFAULT_DTYPE>
static SObjectId::ObjectId dawn::CIOCommon::IOObjectIdHelper< CLASS_ID, DEFAULT_DTYPE >::create ( SObjectId::EObjectDataType  dtype,
bool  ts,
uint16_t  inst 
)
inlinestatic

Create ObjectID with custom data type.

Parameters
dtypeData type for this instance.
tsEnable timestamp support if true.
instInstance number (0 to MAX_INSTANCE-1).
Returns
ObjectID for the I/O instance.

Definition at line 271 of file common.hxx.

References dawn::CIOCommon::IO_FLAGS_TS, dawn::SObjectId::objectId(), and dawn::SObjectId::OBJTYPE_IO.

Here is the call graph for this function:

The documentation for this class was generated from the following file: