RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Traces of state machine

Macros for tracing the state machine execution. More...

Macros

#define RKH_TR_SM_INIT(actObj_, initState_)
 Inits a previously created state machine calling its initializing action. More...
 
#define RKH_TR_SM_CLRH(actObj_, history_)
 Erase the history of a state. It can be a shallow or deep history. More...
 
#define RKH_TR_SM_DCH(actObj_, evt_, state_)
 Executes a state machine in a run-to-completation (RTC) model. More...
 
#define RKH_TR_SM_TRN(actObj_, sourceState_, targetState_)
 Source and target state of the transition. The target could be either basic state, composite state or pseudostate. More...
 
#define RKH_TR_SM_STATE(actObj_, state_)
 Legal, stable and final state of transition. More...
 
#define RKH_TR_SM_ENSTATE(actObj_, state_)
 Entered state. More...
 
#define RKH_TR_SM_EXSTATE(actObj_, state_)
 Exited state. More...
 
#define RKH_TR_SM_NENEX(actObj_, nEnState_, nExState_)
 Number of entry and exit states in transition. More...
 
#define RKH_TR_SM_NTRNACT(actObj_, nta, nts)
 Number of executed actions and segments of the transition. More...
 
#define RKH_TR_SM_TS_STATE(actObj_, state_)
 Destination state or pseudostate of a transition segment. More...
 
#define RKH_TR_SM_EVT_PROC(actObj_)
 The arrived event was succesfully processed and HSM resides in an allowed state. More...
 
#define RKH_TR_SM_EVT_NFOUND(actObj_, evt_)
 The arrived event was't founded in the transition table. More...
 
#define RKH_TR_SM_GRD_FALSE(actObj_)
 The transition was cancelled by guard function. More...
 
#define RKH_TR_SM_CND_NFOUND(actObj_)
 The branch function returned a value not founded in the branch table. More...
 
#define RKH_TR_SM_UNKN_STATE(actObj_)
 Unknown state. More...
 
#define RKH_TR_SM_EX_HLEVEL(actObj_)
 The transition exceeded the allowed hierarchical level. More...
 
#define RKH_TR_SM_EX_TSEG(actObj_)
 The transition exceeded the allowed number of segments within a compound transtion. More...
 
#define RKH_TR_SM_EXE_ACT(actionType_, actObj_, state_, action_)
 Executes a behavior (action) of state machine, it could be an entry, exit, effect, init, preprocessor or guard. More...
 

Detailed Description

Macros for tracing the state machine execution.

Macro Definition Documentation

#define RKH_TR_SM_INIT (   actObj_,
  initState_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_INIT, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(initState_); \
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TE_SM_INIT
Inits a previously created state machine calling its initializing action.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Inits a previously created state machine calling its initializing action.

Description
Initialize a state machine
Group
RKH_TG_SM
EventID
RKH_TE_SM_INIT
Parameters
[in]actObj_Active object
[in]initState_Initial state of state machine

Definition at line 544 of file rkhtrc_record.h.

#define RKH_TR_SM_CLRH (   actObj_,
  history_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_CLRH, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(history_); \
#define RKH_TE_SM_CLRH
Erase the history of a state. It can be a shallow or deep history.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Erase the history of a state. It can be a shallow or deep history.

Desc = clear history pseudostate
Group = RKH_TG_SM
Id = RKH_TE_SM_CLRH
Args = actObj_, history pseudostate

Description
Clear a history pseudostate
Group
RKH_TG_SM
EventID
RKH_TE_SM_CLRH
Parameters
[in]actObj_Active object
[in]history_History pseudostate

Definition at line 571 of file rkhtrc_record.h.

#define RKH_TR_SM_DCH (   actObj_,
  evt_,
  state_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio), \
(evt_)->e) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_SYM(state_); \
#define RKH_TRC_BEGIN(eid_, prio_, sig_)
#define RKH_TRC_SIG(e)
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TE_SM_DCH
Executes a state machine in a run-to-completation (RTC) model.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Executes a state machine in a run-to-completation (RTC) model.

Description
Dispatch an event to a state machine
Group
RKH_TG_SM
EventID
RKH_TE_SM_DCH
Parameters
[in]actObj_Active object
[in]evt_Dispatched event
[in]state_Current state

Definition at line 594 of file rkhtrc_record.h.

#define RKH_TR_SM_TRN (   actObj_,
  sourceState_,
  targetState_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_TRN, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(sourceState_); \
RKH_TRC_SYM(targetState_); \
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96
#define RKH_TE_SM_TRN
Source and target state of the transition. The target could be either basic state, composite state or pseudostate.

Source and target state of the transition. The target could be either basic state, composite state or pseudostate.

Description
Source and target state of transition
Group
RKH_TG_SM
EventID
RKH_TE_SM_TRN
Parameters
[in]actObj_Active object
[in]sourceState_Source state
[in]targetState_Target state

Definition at line 620 of file rkhtrc_record.h.

#define RKH_TR_SM_STATE (   actObj_,
  state_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_STATE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(state_); \
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TE_SM_STATE
Legal, stable and final state of transition.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Legal, stable and final state of transition.

Description
Main target state of transition
Group
RKH_TG_SM
EventID
RKH_TE_SM_STATE
Parameters
[in]actObj_Active object
[in]state_Target state of transition

Definition at line 643 of file rkhtrc_record.h.

#define RKH_TR_SM_ENSTATE (   actObj_,
  state_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_ENSTATE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(state_); \
#define RKH_TE_SM_ENSTATE
Entered state.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Entered state.

Description
Entry state
Group
RKH_TG_SM
EventID
RKH_TE_SM_ENSTATE
Parameters
[in]actObj_Active object
[in]state_Entry state

Definition at line 665 of file rkhtrc_record.h.

#define RKH_TR_SM_EXSTATE (   actObj_,
  state_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_EXSTATE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(state_); \
#define RKH_TE_SM_EXSTATE
Exited state.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Exited state.

Description
Exit state
Group
RKH_TG_SM
EventID
RKH_TE_SM_EXSTATE
Parameters
[in]actObj_Active object
[in]state_Exit state

Definition at line 687 of file rkhtrc_record.h.

#define RKH_TR_SM_NENEX (   actObj_,
  nEnState_,
  nExState_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_NENEX, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(nEnState_); \
RKH_TRC_UI8(nExState_); \
#define RKH_TE_SM_NENEX
Number of entry and exit states in transition.
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Number of entry and exit states in transition.

Description
Number of entry and exit states in transition
Group
RKH_TG_SM
EventID
RKH_TE_SM_NENEX
Parameters
[in]actObj_Active object
[in]nEnState_Number of entry states
[in]nExState_Number of exit states

Definition at line 710 of file rkhtrc_record.h.

#define RKH_TR_SM_NTRNACT (   actObj_,
  nta,
  nts 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_NTRNACT, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
#define RKH_TE_SM_NTRNACT
Number of executed actions and segments of the transition.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Number of executed actions and segments of the transition.

Description
Number of executed actions in transition
Group
RKH_TG_SM
EventID
RKH_TE_SM_NTRNACT
Parameters
[in]actObj_Active object
[in]ntaNumber of executed effect action
[in]ntsNumber of transition segments

Definition at line 735 of file rkhtrc_record.h.

#define RKH_TR_SM_TS_STATE (   actObj_,
  state_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_TS_STATE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(state_); \
#define RKH_TE_SM_TS_STATE
Destination state or pseudostate of a transition segment.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Destination state or pseudostate of a transition segment.

Description
Next vertex in a compound transition
Group
RKH_TG_SM
EventID
RKH_TE_SM_TS_STATE
Parameters
[in]actObj_Active object
[in]state_Target state of transition segment

Definition at line 758 of file rkhtrc_record.h.

#define RKH_TR_SM_EVT_PROC (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_EVT_PROC, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TE_SM_EVT_PROC
The arrived event was succesfully processed and HSM resides in an allowed state.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The arrived event was succesfully processed and HSM resides in an allowed state.

Description
The ocurred event was succesfully processed and the state machine resides in a stable state
Group
RKH_TG_SM
EventID
RKH_TE_SM_EVT_PROC
Parameters
[in]actObj_Active object

Definition at line 782 of file rkhtrc_record.h.

#define RKH_TR_SM_EVT_NFOUND (   actObj_,
  evt_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio), \
(evt_)->e) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
#define RKH_TRC_BEGIN(eid_, prio_, sig_)
#define RKH_TE_SM_EVT_NFOUND
The arrived event was't founded in the transition table.
#define RKH_TRC_SIG(e)
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The arrived event was't founded in the transition table.

Description
the arrived event was't founded in the transition table
Group
RKH_TG_SM
EventID
RKH_TE_SM_EVT_NFOUND
Parameters
[in]actObj_Active object
[in]evt_Dispatched event

Definition at line 800 of file rkhtrc_record.h.

#define RKH_TR_SM_GRD_FALSE (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_GRD_FALSE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TE_SM_GRD_FALSE
The transition was cancelled by guard function.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The transition was cancelled by guard function.

Description
The transition was cancelled by a guard function
Group
RKH_TG_SM
EventID
RKH_TE_SM_GRD_FALSE
Parameters
[in]actObj_Active object

Definition at line 819 of file rkhtrc_record.h.

#define RKH_TR_SM_CND_NFOUND (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_CND_NFOUND, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TE_SM_CND_NFOUND
The branch function returned a value not founded in the branch table.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The branch function returned a value not founded in the branch table.

Description
The branch function returned a value not founded in the branch table
Group
RKH_TG_SM
EventID
RKH_TE_SM_CND_NFOUND
Parameters
[in]actObj_Active object

Definition at line 837 of file rkhtrc_record.h.

#define RKH_TR_SM_UNKN_STATE (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_UNKN_STATE, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96
#define RKH_TE_SM_UNKN_STATE
Unknown state.

Unknown state.

Description
Unknown state
Group
RKH_TG_SM
EventID
RKH_TE_SM_UNKN_STATE
Parameters
[in]actObj_Active object

Definition at line 854 of file rkhtrc_record.h.

#define RKH_TR_SM_EX_HLEVEL (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_EX_HLEVEL, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TE_SM_EX_HLEVEL
The transition exceeded the allowed hierarchical level.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The transition exceeded the allowed hierarchical level.

Description
The transition exceeded the allowed hierarchical level
Group
RKH_TG_SM
EventID
RKH_TE_SM_EX_HLEVEL
Parameters
[in]actObj_Active object

Definition at line 871 of file rkhtrc_record.h.

#define RKH_TR_SM_EX_TSEG (   actObj_)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_EX_TSEG, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
#define RKH_TE_SM_EX_TSEG
The transition exceeded the allowed number of segments within a compound transtion.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

The transition exceeded the allowed number of segments within a compound transtion.

Description
The transition exceeded the allowed number of segments within a compound transtion
Group
RKH_TG_SM
EventID
RKH_TE_SM_EX_TSEG
Parameters
[in]actObj_Active object

Definition at line 889 of file rkhtrc_record.h.

#define RKH_TR_SM_EXE_ACT (   actionType_,
  actObj_,
  state_,
  action_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SM_EXE_ACT, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_UI8(actionType_); \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SYM(state_); \
RKH_TRC_FUN(action_); \
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
#define RKH_TE_SM_EXE_ACT
Executes a behavior (action) of state machine, it could be an entry, exit, effect, init, preprocessor or guard.
#define RKH_TRC_FUN(sym)
Insert a function address as trace record argument.
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Executes a behavior (action) of state machine, it could be an entry, exit, effect, init, preprocessor or guard.

Description
Executed behavior of state machine
Group
RKH_TG_SM
EventID
RKH_TE_SM_EXE_ACT
Parameters
[in]actionType_Action type
[in]actObj_Active object
[in]state_State
[in]action_Action

Definition at line 919 of file rkhtrc_record.h.