scxml4cpp::Helper Class Reference

#include <Helper.h>

Public Member Functions
	Helper ()
	~Helper ()
const std::string	printStateType (State *s)
const std::string	printTransition (Transition *t)
const std::string	printTransitions (std::list< Transition * > &transitions)
const std::string	printTargetState (Transition *transitions)
const std::string	printTargetStates (std::list< Transition * > &transitions)
const std::string	printActions (std::list< Action * > &actions)
const std::string	printActivities (std::list< Activity * > &activities)
const std::string	printStates (State *s)
const std::string	printStateMachine (StateMachine &)
const std::string	formatStatus (std::set< State * > &status, const bool usefullyqualified=false)
bool	compareStateDocOrder (State *s1, State *s2)
void	sortAtomicStates (std::set< State * > &status, std::vector< State * > &sortedStatus)
bool	isInState (const std::set< State * > &status, const std::list< std::string > &stateNames)
int	countParents (State *)
bool	isDescendant (State *, State *)
std::set< State * >	getAncestors (std::list< State * > &states)
std::list< State * >	getAncestorsList (std::set< State * > &states)
std::set< State * >	getAncestors (State *)
std::list< State * >	getAncestorsList (State *)
std::list< State * >	getProperAncestors (State *, State *)
State *	findLeastCommonAncestor (State *, State *)
bool	eventMatch (const Event &, const Event &)
std::list< State * >	getAtomicStates (std::set< State * > &states)
std::list< State * >	getAtomicStates (std::list< State * > &states)
bool	isPreempted (State *, std::list< Transition * > &transitions)
	Helper ()
	~Helper ()
const std::string	printStateType (State *s)
const std::string	printTransition (Transition *t)
const std::string	printTransitions (std::list< Transition * > &transitions)
const std::string	printTargetState (Transition *transitions)
const std::string	printTargetStates (std::list< Transition * > &transitions)
const std::string	printActions (std::list< Action * > &actions)
const std::string	printActivities (std::list< Activity * > &activities)
const std::string	printStates (State *s)
const std::string	printStateMachine (StateMachine &)
const std::string	formatStatus (std::set< State * > &status, const bool usefullyqualified=false)
bool	compareStateDocOrder (State *s1, State *s2)
void	sortAtomicStates (std::set< State * > &status, std::vector< State * > &sortedStatus)
bool	isInState (const std::set< State * > &status, const std::list< std::string > &stateNames)
int	countParents (State *)
bool	isDescendant (State *, State *)
std::set< State * >	getAncestors (std::list< State * > &states)
std::list< State * >	getAncestorsList (std::set< State * > &states)
std::set< State * >	getAncestors (State *)
std::list< State * >	getAncestorsList (State *)
std::list< State * >	getProperAncestors (State *, State *)
State *	findLeastCommonAncestor (State *, State *)
bool	eventMatch (const Event &, const Event &)
std::list< State * >	getAtomicStates (std::set< State * > &states)
std::list< State * >	getAtomicStates (std::list< State * > &states)
bool	isPreempted (State *, std::list< Transition * > &transitions)
	Helper ()
	~Helper ()
const std::string	printStateType (State *s)
const std::string	printTransition (Transition *t)
const std::string	printTransitions (std::list< Transition * > &transitions)
const std::string	printTargetState (Transition *transitions)
const std::string	printTargetStates (std::list< Transition * > &transitions)
const std::string	printActions (std::list< Action * > &actions)
const std::string	printActivities (std::list< Activity * > &activities)
const std::string	printStates (State *s)
const std::string	printStateMachine (StateMachine &)
const std::string	formatStatus (std::set< State * > &status, const bool usefullyqualified=false)
bool	compareStateDocOrder (State *s1, State *s2)
void	sortAtomicStates (std::set< State * > &status, std::vector< State * > &sortedStatus)
bool	isInState (const std::set< State * > &status, const std::list< std::string > &stateNames)
int	countParents (State *)
bool	isDescendant (State *, State *)
std::set< State * >	getAncestors (std::list< State * > &states)
std::list< State * >	getAncestorsList (std::set< State * > &states)
std::set< State * >	getAncestors (State *)
std::list< State * >	getAncestorsList (State *)
std::list< State * >	getProperAncestors (State *, State *)
State *	findLeastCommonAncestor (State *, State *)
bool	eventMatch (const Event &, const Event &)
std::list< State * >	getAtomicStates (std::set< State * > &states)
std::list< State * >	getAtomicStates (std::list< State * > &states)
bool	isPreempted (State *, std::list< Transition * > &transitions)

Constructor & Destructor Documentation

Helper() [1/3]

Helper::Helper

(

)

~Helper() [1/3]

Helper::~Helper

(

)

Helper() [2/3]

scxml4cpp::Helper::Helper

(

)

~Helper() [2/3]

scxml4cpp::Helper::~Helper

(

)

Helper() [3/3]

scxml4cpp::Helper::Helper

(

)

~Helper() [3/3]

scxml4cpp::Helper::~Helper

(

)

Member Function Documentation

compareStateDocOrder() [1/3]

bool Helper::compareStateDocOrder	(	State *	s1,
		State *	s2
	)

Compare the position of states in the model: s1 < s2 if s1 appears in the model before s2.

This practically means that, in the list of substates maintained by the common ancestor, s1 is positioned before s2.

A nullptr is considered to be always before a non-null state.

Parameters

s1	First state to compare
s2	Second state to compare

Returns

true if s1 < s2, false otherwise

0 if s1 == s2, -1 if s1 < s2, +1 if s1 > s2

compareStateDocOrder() [2/3]

bool scxml4cpp::Helper::compareStateDocOrder	(	State *	s1,
		State *	s2
	)

compareStateDocOrder() [3/3]

bool scxml4cpp::Helper::compareStateDocOrder	(	State *	s1,
		State *	s2
	)

countParents() [1/3]

int Helper::countParents

(

State *

s

)

This method is used by the StateComparator class to provide a way to compare states based on the number of parents (i.e. level in the state composition tree).

Returns

0 in case of nullptr, 1 in case the state has no parents, or (1 + the number of parents).

countParents() [2/3]

int scxml4cpp::Helper::countParents

(

State *

)

countParents() [3/3]

int scxml4cpp::Helper::countParents

(

State *

)

eventMatch() [1/3]

bool Helper::eventMatch	(	const Event &	e1,
		const Event &	e2
	)

eventMatch() [2/3]

bool scxml4cpp::Helper::eventMatch	(	const Event &	,
		const Event &
	)

eventMatch() [3/3]

bool scxml4cpp::Helper::eventMatch	(	const Event &	,
		const Event &
	)

findLeastCommonAncestor() [1/3]

State * Helper::findLeastCommonAncestor	(	State *	s1,
		State *	s2
	)

findLeastCommonAncestor() [2/3]

State* scxml4cpp::Helper::findLeastCommonAncestor	(	State *	,
		State *
	)

findLeastCommonAncestor() [3/3]

State* scxml4cpp::Helper::findLeastCommonAncestor	(	State *	,
		State *
	)

formatStatus() [1/3]

const std::string Helper::formatStatus	(	std::set< State * > &	status,
		const bool	usefullyqualified = false
	)

formatStatus() [2/3]

const std::string scxml4cpp::Helper::formatStatus	(	std::set< State * > &	status,
		const bool	usefullyqualified = false
	)

formatStatus() [3/3]

const std::string scxml4cpp::Helper::formatStatus	(	std::set< State * > &	status,
		const bool	usefullyqualified = false
	)

getAncestors() [1/6]

std::set< State * > Helper::getAncestors

(

State *

state

)

getAncestors() [2/6]

std::set<State*> scxml4cpp::Helper::getAncestors

(

State *

)

getAncestors() [3/6]

std::set<State*> scxml4cpp::Helper::getAncestors

(

State *

)

getAncestors() [4/6]

std::set< State * > Helper::getAncestors

(

std::list< State * > &

states

)

getAncestors() [5/6]

std::set<State*> scxml4cpp::Helper::getAncestors

(

std::list< State * > &

states

)

getAncestors() [6/6]

std::set<State*> scxml4cpp::Helper::getAncestors

(

std::list< State * > &

states

)

getAncestorsList() [1/6]

std::list< State * > Helper::getAncestorsList

(

State *

state

)

getAncestorsList() [2/6]

std::list<State*> scxml4cpp::Helper::getAncestorsList

(

State *

)

getAncestorsList() [3/6]

std::list<State*> scxml4cpp::Helper::getAncestorsList

(

State *

)

getAncestorsList() [4/6]

std::list< State * > Helper::getAncestorsList

(

std::set< State * > &

states

)

getAncestorsList() [5/6]

std::list<State*> scxml4cpp::Helper::getAncestorsList

(

std::set< State * > &

states

)

getAncestorsList() [6/6]

std::list<State*> scxml4cpp::Helper::getAncestorsList

(

std::set< State * > &

states

)

getAtomicStates() [1/6]

std::list< State * > Helper::getAtomicStates

(

std::list< State * > &

states

)

getAtomicStates() [2/6]

std::list<State*> scxml4cpp::Helper::getAtomicStates

(

std::list< State * > &

states

)

getAtomicStates() [3/6]

std::list<State*> scxml4cpp::Helper::getAtomicStates

(

std::list< State * > &

states

)

getAtomicStates() [4/6]

std::list< State * > Helper::getAtomicStates

(

std::set< State * > &

states

)

getAtomicStates() [5/6]

std::list<State*> scxml4cpp::Helper::getAtomicStates

(

std::set< State * > &

states

)

getAtomicStates() [6/6]

std::list<State*> scxml4cpp::Helper::getAtomicStates

(

std::set< State * > &

states

)

getProperAncestors() [1/3]

std::list< State * > Helper::getProperAncestors	(	State *	state,
		State *	upperBound
	)

getProperAncestors() [2/3]

std::list<State*> scxml4cpp::Helper::getProperAncestors	(	State *	,
		State *
	)

getProperAncestors() [3/3]

std::list<State*> scxml4cpp::Helper::getProperAncestors	(	State *	,
		State *
	)

isDescendant() [1/3]

bool Helper::isDescendant	(	State *	s,
		State *	p
	)

isDescendant() [2/3]

bool scxml4cpp::Helper::isDescendant	(	State *	,
		State *
	)

isDescendant() [3/3]

bool scxml4cpp::Helper::isDescendant	(	State *	,
		State *
	)

isInState() [1/3]

bool Helper::isInState	(	const std::set< State * > &	status,
		const std::list< std::string > &	stateNames
	)

isInState() [2/3]

bool scxml4cpp::Helper::isInState	(	const std::set< State * > &	status,
		const std::list< std::string > &	stateNames
	)

isInState() [3/3]

bool scxml4cpp::Helper::isInState	(	const std::set< State * > &	status,
		const std::list< std::string > &	stateNames
	)

isPreempted() [1/3]

bool Helper::isPreempted	(	State *	s,
		std::list< Transition * > &	transitions
	)

isPreempted() [2/3]

bool scxml4cpp::Helper::isPreempted	(	State *	,
		std::list< Transition * > &	transitions
	)

isPreempted() [3/3]

bool scxml4cpp::Helper::isPreempted	(	State *	,
		std::list< Transition * > &	transitions
	)

printActions() [1/3]

const std::string Helper::printActions

(

std::list< Action * > &

actions

)

printActions() [2/3]

const std::string scxml4cpp::Helper::printActions

(

std::list< Action * > &

actions

)

printActions() [3/3]

const std::string scxml4cpp::Helper::printActions

(

std::list< Action * > &

actions

)

printActivities() [1/3]

const std::string Helper::printActivities

(

std::list< Activity * > &

activities

)

printActivities() [2/3]

const std::string scxml4cpp::Helper::printActivities

(

std::list< Activity * > &

activities

)

printActivities() [3/3]

const std::string scxml4cpp::Helper::printActivities

(

std::list< Activity * > &

activities

)

printStateMachine() [1/3]

const std::string Helper::printStateMachine

(

StateMachine &

sm

)

printStateMachine() [2/3]

const std::string scxml4cpp::Helper::printStateMachine

(

StateMachine &

)

printStateMachine() [3/3]

const std::string scxml4cpp::Helper::printStateMachine

(

StateMachine &

)

printStates() [1/3]

const std::string Helper::printStates

(

State *

s

)

printStates() [2/3]

const std::string scxml4cpp::Helper::printStates

(

State *

s

)

printStates() [3/3]

const std::string scxml4cpp::Helper::printStates

(

State *

s

)

printStateType() [1/3]

const std::string Helper::printStateType

(

State *

s

)

printStateType() [2/3]

const std::string scxml4cpp::Helper::printStateType

(

State *

s

)

printStateType() [3/3]

const std::string scxml4cpp::Helper::printStateType

(

State *

s

)

printTargetState() [1/3]

const std::string Helper::printTargetState

(

Transition *

transitions

)

printTargetState() [2/3]

const std::string scxml4cpp::Helper::printTargetState

(

Transition *

transitions

)

printTargetState() [3/3]

const std::string scxml4cpp::Helper::printTargetState

(

Transition *

transitions

)

printTargetStates() [1/3]

const std::string Helper::printTargetStates

(

std::list< Transition * > &

transitions

)

printTargetStates() [2/3]

const std::string scxml4cpp::Helper::printTargetStates

(

std::list< Transition * > &

transitions

)

printTargetStates() [3/3]

const std::string scxml4cpp::Helper::printTargetStates

(

std::list< Transition * > &

transitions

)

printTransition() [1/3]

const std::string Helper::printTransition

(

Transition *

t

)

printTransition() [2/3]

const std::string scxml4cpp::Helper::printTransition

(

Transition *

t

)

printTransition() [3/3]

const std::string scxml4cpp::Helper::printTransition

(

Transition *

t

)

printTransitions() [1/3]

const std::string Helper::printTransitions

(

std::list< Transition * > &

transitions

)

printTransitions() [2/3]

const std::string scxml4cpp::Helper::printTransitions

(

std::list< Transition * > &

transitions

)

printTransitions() [3/3]

const std::string scxml4cpp::Helper::printTransitions

(

std::list< Transition * > &

transitions

)

sortAtomicStates() [1/3]

void Helper::sortAtomicStates	(	std::set< State * > &	status,
		std::vector< State * > &	sortedStatus
	)

sortAtomicStates() [2/3]

void scxml4cpp::Helper::sortAtomicStates	(	std::set< State * > &	status,
		std::vector< State * > &	sortedStatus
	)

sortAtomicStates() [3/3]

void scxml4cpp::Helper::sortAtomicStates	(	std::set< State * > &	status,
		std::vector< State * > &	sortedStatus
	)

---

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

• INTROOT/include/scxml4cpp/Helper.h
• INTROOT/sources/scxml4cpp/engine/src/Helper.cpp