qSM_Handler_t Struct Reference

The callback argument to handle the state-machine dynamics and provide execution information. Some members can be written to perform state-transitions. More...

#include <qfsm.h>

Data Fields
void *	StartState
void *	NextState
const void *	machine
const void *	state
const void *	Data
const void *	StateData
const void *	SignalData
const qSM_SigId_t	Signal
const qSM_Status_t	Status
qSM_TransitionHistoryMode_t	TransitionHistory

Detailed Description

The callback argument to handle the state-machine dynamics and provide execution information. Some members can be written to perform state-transitions.

Note

Should be used only in state-callbacks as the only input argument.

The members of this structure must be accessed as a pointer.

Field Documentation

Data

const void* Data

The user storage pointer. If the FSM its running as a task, this will point to the qEvent_t structure

machine

const void* machine

A pointer to the state machine object.

NextState

void* NextState

Used to produce a transition to the desired state.

Signal

const qSM_SigId_t Signal

The signal that its currently evaluated

SignalData

const void* SignalData

The data with which the signal is associated

StartState

void* StartState

Used to set the initial state (default transition) if the current state its a parent.

state

const void* state

A pointer to the state that its currently evaluated.

StateData

const void* StateData

The state user storage pointer

Status

const qSM_Status_t Status

The last state return status. Only available in the surrounding callback.

TransitionHistory

qSM_TransitionHistoryMode_t TransitionHistory

Used to set the behavior of a transition to history. qSM_TRANSITION_NO_HISTORY by default