smf_state Struct Reference

General state that can be used in multiple state machines. More...

#include <smf.h>

Data Fields
const state_execution	entry
	Optional method that will be run when this state is entered.
const state_execution	run
	Optional method that will be run repeatedly during state machine loop.
const state_execution	exit
	Optional method that will be run when this state exists.
const struct smf_state *	parent
	Optional parent state that contains common entry/run/exit implementation among various child states.

Detailed Description

General state that can be used in multiple state machines.

Field Documentation

entry

const state_execution smf_state::entry

Optional method that will be run when this state is entered.

exit

const state_execution smf_state::exit

Optional method that will be run when this state exists.

parent

const struct smf_state* smf_state::parent

Optional parent state that contains common entry/run/exit implementation among various child states.

entry: Parent function executes BEFORE child function. run: Parent function executes AFTER child function. exit: Parent function executes AFTER child function.

Note: When transitioning between two child states with a shared parent, that parent's exit and entry functions do not execute.

run

const state_execution smf_state::run

Optional method that will be run repeatedly during state machine loop.

---

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

• zephyr/smf.h