INOS
Public Member Functions | List of all members
TINOSTaskExValDef< T > Class Template Reference

#include <cinostaskextmpl.h>

Public Member Functions

 TINOSTaskExValDef (const char *Name, T Value, T Min, T Max, const char *Unit="", uint32 Characteristics=0, uint32 Flags=0)
 Creates a parameter definition object used by TINOSTaskExCmd templates. More...
 
 TINOSTaskExValDef (const char *Name, const char *ComboData, T Value, T Min, T Max, const char *Unit="", uint32 Characteristics=0, uint32 Flags=0)
 Creates a parameter definition object with combo data used by TINOSTaskExCmd templates. More...
 
CINOSTaskExMsgDefaultParam * AddToMsg (CINOSTaskExMsg &aMsg)
 Adds a CINOSTaskExMsgDefaultParam that represent this definition to given message. Used by TINOSTaskExCmd. More...
 

Detailed Description

template<typename T>
class TINOSTaskExValDef< T >

Value definition template that provides an interface to define parameters for commands of type TINOSTaskExCmd.

Constructor & Destructor Documentation

◆ TINOSTaskExValDef() [1/2]

template<typename T >
TINOSTaskExValDef< T >::TINOSTaskExValDef ( const char *  Name,
T  Value,
T  Min,
T  Max,
const char *  Unit = "",
uint32  Characteristics = 0,
uint32  Flags = 0 
)
inline

Creates a parameter definition object used by TINOSTaskExCmd templates.

Parameters
Nameconst char* name of the parameter
ValueT initial default value of the parameter
MinT minimal value of the parameter
MaxT maximal value of the parameter
Unitconst char* unit of the parameter
Characteristicsuint32 characteristics of the INCO item of the parameter
Flagsuint32 flags of the INCO item of the parameter

◆ TINOSTaskExValDef() [2/2]

template<typename T >
TINOSTaskExValDef< T >::TINOSTaskExValDef ( const char *  Name,
const char *  ComboData,
T  Value,
T  Min,
T  Max,
const char *  Unit = "",
uint32  Characteristics = 0,
uint32  Flags = 0 
)
inline

Creates a parameter definition object with combo data used by TINOSTaskExCmd templates.

Parameters
Nameconst char* name of the parameter
ComboDataconst char* combo data of the parameter
ValueT initial default value of the parameter
MinT minimal value of the parameter
MaxT maximal value of the parameter
Unitconst char* unit of the parameter
Characteristicsuint32 characteristics of the INCO item of the parameter
Flagsuint32 flags of the INCO item of the parameter

Member Function Documentation

◆ AddToMsg()

template<typename T >
CINOSTaskExMsgDefaultParam* TINOSTaskExValDef< T >::AddToMsg ( CINOSTaskExMsg &  aMsg)
inline

Adds a CINOSTaskExMsgDefaultParam that represent this definition to given message. Used by TINOSTaskExCmd.

Parameters
aMsgCINOSTaskExMsg& message where the param is added to.
The documentation for this class was generated from the following file: