yasmine
Public Member Functions | List of all members
sxy::event_processing_callback Interface Referenceabstract

Callback interface that is called by a state machine during event processing. See the different methods to find out which events can be monitored. More...

#include <event_processing_callback.hpp>

Public Member Functions

 event_processing_callback ()
 
virtual ~event_processing_callback () SX_NOEXCEPT
 
virtual void add_state_machine_introspection (state_machine_introspection &_state_machine)=0
 Adds a state machine introspection interface. More...
 
virtual void before_event (const event_id _event_id, const event_priority _event_priority=DEFAULT_EVENT_PRIORITY)=0
 Callback before an event is processed. More...
 
virtual void after_event (const event_id _event_id, const event_priority _event_priority=DEFAULT_EVENT_PRIORITY)=0
 Callback after an event is processed. More...
 
virtual void before_event_processings_stage ()=0
 Callback before a event execution stage. More...
 
virtual void after_event_processings_stage (const raw_const_choices &_choices)=0
 Callback after a event execution stage. More...
 
virtual void before_compound_transition ()=0
 Callback before the processing of a compound transition. More...
 
virtual void after_compound_transition ()=0
 Callback after the processing of a compound transition. More...
 
virtual void before_exit (const state &_state)=0
 Callback before exiting a state. More...
 
virtual void after_exit (const state &_state)=0
 Callback after exiting a state. More...
 
virtual void before_enter (const state &_state)=0
 Callback before entering a state. More...
 
virtual void after_enter (const state &_state)=0
 Callback after entering a state. More...
 
virtual void before_do (const state &_state)=0
 Callback before execution of a state behavior ("do behavior"). More...
 
virtual void after_do (const state &_state)=0
 Callback after execution of a state behavior ("do behavior"). More...
 
virtual void before_transition (const transition &_transition)=0
 Callback before execution of a transition behavior. More...
 
virtual void after_transition (const transition &_transition)=0
 Callback after execution of a transition behavior. More...
 

Detailed Description

Callback interface that is called by a state machine during event processing. See the different methods to find out which events can be monitored.

Constructor & Destructor Documentation

◆ event_processing_callback()

sxy::event_processing_callback::event_processing_callback ( )
inline

◆ ~event_processing_callback()

virtual sxy::event_processing_callback::~event_processing_callback ( )
inlinevirtual

Member Function Documentation

◆ add_state_machine_introspection()

virtual void sxy::event_processing_callback::add_state_machine_introspection ( state_machine_introspection &  _state_machine)
pure virtual

Adds a state machine introspection interface.

Parameters
_state_machineThe state machine which is monitored.
Returns
void

◆ after_compound_transition()

virtual void sxy::event_processing_callback::after_compound_transition ( )
pure virtual

Callback after the processing of a compound transition.

Returns
void

◆ after_do()

virtual void sxy::event_processing_callback::after_do ( const state &  _state)
pure virtual

Callback after execution of a state behavior ("do behavior").

Parameters
_stateState whose behavior was executed.
Returns
void

◆ after_enter()

virtual void sxy::event_processing_callback::after_enter ( const state &  _state)
pure virtual

Callback after entering a state.

Parameters
_stateState that was entered.
Returns
void

◆ after_event()

virtual void sxy::event_processing_callback::after_event ( const event_id  _event_id,
const event_priority  _event_priority = DEFAULT_EVENT_PRIORITY 
)
pure virtual

Callback after an event is processed.

Parameters
_event_idID of the event.
Returns
void

◆ after_event_processings_stage()

virtual void sxy::event_processing_callback::after_event_processings_stage ( const raw_const_choices &  _choices)
pure virtual

Callback after a event execution stage.

Parameters
_choicesList of choices that need to be processed after the last execution stage.
Returns
void

◆ after_exit()

virtual void sxy::event_processing_callback::after_exit ( const state &  _state)
pure virtual

Callback after exiting a state.

Parameters
_stateState that was exited.
Returns
void

◆ after_transition()

virtual void sxy::event_processing_callback::after_transition ( const transition &  _transition)
pure virtual

Callback after execution of a transition behavior.

Parameters
_transitionTransition whose behavior was executed.
Returns
void

◆ before_compound_transition()

virtual void sxy::event_processing_callback::before_compound_transition ( )
pure virtual

Callback before the processing of a compound transition.

Returns
void

◆ before_do()

virtual void sxy::event_processing_callback::before_do ( const state &  _state)
pure virtual

Callback before execution of a state behavior ("do behavior").

Parameters
_stateState whose behavior will be executed.
Returns
void

◆ before_enter()

virtual void sxy::event_processing_callback::before_enter ( const state &  _state)
pure virtual

Callback before entering a state.

Parameters
_stateState that will be entered.
Returns
void.

◆ before_event()

virtual void sxy::event_processing_callback::before_event ( const event_id  _event_id,
const event_priority  _event_priority = DEFAULT_EVENT_PRIORITY 
)
pure virtual

Callback before an event is processed.

Parameters
_event_idID of the event.
Returns
void

◆ before_event_processings_stage()

virtual void sxy::event_processing_callback::before_event_processings_stage ( )
pure virtual

Callback before a event execution stage.

Returns
void

◆ before_exit()

virtual void sxy::event_processing_callback::before_exit ( const state &  _state)
pure virtual

Callback before exiting a state.

Parameters
_stateState that will be exited.
Returns
void

◆ before_transition()

virtual void sxy::event_processing_callback::before_transition ( const transition &  _transition)
pure virtual

Callback before execution of a transition behavior.

Parameters
_transitionTransition whose behavior will be executed.
Returns
void
The documentation for this interface was generated from the following file: