RKH_SM_T Struct Reference

Describes the state machine. More...

#include <rkhsm.h>

Data Fields
rui8_t	prio
	SMA (a.k.a Active Object) priority.
rui8_t	ppty
	State machine properties.
RKHROM RKH_ST_T *	istate
	Name of State Machine Application (a.k.a Active Object).
RKH_TRN_ACT_T	iaction
	Points to initializing action (optional).
RKHROM RKH_ST_T *	state
	Pointer to an event that will be passed to state machine application when it starts. Could be used to pass arguments to the state machine like an argc/argv. This argument is optional, thus it could be declared as NULL or eliminated in compile-time with RKH_CFG_SMA_INIT_EVT_EN = 0.
RKH_EVT_T *	propagatedEvent
	Points to the propagated event.

Detailed Description

Describes the state machine.

RKH_SM_T is not intended to be instantiated directly, but rather serves as the base structure for derivation of state machines in the application code. Also, is the base structure of active object structure RKH_SMA_T.

Definition at line 1926 of file rkhsm.h.

Field Documentation

prio

rui8_t prio

SMA (a.k.a Active Object) priority.

A unique priority number must be assigned to each SMA from 0 to RKH_LOWEST_PRIO. The lower the number, the higher the priority.

Definition at line 1935 of file rkhsm.h.

ppty

rui8_t ppty

State machine properties.

The available properties are enumerated in RKH_HPPTY_T enumeration in the rkh.h file.

Definition at line 1944 of file rkhsm.h.

istate

RKHROM RKH_ST_T* istate

Name of State Machine Application (a.k.a Active Object).

Pointer to an ASCII string (NULL terminated) to assign a name to the State Machine Application (a.k.a Active Object). The name can be displayed by debuggers or by Trazer.

Points to initial state.

This state could be defined either composite or basic (not pseudo-state).

Definition at line 1965 of file rkhsm.h.

iaction

RKH_TRN_ACT_T iaction

Points to initializing action (optional).

The function prototype is defined as RKH_TRN_ACT_T. This argument is optional, thus it could be declared as NULL.

Definition at line 1974 of file rkhsm.h.

state

RKHROM RKH_ST_T* state

Pointer to an event that will be passed to state machine application when it starts. Could be used to pass arguments to the state machine like an argc/argv. This argument is optional, thus it could be declared as NULL or eliminated in compile-time with RKH_CFG_SMA_INIT_EVT_EN = 0.

Points to current stable state (simple or final state).

Definition at line 1992 of file rkhsm.h.

---

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

• rkhsm.h