Class representing a model of a complete state machine. More...

#include <state_machine_model.hpp>

Public Types
typedef std::vector< event_model >	events

Public Member Functions
	state_machine_model ()

	~state_machine_model () SX_NOEXCEPT

void	add_transition (transition_model_uptr _transition)
	Add a transition to the state machine. More...

raw_const_transition_models	get_transitions () const
	Get a list of transitions. More...

composite_state_model_impl &	get_root_state () const
	Get a reference to the root state of the state machine. Reference to the root state of the state machine. More...

void	add_root_state (composite_state_model_uptr _root_state)
	Add the root state to the state machine. More...

events	get_events () const
	Get a list of events that was read from JSON file. This events are the events used in this state machine's scenario. More...

void	add_event (const std::string &_event_name, const event_id &_event_id, const event_priority &_event_priority)
	Add an event to the list of the events. More...

Detailed Description

Class representing a model of a complete state machine.

Member Typedef Documentation

◆ events

typedef std::vector< event_model > sxy::model::state_machine_model::events

Constructor & Destructor Documentation

◆ state_machine_model()

sxy::model::state_machine_model::state_machine_model ( )

◆ ~state_machine_model()

sxy::model::state_machine_model::~state_machine_model ( )

Member Function Documentation

◆ add_event()

void sxy::model::state_machine_model::add_event	(	const std::string &	_event_name,
		const event_id &	_event_id,
		const event_priority &	_event_priority
	)

Add an event to the list of the events.

Parameters

_event_name	Name of the event.
_event_id	Id of the event.

◆ add_root_state()

void sxy::model::state_machine_model::add_root_state ( composite_state_model_uptr _root_state )

Add the root state to the state machine.

◆ add_transition()

void sxy::model::state_machine_model::add_transition ( transition_model_uptr _transition )

Add a transition to the state machine.

◆ get_events()

sxy::model::state_machine_model::events sxy::model::state_machine_model::get_events ( ) const

Get a list of events that was read from JSON file. This events are the events used in this state machine's scenario.

◆ get_root_state()

composite_state_model_impl & sxy::model::state_machine_model::get_root_state ( ) const

Get a reference to the root state of the state machine. Reference to the root state of the state machine.

◆ get_transitions()

raw_const_transition_models sxy::model::state_machine_model::get_transitions ( ) const

Get a list of transitions.

Returns: List of transitions.

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

Public Types

Public Member Functions