RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Related to state machine applications

Configuration options related to active objects (SMA) More...

Macros

#define RKH_CFG_SMA_GET_INFO_EN   RKH_ENABLED
 If the RKH_CFG_SMA_GET_INFO_EN is set to 1 then RKH will include the rkh_clear_info() and rkh_get_info() functions. More...
 
#define RKH_CFG_SMA_PPRO_EN   RKH_ENABLED
 If the RKH_CFG_SMA_PPRO_EN is set to 1 then RKH allows to reference a event preprocessor to any basic state. Aditionally, by means of single inheritance in C it could be used as state's abstract data. Moreover, implementing the single inheritance in C is very simply by literally embedding the base type, RKH_PPRO_T in this case, as the first member of the derived structure. See prepro member of RKH_ST_T structure for more information. More...
 
#define RKH_CFG_SMA_HCAL_EN   RKH_ENABLED
 If the RKH_CFG_SMA_HCAL_EN is set to 1, the RKH allows state nesting. When RKH_CFG_SMA_HCAL_EN is set to 0 some important features of RKH are not included: state nesting, composite state, history (shallow and deep) pseudostate, entry action, and exit action. More...
 
#define RKH_CFG_SMA_MAX_HCAL_DEPTH   4u
 Specify the maximum number of hierarchical levels. The smaller this number, the lower the RAM consumption. Typically, the most of hierarchical state machines uses up to 4 levels. Currently RKH_CFG_SMA_MAX_HCAL_DEPTH cannot exceed 8. More...
 
#define RKH_CFG_SMA_MAX_TRC_SEGS   4u
 Specify the maximum number of linked transition segments. The smaller this number, the lower the RAM consumption. Typically, the most of hierarchical state machines uses up to 4 transition segments. Currently RKH_CFG_SMA_MAX_TRC_SEGS cannot exceed 8. More...
 
#define RKH_CFG_SMA_PSEUDOSTATE_EN   RKH_ENABLED
 If the RKH_CFG_SMA_PSEUDOSTATE_EN is set to 1, the RKH allows pseudostates usage. More...
 
#define RKH_CFG_SMA_DEEP_HIST_EN   RKH_ENABLED
 If the RKH_CFG_SMA_DEEP_HIST_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows deep history pseudostate usage. More...
 
#define RKH_CFG_SMA_SHALLOW_HIST_EN   RKH_ENABLED
 If the RKH_CFG_SMA_SHALLOW_HIST_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows shallow history pseudostate usage. More...
 
#define RKH_CFG_SMA_CHOICE_EN   RKH_ENABLED
 If the RKH_CFG_SMA_CHOICE_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows choice pseudostate usage. More...
 
#define RKH_CFG_SMA_CONDITIONAL_EN   RKH_ENABLED
 If the RKH_CFG_SMA_CONDITIONAL_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows branch (or conditional) pseudostate usage. More...
 
#define RKH_CFG_SMA_SUBMACHINE_EN   RKH_ENABLED
 If the RKH_CFG_SMA_SUBMACHINE_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows submachine state (and exit/entry points) usage. More...
 
#define RKH_CFG_SMA_TRC_SNDR_EN   RKH_ENABLED
 If the RKH_CFG_SMA_TRC_SNDR_EN and RKH_CFG_TRC_EN are set to 1, when posting an event the RKH inserts a pointer to the sender object. More...
 
#define RKH_CFG_SMA_INIT_EVT_EN   RKH_ENABLED
 If the RKH_CFG_SMA_INIT_EVT_EN is set to 1 then an initial event could be be passed to state machine application when it starts, like an argc/argv. Also, the RKH_CFG_SMA_INIT_EVT_EN changes the initial action prototype. More...
 

Detailed Description

Configuration options related to active objects (SMA)

Macro Definition Documentation

#define RKH_CFG_SMA_GET_INFO_EN   RKH_ENABLED

If the RKH_CFG_SMA_GET_INFO_EN is set to 1 then RKH will include the rkh_clear_info() and rkh_get_info() functions.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 313 of file rkhcfg.h.

#define RKH_CFG_SMA_PPRO_EN   RKH_ENABLED

If the RKH_CFG_SMA_PPRO_EN is set to 1 then RKH allows to reference a event preprocessor to any basic state. Aditionally, by means of single inheritance in C it could be used as state's abstract data. Moreover, implementing the single inheritance in C is very simply by literally embedding the base type, RKH_PPRO_T in this case, as the first member of the derived structure. See prepro member of RKH_ST_T structure for more information.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 329 of file rkhcfg.h.

#define RKH_CFG_SMA_HCAL_EN   RKH_ENABLED

If the RKH_CFG_SMA_HCAL_EN is set to 1, the RKH allows state nesting. When RKH_CFG_SMA_HCAL_EN is set to 0 some important features of RKH are not included: state nesting, composite state, history (shallow and deep) pseudostate, entry action, and exit action.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 342 of file rkhcfg.h.

#define RKH_CFG_SMA_MAX_HCAL_DEPTH   4u

Specify the maximum number of hierarchical levels. The smaller this number, the lower the RAM consumption. Typically, the most of hierarchical state machines uses up to 4 levels. Currently RKH_CFG_SMA_MAX_HCAL_DEPTH cannot exceed 8.

Type value
Integer
Range value
[1..8]
Default configuration:
4

Definition at line 355 of file rkhcfg.h.

#define RKH_CFG_SMA_MAX_TRC_SEGS   4u

Specify the maximum number of linked transition segments. The smaller this number, the lower the RAM consumption. Typically, the most of hierarchical state machines uses up to 4 transition segments. Currently RKH_CFG_SMA_MAX_TRC_SEGS cannot exceed 8.

Type value
Integer
Range value
[1..4]
Default configuration:
4

Definition at line 368 of file rkhcfg.h.

#define RKH_CFG_SMA_PSEUDOSTATE_EN   RKH_ENABLED

If the RKH_CFG_SMA_PSEUDOSTATE_EN is set to 1, the RKH allows pseudostates usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 379 of file rkhcfg.h.

#define RKH_CFG_SMA_DEEP_HIST_EN   RKH_ENABLED

If the RKH_CFG_SMA_DEEP_HIST_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows deep history pseudostate usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 390 of file rkhcfg.h.

#define RKH_CFG_SMA_SHALLOW_HIST_EN   RKH_ENABLED

If the RKH_CFG_SMA_SHALLOW_HIST_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows shallow history pseudostate usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 401 of file rkhcfg.h.

#define RKH_CFG_SMA_CHOICE_EN   RKH_ENABLED

If the RKH_CFG_SMA_CHOICE_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows choice pseudostate usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 412 of file rkhcfg.h.

#define RKH_CFG_SMA_CONDITIONAL_EN   RKH_ENABLED

If the RKH_CFG_SMA_CONDITIONAL_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows branch (or conditional) pseudostate usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 423 of file rkhcfg.h.

#define RKH_CFG_SMA_SUBMACHINE_EN   RKH_ENABLED

If the RKH_CFG_SMA_SUBMACHINE_EN and RKH_CFG_SMA_PSEUDOSTATE_EN are set to 1, the RKH allows submachine state (and exit/entry points) usage.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 434 of file rkhcfg.h.

#define RKH_CFG_SMA_TRC_SNDR_EN   RKH_ENABLED

If the RKH_CFG_SMA_TRC_SNDR_EN and RKH_CFG_TRC_EN are set to 1, when posting an event the RKH inserts a pointer to the sender object.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 445 of file rkhcfg.h.

#define RKH_CFG_SMA_INIT_EVT_EN   RKH_ENABLED

If the RKH_CFG_SMA_INIT_EVT_EN is set to 1 then an initial event could be be passed to state machine application when it starts, like an argc/argv. Also, the RKH_CFG_SMA_INIT_EVT_EN changes the initial action prototype.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 458 of file rkhcfg.h.