Constant parameters of state machine. More...

#include <rkhsm.h>

Data Fields
rui8_t	prio
	SMA (a.k.a Active Object) priority. More...

rui8_t	ppty
	State machine properties. More...

const char *	name
	Name of State Machine Application (a.k.a Active Object). More...

RKHROM RKH_ST_T *	istate
	Points to initial state. More...

RKH_TRN_ACT_T	iaction
	Points to initializing action (optional). More...

const RKH_EVT_T *	ievent
	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.

Detailed Description

Constant parameters of state machine.

The constant key parameters of a state machine are allocated within.

See also: RKH_SMA_T structure definition for more information. Also, single inheritance in C , and another example .

Definition at line 1828 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 1837 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 1846 of file rkhsm.h.

◆ name

const char* name

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.

Definition at line 1857 of file rkhsm.h.

◆ istate

RKHROM RKH_ST_T* istate

Points to initial state.

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

Definition at line 1867 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 1876 of file rkhsm.h.

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

rkhsm.h