The state structure for the infinite state. This structure represents a state in the infinite state machine. It contains information about the state's parent, composite enter action, and composite exit action. More...
#include <infinite_state.h>
Collaboration diagram for infinite_state:
Public Attributes | |
| struct infinite_state * | super |
| The parent state of this state. | |
| void(* | enter )(struct infinite_state *state, struct infinite_state_machine *machine) |
| The enter action for this state. | |
| void(* | exit )(struct infinite_state *state, struct infinite_state_machine *machine) |
| The exit action for this state. | |
Detailed Description
The state structure for the infinite state. This structure represents a state in the infinite state machine. It contains information about the state's parent, composite enter action, and composite exit action.
Definition at line 30 of file infinite_state.h.
Member Data Documentation
◆ enter
| void(* infinite_state::enter) (struct infinite_state *state, struct infinite_state_machine *machine) |
The enter action for this state.
- Note
- This function is called when the state is entered in response to a transition. The state is already pushed onto the machine stack when this function is called. The function may be
NULL, in which case no action is taken.
- Parameters
-
state The incoming sub-state. machine The infinite state machine.
Definition at line 47 of file infinite_state.h.
◆ exit
| void(* infinite_state::exit) (struct infinite_state *state, struct infinite_state_machine *machine) |
The exit action for this state.
- Note
- This function is called when the state is exited in response to a transition. The state is already popped from the machine stack before this function is called. The function may be
NULL, in which case no action is taken.
- Parameters
-
state The outgoing sub-state. machine The infinite state machine.
Definition at line 59 of file infinite_state.h.
◆ super
| struct infinite_state* infinite_state::super |
The parent state of this state.
Definition at line 35 of file infinite_state.h.
The documentation for this struct was generated from the following file:
- inc/infinite_state.h
