|
CMcResult | operator() (ParamType... Params, CINOSSync *apSync=DF_INOS_SYNCHRONOUS) |
| Calls this command (dispatched). This function creates and puts a message of this command to the task ex of the command. More...
|
|
virtual uint32 | AddCommand (bool abDeleteOnRemove=false) override |
| Adds this command to the module it belongs to. And makes it therefore callable. This function also checks if the parameter definitions match the types declared in the template parameters.
|
|
virtual uint32 | AddCommand (uint64 aChar, uint16 aKeyLevel, bool abRegisterInco=true, bool abDeleteOnRemove=false) override |
| Adds this command to the module it belongs to. And makes it therefore callable. This function also checks if the parameter definitions match the types declared in the template parameters. More...
|
|
virtual void | SetDefaults (ParamType... Default) |
|
virtual | ~TINOSTaskExCmdBaseParam () |
| Destructor.
|
|
virtual void | SetPreDispatcher (const CINOSTaskExCmdHookBase *apPreDispatchHook) |
| Sets the pre dispatch callback which is called before a message is of this command is dispatched. More...
|
|
virtual void | SetOnMsgDone (const CINOSTaskExCmdHookBase *apOnMsgDoneHook) |
| Sets the OnMsgDone callback which is called when MsgDone is called on a message of this command. More...
|
|
CINOSTaskExMsg * | CreateMsg (CINOSSync *apSync=DF_INOS_SYNCHRONOUS) |
| Create a message of this command. Can be used for manual, customized call. More...
|
|
const char * | GetOption () const |
| Returns the option string of this command. More...
|
|
const char * | GetName () |
| Returns the name of this command. More...
|
|
void | SetName (const char *apName) |
| Returns the name of this command. More...
|
|
CINOSTaskExMsg & | GetMsg () |
| Returns the message of this command. More...
|
|
void | SetTask (CINOSTaskEx *apTask) |
|
void | AddParam (const char *apName, real64 arValue, real64 arMin, real64 arMax, const char *apUnit="", uint32 auChar=0, uint32 auFlags=0) |
| Adds a real64 param description. This function may only be used if the param description has not be provided in the constructor. The funcion needs to be called in the same order as the template type definition. More...
|
|
void | AddParam (const char *apName, const char *apValue, const char *apComboData=nullptr, uint32 auFlags=0) |
| Adds a string (char*) param description. This function may only be used if the param description has not be provided in the constructor. The funcion needs to be called in the same order as the template type definition. More...
|
|
void | AddParam (const char *apName, bool abValue, uint32 auFlags=0) |
| Adds a bool param description. This function may only be used if the param description has not be provided in the constructor. The funcion needs to be called in the same order as the template type definition. More...
|
|
void | SetAllowedStates (uint32 auStateBitmap) |
| Sets the states in which this command is allowed to be called. More...
|
|
int | operator< (CINOSTaskExCmdBase &aTaskExMsg) |
| binary tree operators
|
|
int | operator== (CINOSTaskExCmdBase &aTaskExMsg) |
|
int | operator< (const char *aName) |
|
int | operator== (const char *aName) |
|
virtual | ~CINOSTaskExCmdBase () |
| Destructor.
|
|
void | Claim () |
| Claims the object of this command. This ensures that in case this command.
|
|
void | Release (CINOSTaskExMsg *apMsg=nullptr) |
| Releases the object of this command. This ensures that in case this command.
|
|
|
| TINOSTaskExCmdBaseParam (const char *apName, CINOSTaskEx *apTask, ObjectType *apObject, TINOSTaskExValDef< ParamType >... apDefaultParams, uint32 auStateBitmap, const char *apOption, uint64 auCharacteristics, uint16 auKeyLevel, bool abRegisterInco) |
| Constructor (base constructor is protected, as this class is abstract)
|
|
template<typename T > |
CINOSTaskExMsgParam * | AddParam (CINOSTaskExMsg *apMsg, T aValue) |
|
CINOSTaskExMsgParam * | AddParam (CINOSTaskExMsg *apMsg, const char *pValue) |
|
virtual void | Dispatch (CINOSTaskExMsg *apMsg)=0 |
| Dispatches a message if this command. Used by CINOSTaskEx. More...
|
|
virtual void | DispatchTmd (CINOSTaskExMsg *apMsg)=0 |
| Dispatches a timed message if this command. Used by CINOSTaskEx. More...
|
|
bool | PreDispatch (CINOSTaskExMsg *apMsg) |
| Function is called by the module (CINOSTaskEx) before the message of this command is dispatched. More...
|
|
void | OnMsgDone (CINOSTaskExMsg *apMsg, CINOSTaskExDef::ERplId aRplId, tMcAppError aAppError) |
| Function is called by the module (CINOSTaskEx) when MsgDone is called on a message of this command. More...
|
|
| CINOSTaskExCmdBase (const char *apName, CINOSTaskEx *apTask, uint32 auStateBitmap, const char *apOption, uint64 auCharacteristics, uint16 auKeyLevel, bool abRegisterInco) |
| Constructor (base constructor is protected, as this class is abstract)
|
|
bool | CheckParams (size_t count,...) |
| Checks if thie added parameters match the template definition.
|
|
virtual void | DeleteCommand () |
| Deletes the object of this command, dispatch if called from.
|
|
template<class ObjectType, typename... ParamType>
class TINOSTaskExCmdBaseParam< ObjectType, ParamType >
Abstract template base class for all TINOSTaskExCmd variants.
- Template Parameters
-
ObjectType | Type of the class this command is added to. Class must be inherited from CINOSTaskEx. |
ParamType... | List of types of the parameters of this command. |