region.hpp

Go to the documentation of this file.

//                                                                                                  //
// This file is part of the Seadex yasmine ecosystem (http://yasmine.seadex.de).                    //
// Copyright (C) 2016-2017 Seadex GmbH                                                              //
//                                                                                                  //
// Licensing information is available in the folder "license" which is part of this distribution.   //
// The same information is available on the www @ http://yasmine.seadex.de/Licenses.html.           //
//                                                                                                  //


#ifndef REGION_06648EA9_E80A_49B8_9814_1723273908D2
#define REGION_06648EA9_E80A_49B8_9814_1723273908D2


#include "state_machine_element.hpp"
#include "state_fwd.hpp"
#include "region_fwd.hpp"
#include "pseudostate_fwd.hpp"
#include "initial_pseudostate_fwd.hpp"
#include "choice_fwd.hpp"
#include "fork_fwd.hpp"
#include "join_fwd.hpp"
#include "junction_fwd.hpp"
#include "terminate_pseudostate_fwd.hpp"
#include "behavior_fwd.hpp"
#include "async_behavior.hpp"
#include "event_fwd.hpp"
#include "event_id.hpp"


namespace sxy
{


class vertex;
class composite_state;
class simple_state;
class final_state;


class region: public virtual state_machine_element
{
public:
 region() 
 {
  // Nothing to do...
 }


 virtual ~region () SX_NOEXCEPT SX_OVERRIDE
 {
  // Nothing to do...
 }


 SX_NO_COPY(region)
 virtual void set_parent_state( composite_state* const _composite_state ) = 0;
 virtual const composite_state& get_parent_state() const = 0;
 virtual composite_state& get_parent_state() = 0;
 virtual raw_const_states get_states() const = 0;
 virtual size_t get_pseudostate_count() const = 0;
 virtual vertex* get_pseudostate( const std::string& _name ) const = 0;
 virtual vertex* get_vertex( const std::string& _vertex_name ) const = 0;
 virtual raw_const_pseudostates get_pseudostates() const = 0;
 virtual initial_pseudostate* get_initial_pseudostate() const = 0;
 virtual initial_pseudostate& add_initial_pseudostate( initial_pseudostate_uptr _initial_state ) = 0;
 virtual initial_pseudostate& add_initial_pseudostate( const std::string& _initial_state_name ) = 0;
 virtual state& add_state( state_uptr _state ) = 0;
 virtual choice& add_choice( choice_uptr _choice ) = 0;
 virtual choice& add_choice( const std::string& _choice_name ) = 0;
 virtual fork& add_fork( fork_uptr _fork ) = 0;
 virtual fork& add_fork( const std::string& _fork_name ) = 0;
 virtual join& add_join( join_uptr _join ) = 0;
 virtual join& add_join( const std::string& _join_name ) = 0;
 virtual junction& add_junction( junction_uptr _junction ) = 0;
 virtual junction& add_junction( const std::string& _junction_name ) = 0;
 virtual terminate_pseudostate& add_terminate_pseudostate( 
  terminate_pseudostate_uptr _terminate_pseudostate ) = 0;
 virtual terminate_pseudostate& add_terminate_pseudostate( const std::string& _terminate_pseudostate_name ) = 0;
 virtual simple_state& 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() ) = 0;
 virtual simple_state& 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() ) = 0;
 virtual simple_state& 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() ) = 0;
 virtual composite_state& add_composite_state( const std::string& _name,
  const behavior_function& _entry_action = behavior_function(),
  const behavior_function& _exit_action = behavior_function() ) = 0;
 virtual composite_state& 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() ) = 0;
 virtual final_state& add_final_state( const std::string& _name ) = 0;
 virtual size_t get_state_count() const = 0;
 virtual state* get_state( const std::string& _name ) const = 0;
 virtual const state* get_active_state() const = 0;
 virtual state* get_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 state* get_last_active_state() const = 0;
 virtual state* get_last_active_state() = 0;
 virtual bool is_active_state_final() const = 0;
 virtual bool check( state_machine_defects& _defects ) const SX_OVERRIDE = 0;
};


}


#endif