This is a brief description. More...

#include <State.h>

Public Member Functions
	State ()

virtual	~State ()

std::string	getName () const
	Accessor to get the value of name. More...

bool	setName (std::string name)
	Accessor to set value of name. More...

bool	isStartingState () const
	Accessor to get the value of startingState. More...

bool	setStartingState (bool startingState)
	Accessor to set value of startingState. More...

std::string	getServiceName () const
	Accessor to get the value of serviceName. More...

bool	setServiceName (std::string serviceName)
	Accessor to set value of serviceName. More...

const std::vector< StateMachine *> &	getStateMachines () const
	Accessor to get the value of stateMachines. More...

bool	setStateMachines (const StateMachine &stateMachines)
	Accessor to set value of stateMachines. More...

const std::vector< Transition *> &	getTransitions () const
	Accessor to get the value of transitions. More...

bool	setTransitions (const Transition &transitions)
	Accessor to set value of transitions. More...

std::vector< Action >	getEntryActions () const
	Accessor to get the value of entryActions. More...

bool	setEntryActions (Action *entryActions)
	Accessor to set value of entryActions. More...

std::vector< Action >	getExitActions () const
	Accessor to get the value of exitActions. More...

bool	setExitActions (Action *exitActions)
	Accessor to set value of exitActions. More...

StateMachine *	getParentStateMachine () const
	Accessor to get the value of parentStateMachine. More...

bool	setParentStateMachine (StateMachine *parentStateMachine)
	Accessor to set value of parentStateMachine. More...

Transition *	getLoop () const
	Accessor to get the value of loop. More...

bool	setLoop (Transition *loop)
	Accessor to set value of loop. More...

virtual Transition *	processTrigger (Trigger *trigger)

StateMachine	getStateMachine (std::string stateMachineName)
	Operation getStateMachine. More...

int	addStateMachine (StateMachine &stateMachine)
	Operation addStateMachine. More...

int	addTransition (Transition &transition)
	Operation addTransition. More...

int	removeTransition (Transition &transition)
	Operation removeTransition. More...

Message *	getResponse (Trigger *trigger)

void	entry ()
	Operation entry. More...

void	exit ()
	Operation exit. More...

std::string	getQualifiedName ()
	Operation getQualifiedName. More...

virtual std::string	toString () const

template<class C >
void	addEntryAction (void(C::fp)(), C object)

template<class C >
void	addExitAction (void(C::fp)(), C object)

Protected Attributes
std::string	name

bool	startingState

std::string	serviceName

std::vector< StateMachine *>	stateMachines

std::vector< Transition *>	transitions

std::vector< Action >	entryActions

std::vector< Action >	exitActions

StateMachine *	parentStateMachine

Transition *	loop

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const State &object)

OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const State *object)

Detailed Description

Detailed description.

Author: Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

§ State()

openjaus::model::State::State ( )

§ ~State()

openjaus::model::State::~State ( )

virtual

Member Function Documentation

§ addEntryAction()

template<class C >

void openjaus::model::State::addEntryAction	(	void(C::*)()	fp,
		C *	object
	)

inline

§ addExitAction()

template<class C >

void openjaus::model::State::addExitAction	(	void(C::*)()	fp,
		C *	object
	)

inline

§ addStateMachine()

int openjaus::model::State::addStateMachine ( StateMachine & stateMachine )

Parameters

stateMachine

§ addTransition()

int openjaus::model::State::addTransition ( Transition & transition )

Parameters

transition

§ entry()

void openjaus::model::State::entry ( )

§ exit()

void openjaus::model::State::exit ( )

§ getEntryActions()

std::vector< Action *> * openjaus::model::State::getEntryActions ( ) const

§ getExitActions()

std::vector< Action *> * openjaus::model::State::getExitActions ( ) const

§ getLoop()

Transition * openjaus::model::State::getLoop ( ) const

§ getName()

std::string openjaus::model::State::getName ( void ) const

§ getParentStateMachine()

StateMachine * openjaus::model::State::getParentStateMachine ( ) const

§ getQualifiedName()

std::string openjaus::model::State::getQualifiedName ( )

§ getResponse()

Message * openjaus::model::State::getResponse ( Trigger * trigger )

Parameters

trigger

§ getServiceName()

std::string openjaus::model::State::getServiceName ( ) const

§ getStateMachine()

StateMachine openjaus::model::State::getStateMachine ( std::string stateMachineName )

Parameters

stateMachineName

§ getStateMachines()

const std::vector< StateMachine *> & openjaus::model::State::getStateMachines ( ) const

§ getTransitions()

const std::vector< Transition *> & openjaus::model::State::getTransitions ( ) const

§ isStartingState()

bool openjaus::model::State::isStartingState ( ) const

§ processTrigger()

Transition * openjaus::model::State::processTrigger ( Trigger * trigger )

virtual

Parameters

trigger

§ removeTransition()

int openjaus::model::State::removeTransition ( Transition & transition )

Parameters

transition

§ setEntryActions()

bool openjaus::model::State::setEntryActions ( Action * entryActions )

Parameters

entryActions The value of the new entryActions.

§ setExitActions()

bool openjaus::model::State::setExitActions ( Action * exitActions )

Parameters

exitActions The value of the new exitActions.

§ setLoop()

bool openjaus::model::State::setLoop ( Transition * loop )

Parameters

loop	The value of the new loop.

§ setName()

bool openjaus::model::State::setName ( std::string name )

Parameters

name	The value of the new name.

§ setParentStateMachine()

bool openjaus::model::State::setParentStateMachine ( StateMachine * parentStateMachine )

Parameters

parentStateMachine The value of the new parentStateMachine.

§ setServiceName()

bool openjaus::model::State::setServiceName ( std::string serviceName )

Parameters

serviceName The value of the new serviceName.

§ setStartingState()

bool openjaus::model::State::setStartingState ( bool startingState )

Parameters

startingState The value of the new startingState.

§ setStateMachines()

bool openjaus::model::State::setStateMachines ( const StateMachine & stateMachines )

Parameters

stateMachines The value of the new stateMachines.

§ setTransitions()

bool openjaus::model::State::setTransitions ( const Transition & transitions )

Parameters

transitions The value of the new transitions.

§ toString()

std::string openjaus::model::State::toString ( ) const

virtual

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<<	(	std::ostream &	output,
		const State &	object
	)

friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<<	(	std::ostream &	output,
		const State *	object
	)

friend

Member Data Documentation

§ entryActions

std::vector< Action* >* openjaus::model::State::entryActions

protected

§ exitActions

std::vector< Action* >* openjaus::model::State::exitActions

protected

§ loop

Transition* openjaus::model::State::loop

protected

§ name

std::string openjaus::model::State::name

protected

§ parentStateMachine

StateMachine* openjaus::model::State::parentStateMachine

protected

§ serviceName

std::string openjaus::model::State::serviceName

protected

§ startingState

bool openjaus::model::State::startingState

protected

§ stateMachines

std::vector< StateMachine* > openjaus::model::State::stateMachines

protected

§ transitions

std::vector< Transition* > openjaus::model::State::transitions

protected

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

include/openjaus/model/State.h
src/openjaus/model/State.cpp

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

§ State()

§ ~State()

Member Function Documentation

§ addEntryAction()

§ addExitAction()

§ addStateMachine()

§ addTransition()

§ entry()

§ exit()

§ getEntryActions()

§ getExitActions()

§ getLoop()

§ getName()

§ getParentStateMachine()

§ getQualifiedName()

§ getResponse()

§ getServiceName()

§ getStateMachine()

§ getStateMachines()

§ getTransitions()

§ isStartingState()

§ processTrigger()

§ removeTransition()

§ setEntryActions()

§ setExitActions()

§ setLoop()

§ setName()

§ setParentStateMachine()

§ setServiceName()

§ setStartingState()

§ setStateMachines()

§ setTransitions()

§ toString()

Friends And Related Function Documentation

§ operator<< [1/2]

§ operator<< [2/2]

Member Data Documentation

§ entryActions

§ exitActions

§ loop

§ name

§ parentStateMachine

§ serviceName

§ startingState

§ stateMachines

§ transitions