yasmine
sxy::state Class Referenceabstract

#include <state.hpp>

Inheritance diagram for sxy::state:
sxy::vertex sxy::state_machine_element sxy::complex_state sxy::final_state sxy::state_impl sxy::complex_state_impl sxy::composite_state sxy::simple_state sxy::SX_FINAL sxy::complex_state_impl sxy::SX_FINAL sxy::simple_state_base sxy::SX_FINAL sxy::SX_FINAL sxy::simple_state_base sxy::simple_state_base sxy::SX_FINAL sxy::SX_FINAL sxy::SX_FINAL sxy::SX_FINAL sxy::SX_FINAL sxy::SX_FINAL sxy::SX_FINAL

Public Member Functions

 state ()
 
virtual ~state () SX_NOEXCEPT SX_OVERRIDE
 
virtual void set_parent_region (region *const _parent_region)=0
 
virtual regionget_parent_region () const =0
 
virtual size_t get_parent_region_index () const =0
 
virtual regionget_region (const std::string &_region_name) const =0
 
virtual vertexget_pseudostate (const std::string &_name_of_pseudostate) const =0
 
virtual behaviorget_entry_behavior () const =0
 
virtual behaviorget_exit_behavior () const =0
 
virtual std::size_t get_nesting_level () const =0
 
virtual void set_active ()=0
 
virtual void set_inactive ()=0
 
virtual bool is_active () const =0
 
virtual bool is_complete () const =0
 
virtual bool is_event_deferred (const event_id &_event_id) const =0
 
virtual bool was_active () const =0
 
virtual void set_was_active ()=0
 
virtual const regionsget_regions () const =0
 
virtual regionsget_regions ()=0
 
virtual void execute_do_behavior (const event &_event, async_event_handler *const _async_event_handler, event_collector &_event_collector) const =0
 
virtual void execute_enter_behavior (const event &_event, event_collector &_event_collector) const =0
 
virtual void execute_exit_behavior (const event &_event, event_collector &_event_collector) const =0
 
virtual void accept_state_visitor (state_visitor &_visitor) const =0
 
virtual void enter_state (const event &_event, event_collector &_event_collector)=0
 
virtual void exit_state (const event &_event, event_collector &_event_collector)=0
 
virtual bool has_error_event () const =0
 
virtual event_sptr get_error_event () const =0
 
- Public Member Functions inherited from sxy::vertex
 vertex ()
 
virtual ~vertex () SX_NOEXCEPT SX_OVERRIDE
 
virtual composite_stateget_root_state ()=0
 
virtual const composite_stateget_root_state () const =0
 
virtual void add_outgoing_transition (transition &_outgoing_transition)=0
 
virtual void add_incoming_transition (transition &_incoming_transition)=0
 
virtual void remove_outgoing_transition (const transition &_outgoing_transition)=0
 
virtual void remove_incoming_transition (const transition &_incoming_transition)=0
 
virtual const raw_transitionsget_outgoing_transitions () const =0
 
virtual const raw_transitionsget_incoming_transitions () const =0
 
virtual raw_regions get_ancestors_as_regions () const =0
 
virtual raw_composite_states get_ancestors (composite_state *const _final_ancestor, bool _include_final_ancestor=true) const =0
 
virtual transitionsearch_transition (const event &_event, event_collector &_event_collector) const =0
 
virtual regionLCA_region (const vertex &_target_vertex) const =0
 
virtual composite_stateLCA_composite_state (const vertex &_rhs) const =0
 
virtual void accept_vertex_visitor (const_vertex_visitor &_visitor) const =0
 
virtual void accept_vertex_visitor (vertex_visitor &_visitor)=0
 
virtual bool check (state_machine_defects &_defects) const SX_OVERRIDE=0
 
- Public Member Functions inherited from sxy::state_machine_element
 state_machine_element ()
 
virtual ~state_machine_element () SX_NOEXCEPT
 
virtual const std::string & get_name () const =0
 
virtual sxe::uri get_uri () const =0
 
virtual void add_ancestor_uri (sxe::uri &_uri) const =0
 
virtual const state_machine_elementget_parent () const =0
 

Constructor & Destructor Documentation

◆ state()

sxy::state::state ( )
inline

◆ ~state()

virtual sxy::state::~state ( )
inlinevirtual

Member Function Documentation

◆ accept_state_visitor()

virtual void sxy::state::accept_state_visitor ( state_visitor _visitor) const
pure virtual

◆ enter_state()

virtual void sxy::state::enter_state ( const event _event,
event_collector _event_collector 
)
pure virtual

Implemented in sxy::state_impl.

◆ execute_do_behavior()

virtual void sxy::state::execute_do_behavior ( const event _event,
async_event_handler *const  _async_event_handler,
event_collector _event_collector 
) const
pure virtual

◆ execute_enter_behavior()

virtual void sxy::state::execute_enter_behavior ( const event _event,
event_collector _event_collector 
) const
pure virtual

Implemented in sxy::state_impl.

◆ execute_exit_behavior()

virtual void sxy::state::execute_exit_behavior ( const event _event,
event_collector _event_collector 
) const
pure virtual

Implemented in sxy::state_impl, and sxy::SX_FINAL.

◆ exit_state()

virtual void sxy::state::exit_state ( const event _event,
event_collector _event_collector 
)
pure virtual

Implemented in sxy::state_impl.

◆ get_entry_behavior()

virtual behavior* sxy::state::get_entry_behavior ( ) const
pure virtual

Implemented in sxy::complex_state_impl, and sxy::SX_FINAL.

◆ get_error_event()

virtual event_sptr sxy::state::get_error_event ( ) const
pure virtual

◆ get_exit_behavior()

virtual behavior* sxy::state::get_exit_behavior ( ) const
pure virtual

Implemented in sxy::complex_state_impl, and sxy::SX_FINAL.

◆ get_nesting_level()

virtual std::size_t sxy::state::get_nesting_level ( ) const
pure virtual

Implemented in sxy::state_impl.

◆ get_parent_region()

virtual region* sxy::state::get_parent_region ( ) const
pure virtual

Implemented in sxy::state_impl.

◆ get_parent_region_index()

virtual size_t sxy::state::get_parent_region_index ( ) const
pure virtual

Implemented in sxy::SX_FINAL, and sxy::state_impl.

◆ get_pseudostate()

virtual vertex* sxy::state::get_pseudostate ( const std::string &  _name_of_pseudostate) const
pure virtual

◆ get_region()

virtual region* sxy::state::get_region ( const std::string &  _region_name) const
pure virtual

Implemented in sxy::SX_FINAL, and sxy::state_impl.

◆ get_regions() [1/2]

virtual const regions& sxy::state::get_regions ( ) const
pure virtual

◆ get_regions() [2/2]

virtual regions& sxy::state::get_regions ( )
pure virtual

◆ has_error_event()

virtual bool sxy::state::has_error_event ( ) const
pure virtual

◆ is_active()

virtual bool sxy::state::is_active ( ) const
pure virtual

Implemented in sxy::state_impl.

◆ is_complete()

virtual bool sxy::state::is_complete ( ) const
pure virtual

Implemented in sxy::state_impl, and sxy::SX_FINAL.

◆ is_event_deferred()

virtual bool sxy::state::is_event_deferred ( const event_id _event_id) const
pure virtual

Implemented in sxy::SX_FINAL, and sxy::complex_state_impl.

◆ set_active()

virtual void sxy::state::set_active ( )
pure virtual

Implemented in sxy::state_impl.

◆ set_inactive()

virtual void sxy::state::set_inactive ( )
pure virtual

Implemented in sxy::state_impl.

◆ set_parent_region()

virtual void sxy::state::set_parent_region ( region *const  _parent_region)
pure virtual

Implemented in sxy::state_impl.

◆ set_was_active()

virtual void sxy::state::set_was_active ( )
pure virtual

Implemented in sxy::state_impl.

◆ was_active()

virtual bool sxy::state::was_active ( ) const
pure virtual

Implemented in sxy::state_impl.


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