yasmine
sxy::region Class Referenceabstract

#include <region.hpp>

Inheritance diagram for sxy::region:
sxy::state_machine_element sxy::SX_FINAL

Public Member Functions

 region ()
 
virtual ~region () SX_NOEXCEPT SX_OVERRIDE
 
virtual void set_parent_state (composite_state *const _composite_state)=0
 
virtual const composite_stateget_parent_state () const =0
 
virtual composite_stateget_parent_state ()=0
 
virtual raw_const_states get_states () const =0
 
virtual size_t get_pseudostate_count () const =0
 
virtual vertexget_pseudostate (const std::string &_name) const =0
 
virtual vertexget_vertex (const std::string &_vertex_name) const =0
 
virtual raw_const_pseudostates get_pseudostates () const =0
 
virtual initial_pseudostateget_initial_pseudostate () const =0
 
virtual initial_pseudostateadd_initial_pseudostate (initial_pseudostate_uptr _initial_state)=0
 
virtual initial_pseudostateadd_initial_pseudostate (const std::string &_initial_state_name)=0
 
virtual stateadd_state (state_uptr _state)=0
 
virtual choiceadd_choice (choice_uptr _choice)=0
 
virtual choiceadd_choice (const std::string &_choice_name)=0
 
virtual forkadd_fork (fork_uptr _fork)=0
 
virtual forkadd_fork (const std::string &_fork_name)=0
 
virtual joinadd_join (join_uptr _join)=0
 
virtual joinadd_join (const std::string &_join_name)=0
 
virtual junctionadd_junction (junction_uptr _junction)=0
 
virtual junctionadd_junction (const std::string &_junction_name)=0
 
virtual terminate_pseudostateadd_terminate_pseudostate (terminate_pseudostate_uptr _terminate_pseudostate)=0
 
virtual terminate_pseudostateadd_terminate_pseudostate (const std::string &_terminate_pseudostate_name)=0
 
virtual simple_stateadd_simple_state (const std::string &_name, const behavior_function &_behavior=behavior_function(), const behavior_function &_entry_behavior=behavior_function(), const behavior_function &_exit_behavior=behavior_function())=0
 
virtual simple_stateadd_simple_state (const std::string &_name, const event_ids &_deferred_events, const behavior_function &_behavior=behavior_function(), const behavior_function &_entry_behavior=behavior_function(), const behavior_function &_exit_behavior=behavior_function(), event_sptr _error_event=event_sptr())=0
 
virtual simple_stateadd_async_simple_state (const std::string &_name, const event_ids &_deferred_events, async_behavior_uptr _do_action=async_behavior_uptr(), const behavior_function &_entry_behavior=behavior_function(), const behavior_function &_exit_behavior=behavior_function(), event_sptr _error_event=event_sptr())=0
 
virtual composite_stateadd_composite_state (const std::string &_name, const behavior_function &_entry_action=behavior_function(), const behavior_function &_exit_action=behavior_function())=0
 
virtual composite_stateadd_composite_state (const std::string &_name, const event_ids &_deferred_events, const behavior_function &_entry_action=behavior_function(), const behavior_function &_exit_action=behavior_function())=0
 
virtual final_stateadd_final_state (const std::string &_name)=0
 
virtual size_t get_state_count () const =0
 
virtual stateget_state (const std::string &_name) const =0
 
virtual const stateget_active_state () const =0
 
virtual stateget_active_state ()=0
 
virtual void set_active_state (state *const _active_state)=0
 
virtual void set_state_was_active (state *const _active_state)=0
 
virtual const stateget_last_active_state () const =0
 
virtual stateget_last_active_state ()=0
 
virtual bool is_active_state_final () const =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

◆ region()

sxy::region::region ( )
inline

◆ ~region()

virtual sxy::region::~region ( )
inlinevirtual

Member Function Documentation

◆ add_async_simple_state()

virtual simple_state& sxy::region::add_async_simple_state ( const std::string &  _name,
const event_ids _deferred_events,
async_behavior_uptr  _do_action = async_behavior_uptr(),
const behavior_function _entry_behavior = behavior_function(),
const behavior_function _exit_behavior = behavior_function(),
event_sptr  _error_event = event_sptr() 
)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_choice() [1/2]

virtual choice& sxy::region::add_choice ( choice_uptr  _choice)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_choice() [2/2]

virtual choice& sxy::region::add_choice ( const std::string &  _choice_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_composite_state() [1/2]

virtual composite_state& sxy::region::add_composite_state ( const std::string &  _name,
const behavior_function _entry_action = behavior_function(),
const behavior_function _exit_action = behavior_function() 
)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_composite_state() [2/2]

virtual composite_state& sxy::region::add_composite_state ( const std::string &  _name,
const event_ids _deferred_events,
const behavior_function _entry_action = behavior_function(),
const behavior_function _exit_action = behavior_function() 
)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_final_state()

virtual final_state& sxy::region::add_final_state ( const std::string &  _name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_fork() [1/2]

virtual fork& sxy::region::add_fork ( fork_uptr  _fork)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_fork() [2/2]

virtual fork& sxy::region::add_fork ( const std::string &  _fork_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_initial_pseudostate() [1/2]

virtual initial_pseudostate& sxy::region::add_initial_pseudostate ( initial_pseudostate_uptr  _initial_state)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_initial_pseudostate() [2/2]

virtual initial_pseudostate& sxy::region::add_initial_pseudostate ( const std::string &  _initial_state_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_join() [1/2]

virtual join& sxy::region::add_join ( join_uptr  _join)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_join() [2/2]

virtual join& sxy::region::add_join ( const std::string &  _join_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_junction() [1/2]

virtual junction& sxy::region::add_junction ( junction_uptr  _junction)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_junction() [2/2]

virtual junction& sxy::region::add_junction ( const std::string &  _junction_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_simple_state() [1/2]

virtual simple_state& sxy::region::add_simple_state ( const std::string &  _name,
const behavior_function _behavior = behavior_function(),
const behavior_function _entry_behavior = behavior_function(),
const behavior_function _exit_behavior = behavior_function() 
)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_simple_state() [2/2]

virtual simple_state& sxy::region::add_simple_state ( const std::string &  _name,
const event_ids _deferred_events,
const behavior_function _behavior = behavior_function(),
const behavior_function _entry_behavior = behavior_function(),
const behavior_function _exit_behavior = behavior_function(),
event_sptr  _error_event = event_sptr() 
)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_state()

virtual state& sxy::region::add_state ( state_uptr  _state)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_terminate_pseudostate() [1/2]

virtual terminate_pseudostate& sxy::region::add_terminate_pseudostate ( terminate_pseudostate_uptr  _terminate_pseudostate)
pure virtual

Implemented in sxy::SX_FINAL.

◆ add_terminate_pseudostate() [2/2]

virtual terminate_pseudostate& sxy::region::add_terminate_pseudostate ( const std::string &  _terminate_pseudostate_name)
pure virtual

Implemented in sxy::SX_FINAL.

◆ check()

◆ get_active_state() [1/2]

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

Implemented in sxy::SX_FINAL.

◆ get_active_state() [2/2]

virtual state* sxy::region::get_active_state ( )
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_initial_pseudostate()

virtual initial_pseudostate* sxy::region::get_initial_pseudostate ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_last_active_state() [1/2]

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

Implemented in sxy::SX_FINAL.

◆ get_last_active_state() [2/2]

virtual state* sxy::region::get_last_active_state ( )
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_parent_state() [1/2]

virtual const composite_state& sxy::region::get_parent_state ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_parent_state() [2/2]

virtual composite_state& sxy::region::get_parent_state ( )
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_pseudostate()

virtual vertex* sxy::region::get_pseudostate ( const std::string &  _name) const
pure virtual

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

◆ get_pseudostate_count()

virtual size_t sxy::region::get_pseudostate_count ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_pseudostates()

virtual raw_const_pseudostates sxy::region::get_pseudostates ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_state()

virtual state* sxy::region::get_state ( const std::string &  _name) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_state_count()

virtual size_t sxy::region::get_state_count ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_states()

virtual raw_const_states sxy::region::get_states ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ get_vertex()

virtual vertex* sxy::region::get_vertex ( const std::string &  _vertex_name) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ is_active_state_final()

virtual bool sxy::region::is_active_state_final ( ) const
pure virtual

Implemented in sxy::SX_FINAL.

◆ set_active_state()

virtual void sxy::region::set_active_state ( state *const  _active_state)
pure virtual

Implemented in sxy::SX_FINAL.

◆ set_parent_state()

virtual void sxy::region::set_parent_state ( composite_state *const  _composite_state)
pure virtual

Implemented in sxy::SX_FINAL.

◆ set_state_was_active()

virtual void sxy::region::set_state_was_active ( state *const  _active_state)
pure virtual

Implemented in sxy::SX_FINAL.


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