yasmin::Concurrence Class Reference

Runs a series of states in parallel. More...

#include <concurrence.hpp>

Inheritance diagram for yasmin::Concurrence:

Collaboration diagram for yasmin::Concurrence:

Public Member Functions
	Concurrence (const StateMap &states, const std::string &default_outcome, const OutcomeMap &outcome_map)
	Shared pointer type for Concurrence.
std::string	execute (Blackboard::SharedPtr blackboard) override
	Executes the state's specific logic.
void	cancel_state () override
	Cancels the current state execution.
const StateMap &	get_states () const noexcept
	Returns the map of states managed by this concurrence state.
const OutcomeMap &	get_outcome_map () const noexcept
	Returns the outcome map for this concurrence state.
const std::string &	get_default_outcome () const noexcept
	Returns the default outcome for this concurrence state.
std::string	to_string () const override
	Converts the state to a string representation.
Public Member Functions inherited from yasmin::State
	State (const Outcomes &outcomes)
	Shared pointer type for State.
virtual	~State ()=default
	Virtual destructor for proper polymorphic destruction.
bool	is_idle () const noexcept
	Checks if the state is idle.
bool	is_running () const noexcept
	Checks if the state is currently running.
bool	is_canceled () const noexcept
	Checks if the state has been canceled.
bool	is_completed () const noexcept
	Checks if the state has completed execution.
std::string	operator() (Blackboard::SharedPtr blackboard)
	Executes the state and returns the outcome.
Outcomes const &	get_outcomes () const noexcept
	Gets the set of possible outcomes for this state.

Protected Attributes
const StateMap	states
	The states to run concurrently (name -> state)
const std::string	default_outcome
	Default outcome.
OutcomeMap	outcome_map
StateOutcomeMap	intermediate_outcome_map
	Stores the intermediate outcomes of the concurrent states.
Outcomes	possible_outcomes
	The set of possible outcomes.
Protected Attributes inherited from yasmin::State
Outcomes	outcomes
	The possible outcomes of this state.

Static Private Member Functions
static Outcomes	generate_possible_outcomes (const OutcomeMap &outcome_map, const std::string &default_outcome)
	Helper function to generate a set of possible outcomes from an outcome map.

Private Attributes
std::mutex	intermediate_outcome_mutex
	Mutex for intermediate outcome map.

Detailed Description

Runs a series of states in parallel.

The Concurrence class runs a set of states concurrently, waiting for the termination of each, and then returns a single output according to a provided rule map, or a default outcome if no rule is satisfied.

Constructor & Destructor Documentation

Concurrence()

Concurrence::Concurrence	(	const StateMap &	states,
		const std::string &	default_outcome,
		const OutcomeMap &	outcome_map )

Shared pointer type for Concurrence.

Constructs a State with a set of possible outcomes.

Parameters

states	A map of state names to states that will run concurrently.
default_outcome	The default outcome to return if no outcome map rules are satisfied.
outcome_map	A map of outcome names to requirements for achieving that outcome.

Member Function Documentation

cancel_state()

void Concurrence::cancel_state ( )

overridevirtual

Cancels the current state execution.

This method sets the canceled flag to true and logs the action.

Reimplemented from yasmin::State.

execute()

std::string Concurrence::execute ( Blackboard::SharedPtr blackboard )

overridevirtual

Executes the state's specific logic.

Parameters

blackboard

A shared pointer to the Blackboard to use during execution.

Returns

A string representing the outcome of the execution.

This method is intended to be overridden by derived classes to provide specific execution logic.

Reimplemented from yasmin::State.

generate_possible_outcomes()

Outcomes Concurrence::generate_possible_outcomes ( const OutcomeMap & outcome_map, const std::string & default_outcome )

staticprivate

Helper function to generate a set of possible outcomes from an outcome map.

Parameters

outcome_map
default_outcome

Returns

The set of possible outcomes

get_default_outcome()

const std::string & Concurrence::get_default_outcome ( ) const

noexcept

Returns the default outcome for this concurrence state.

Returns

The default outcome as a string.

get_outcome_map()

const OutcomeMap & Concurrence::get_outcome_map ( ) const

noexcept

Returns the outcome map for this concurrence state.

Returns

A map of outcome names to their requirements.

get_states()

const StateMap & Concurrence::get_states ( ) const

noexcept

Returns the map of states managed by this concurrence state.

Returns

A map of state names to states.

to_string()

std::string Concurrence::to_string ( ) const

overridevirtual

Converts the state to a string representation.

Returns

A string representation of the state.

Reimplemented from yasmin::State.

Member Data Documentation

default_outcome

const std::string yasmin::Concurrence::default_outcome

protected

Default outcome.

intermediate_outcome_map

StateOutcomeMap yasmin::Concurrence::intermediate_outcome_map

protected

Stores the intermediate outcomes of the concurrent states.

intermediate_outcome_mutex

std::mutex yasmin::Concurrence::intermediate_outcome_mutex

private

Mutex for intermediate outcome map.

outcome_map

OutcomeMap yasmin::Concurrence::outcome_map

protected

Specifies which combination of state outputs should produce a given overall output

possible_outcomes

Outcomes yasmin::Concurrence::possible_outcomes

protected

The set of possible outcomes.

states

const StateMap yasmin::Concurrence::states

protected

The states to run concurrently (name -> state)

---

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

• yasmin/include/yasmin/concurrence.hpp
• yasmin/src/yasmin/concurrence.cpp