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

◆ RKH_TR_SM_INIT

#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_); \
                RKH_TRC_END()

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 546 of file rkhtrc_record.h.

◆ RKH_TR_SM_CLRH

#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_); \
                RKH_TRC_END()

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 573 of file rkhtrc_record.h.

◆ RKH_TR_SM_DCH

#define RKH_TR_SM_DCH	(	actObj_,
		evt_,
		state_
	)

Value:

                RKH_TRC_BEGIN(RKH_TE_SM_DCH, \
                              RKH_SMA_ACCESS_CONST(actObj_, prio), \
                              (evt_)->e) \
                RKH_TRC_SYM(actObj_); \
                RKH_TRC_SIG((evt_)->e); \
                RKH_TRC_SYM(state_); \
                RKH_TRC_END()

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 596 of file rkhtrc_record.h.

◆ RKH_TR_SM_TRN

#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_); \
                RKH_TRC_END()

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 622 of file rkhtrc_record.h.

◆ RKH_TR_SM_STATE

#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_); \
                RKH_TRC_END()

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 645 of file rkhtrc_record.h.

◆ RKH_TR_SM_ENSTATE

#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_); \
                RKH_TRC_END()

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 667 of file rkhtrc_record.h.

◆ RKH_TR_SM_EXSTATE

#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_); \
                RKH_TRC_END()

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 689 of file rkhtrc_record.h.

◆ RKH_TR_SM_NENEX

#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_); \
        RKH_TRC_END()

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 712 of file rkhtrc_record.h.

◆ RKH_TR_SM_NTRNACT

#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_); \
                RKH_TRC_UI8(nta); \
                RKH_TRC_UI8(nts); \
                RKH_TRC_END()

Number of executed actions and segments of the transition.

Deprecated:

Description Number of executed actions in transition

Group RKH_TG_SM

EventID RKH_TE_SM_NTRNACT

Parameters

[in]	actObj_	Active object
[in]	nta	Number of executed effect action
[in]	nts	Number of transition segments

Definition at line 738 of file rkhtrc_record.h.

◆ RKH_TR_SM_TS_STATE

#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_); \
                RKH_TRC_END()

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 761 of file rkhtrc_record.h.

◆ RKH_TR_SM_EVT_PROC

#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_); \
            RKH_TRC_END()

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 785 of file rkhtrc_record.h.

◆ RKH_TR_SM_EVT_NFOUND

#define RKH_TR_SM_EVT_NFOUND	(	actObj_,
		evt_
	)

Value:

            RKH_TRC_BEGIN(RKH_TE_SM_EVT_NFOUND, \
                          RKH_SMA_ACCESS_CONST(actObj_, prio), \
                          (evt_)->e) \
            RKH_TRC_SYM(actObj_); \
            RKH_TRC_SIG((evt_)->e); \
            RKH_TRC_END()

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 803 of file rkhtrc_record.h.

◆ RKH_TR_SM_GRD_FALSE

#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_); \
            RKH_TRC_END()

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 822 of file rkhtrc_record.h.

◆ RKH_TR_SM_CND_NFOUND

#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_); \
            RKH_TRC_END()

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 840 of file rkhtrc_record.h.

◆ RKH_TR_SM_UNKN_STATE

#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_); \
            RKH_TRC_END()

Unknown state.

Description Unknown state

Group RKH_TG_SM

EventID RKH_TE_SM_UNKN_STATE

Parameters

[in] actObj_ Active object

Definition at line 857 of file rkhtrc_record.h.

◆ RKH_TR_SM_EX_HLEVEL

#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_); \
            RKH_TRC_END()

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 874 of file rkhtrc_record.h.

◆ RKH_TR_SM_EX_TSEG

#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_); \
            RKH_TRC_END()

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 892 of file rkhtrc_record.h.

◆ RKH_TR_SM_EXE_ACT

#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_); \
                RKH_TRC_END()

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 922 of file rkhtrc_record.h.