ecu_hsm_state Struct Reference

ECU: ecu_hsm_state Struct Reference
ECU
ecu_hsm_state Struct Reference

Single state in hsm, initialized via ECU_HSM_STATE_CTOR(). Pointers are const-qualified to only allow states to be created at compile-time. More...

#include <hsm.h>

Collaboration diagram for ecu_hsm_state:
[legend]

Data Fields

void(*const entry )(struct ecu_hsm *me)
 Executes when state first entered. Optional.
 
void(*const exit )(struct ecu_hsm *me)
 Executes when state exits. Optional.
 
void(*const initial )(struct ecu_hsm *me)
 Transitions to starting (child) state when a transition targets a composite state. Mandatory for composite states. Set to ECU_HSM_STATE_INITIAL_UNUSED for leaf states.
 
bool(*const handler )(struct ecu_hsm *me, const void *event)
 Processes events dispatched to this state. Mandatory. Return true if the dispatched event is processed within this state. Return false if the event should be propagated up the state hierarchy.
 
const struct ecu_hsm_state *const parent
 This state's parent.
 

Detailed Description

Single state in hsm, initialized via ECU_HSM_STATE_CTOR(). Pointers are const-qualified to only allow states to be created at compile-time.

Warning
PRIVATE. Unless otherwise specified, all members can only be edited via the public API.

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