INOS
CINOSTaskExMsgUser Class Reference
Inheritance diagram for CINOSTaskExMsgUser:

Public Member Functions

 CINOSTaskExMsgUser (uint32 auMsgCode, uint32 auFlags=0)
 constructor
 
 DECLARE_DYNAMIC (CINOSTaskExMsgUser)
 dynamic object handling
 
- Public Member Functions inherited from CINOSTaskExMsg
 CINOSTaskExMsg (uint32 auMsgType, uintptr auMsgCode, CINOSSync *apSync=DF_INOS_ASYNCHRONOUS)
 constructor
 
 CINOSTaskExMsg (uint32 auMsgType, const char *apMsgName, uintptr auMsgCode=0)
 constructor
 
 CINOSTaskExMsg (const CINOSTaskExMsg &aMsg)
 constructor
 
 ~CINOSTaskExMsg ()
 destructor
 
void FstParam ()
 reset internal pointer to first param
 
void LstParam ()
 reset internal pointer to the last param
 
template<class T >
CINOSTaskExMsgParamAddParam (T)
 add param
 
template<class T >
CINOSTaskExMsgParamAddParam (const char *apName, T)
 add named param
 
template<class T >
CINOSTaskExMsgDefaultParamAddDefaultParam (const char *apName, T aValue)
 add default param
 
CINOSTaskExMsgParamAddParam (const char *apName, char *apValue)
 add named 'char*' param
 
CINOSTaskExMsgParamAddParam (const char *apName, const char *apValue)
 add named 'const char*' param
 
CINOSTaskExMsgParamAddParam (CINOSTaskExMsgParam *apParam)
 add copy of param
 
CINOSTaskExMsgParamAddJsonParam (const char *apJson)
 add params form JSON string
 
template<class T >
T GetParam ()
 get param
 
template<class T >
T GetFirstParam ()
 get first param
 
charGetParam ()
 get param
 
CINOSTaskExMsgParamGetParamPtr ()
 
charGetFirstParam ()
 get first param
 
CINOSTaskExMsgParamGetFirstParamPtr (bool abUseInternalIterator=true)
 
uint32 GetParamCnt () const
 get number of param's
 
void FstResult ()
 reset internal pointer to first result
 
template<class T >
void AddResult (T, const char *apResultName=NULL)
 
void AddResult (char *apValue, const char *apResultName=NULL)
 
void AddResult (const char *apValue, const char *apResultName=NULL)
 
template<class T >
void InsertResult (T, const char *apResultName=NULL)
 
void InsertResult (char *apValue, const char *apResultName=NULL)
 
void InsertResult (const char *apValue, const char *apResultName=NULL)
 
template<class T >
void AppendResult (T, const char *apResultName=NULL)
 
void AppendResult (char *apValue, const char *apResultName=NULL)
 
void AppendResult (const char *apValue, const char *apResultName=NULL)
 
tMcAppError AddIncoItemAsResult (CINCOItem *apItem, bool abBitAsNumber=false)
 add the value of an INCO item as result
 
void MoveResultsFromMcResult (CMcResult &aResult)
 
void MoveResultsToParams (CINOSTaskExMsg &aMsg)
 
void MoveParamsFromMsg (CINOSTaskExMsg *apMsg)
 Moves all params of apMsg to this message.
 
void AddResultsFromMsgParams (CINOSTaskExMsg *apMsg)
 Removes all params of apMsgParam and adds them to the results of this message.
 
void AddResults (CINOSTaskExMsgParam *apMsgParam)
 
template<class T >
T GetResult ()
 get result
 
charGetResult ()
 get string result
 
uint32 GetResultCount () const
 Get the count of results.
 
CINOSTaskExMsgParamGetFirstResultPtr ()
 Get pointer to iterate over results.
 
void DestroyParams ()
 destroys all params
 
void DestroyResults ()
 destroys all result params
 
void SetTrigger (real64 arValue)
 set message trigger [ms]
 
void SetTrigger (uint64 auBusTicks, uint8 auBusId)
 set message trigger []
 
void SetTrigger (const char *apVarName, const char *apCompare, real64 arValue)
 set message trigger (e.g. variable == value)
 
void SetTrigger (const char *apVarName, const char *apCompare, const char *apValue)
 set message trigger (e.g. variable == value)
 
void SetTrigger (const char *apSynName, real64 arParamValue, const char *apParamType, const char *apTaskName, const char *apCmdName, const char *apEventName)
 set message trigger
 
void SetTrigger (const char *apSynName, const char *apParamValue, const char *apParamType, const char *apTaskName, const char *apCmdName, const char *apEventName)
 set message trigger
 
void SetTrigger (const char *apSynName, real64 arParamValue, const char *apParamType, uint64 auBusTicks, uint8 auBusId)
 set message trigger
 
CINOSTaskExMsgTriggerGetTrigger ()
 get message trigger
 
void RemTrigger ()
 remove trigger from message
 
void AndTrigger (const char *apSynName, real64 arParamValue, const char *apParamType, const char *apTaskName, const char *apCmdName, const char *apEventName)
 add 'and' message trigger
 
void AndTrigger (const char *apSynName, real64 arParamValue, const char *apParamType, uint64 auBusTicks, uint8 auBusId)
 add 'and' message trigger
 
CINOSTaskExMsgTriggerGetAndTrigger (uint32 auIndex=0)
 get 'and' message trigger
 
void RemAndTrigger (uint32 auIndex=0, bool abDelete=true)
 remove 'and' message trigger
 
void SetSender (CINOSTask *apSender)
 set pointer to sender
 
void SetUser (void *apUser)
 set pointer to user data
 
void SetData (CINOSMcDataInst *apData)
 set pointer to data
 
void SetSync (CINOSSync *apSync)
 set pointer to sync object
 
void SetId (tMsgId aId)
 set message id
 
tMsgId GetId () const
 get message id
 
uint32 GetMsgType () const
 get message type
 
void SetMsgCode (uintnbr auMsgCode)
 get message code
 
uintnbr GetMsgCode () const
 get message code
 
void SetMsgSubCode (uint32 auMsgSubCode)
 get message code
 
uint32 GetMsgSubCode () const
 get message code
 
CINOSTaskExCmdBaseGetCommand () const
 
void SetRetValue (uint32 auRetValue)
 set return value. !!!OBSOLETE!!! Will be removed soon
 
uint32 GetRetValue () const
 get return value. !!!OBSOLETE!!! Will be removed soon
 
CINOSTaskGetSender () const
 get pointer to sender
 
uint32 GetSenderId () const
 
CINOSTaskExGetReceiver () const
 get pointer to receiver task
 
uint32 GetReceiverId () const
 
voidGetUser () const
 get pointer to user data
 
CINOSMcDataInstGetData () const
 get pointer to material
 
CINOSSyncGetSync () const
 get pointer to sync object
 
uint32 GetFlags ()
 get flags
 
void SetFlags (uint32 auFlags)
 set flags
 
void AddFlags (uint32 auFlags)
 add flags
 
void SetDeferred ()
 get deferred flag
 
bool GetDeferred () const
 get deferred flag
 
bool GetDone () const
 get touched flag
 
bool GetPending () const
 get pending flag
 
void SetPending ()
 set pending flag
 
bool GetCanceled () const
 get canceled flag
 
void SetCanceled ()
 set canceled flag
 
void SetPersistent ()
 set persistent flag
 
bool GetPersistent () const
 get persistent flag
 
void SetFlushResistent ()
 set flush resistant flag
 
bool GetFlushResistent () const
 get flush resistent flag
 
bool GetSingle () const
 get single flag
 
void SetSingle ()
 set single flag
 
bool GetNoTrace () const
 Get notrace flag.
 
void SetNoTrace ()
 Set notrace flag.
 
bool GetStatic () const
 Get notrace flag.
 
void SetStatic ()
 Set static flag.
 
void ClearStatic ()
 Clear static flag.
 
bool GetAlwaysSyncSignal () const
 
void SetAlwaysSyncSignal ()
 Set notrace flag.
 
bool GetAlwaysReply () const
 
void SetAlwaysReply ()
 Set notrace flag.
 
void SetName (const char *apName)
 set name
 
charGetName (bool abResolveIfEmpty=false)
 
void SetInfo (const char *apInfo)
 set info
 
charGetInfo ()
 get info
 
void SetBusTicks (uint64 auBusTicks)
 set busticks
 
uint64 GetBusTicks () const
 get busticks
 
uint64 GetQueueTicks () const
 get QueueTicks
 
void SetBusId (uint8 auBusId)
 set busid
 
uint8 GetBusId () const
 get busid
 
void SetIdInfo (tMsgId auIdInfo)
 set id info
 
tMsgId GetIdInfo () const
 get id info
 
CINOSTaskExMsgParamGetParam (const char *apName)
 get name
 
void DontCreateMcLogTraces ()
 
bool AreMcLogTracesRequested () const
 
bool InINCOVContext () const
 
int operator< (CINOSTaskExMsg &aTaskExMsg)
 binary tree operators
 
int operator== (CINOSTaskExMsg &aTaskExMsg)
 
int operator< (const char *aName)
 
int operator== (const char *aName)
 
CINOSTaskExMsgParamiAddParam (CINOSTaskExMsgParam *apParam)
 internal addparam
 
template<>
const charGetParam ()
 get param
 
template<>
charGetParam ()
 

Additional Inherited Members

- Public Types inherited from CINOSTaskExMsg
enum  EMsgFlag {
  eMsgFlgNone = 0x00000000 , eMsgFlgSyncron = 0x00000001 , eMsgFlgDeferred = 0x00000002 , eMsgFlgPending = 0x00000004 ,
  eMsgFlgCanceled = 0x00000008 , eMsgFlgPersistent = 0x00000010 , eMsgFlgFlushResistent = 0x00000020 , eMsgFlgHasEllipsis = 0x00000040 ,
  eMsgFlgSingle = 0x00000080 , eMsgFlgNoTrace = 0x00000100 , eMsgFlgStatic = 0x00000200 , eMsgFlgOversizedResult = 0x00000400 ,
  eMsgFlgAlwaysSyncSignal = 0x00000800 , eMsgFlgAlwaysReply = 0x00001000 , eMsgFlgDone = 0x80000000
}
 
- Public Attributes inherited from CINOSTaskExMsg
 INOS_CONCURRENCY_CHECK_DECLARE
 

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