This class represents a state with all actions stored in an external program. More...

#include <StateDescription.hpp>

Inheritance diagram for RTT::scripting::StateDescription:

Public Member Functions
StateDescription *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &replacementdss) const
int	getEntryPoint () const
ProgramInterface *	getEntryProgram () const
ProgramInterface *	getExitProgram () const
ProgramInterface *	getHandleProgram () const
const std::string &	getName () const
	Get the name of this state.
ProgramInterface *	getRunProgram () const
bool	isDefined () const
StateDescription *	postponeState ()
void	setDefined (bool d)
void	setEntryPoint (int line)
void	setEntryProgram (ProgramInterfacePtr entry)
void	setExitProgram (ProgramInterfacePtr exit)
void	setHandleProgram (ProgramInterfacePtr handle)
void	setName (const std::string &newname)
void	setRunProgram (ProgramInterfacePtr run)
	StateDescription (const std::string &_name, int linenr)
virtual	~StateDescription ()
Private Attributes
int	entrypoint
bool	inited
ProgramInterfacePtr	mentry
ProgramInterfacePtr	mexit
ProgramInterfacePtr	mhandle
ProgramInterfacePtr	mrun
std::string	name

Detailed Description

This class represents a state with all actions stored in an external program.

Definition at line 51 of file StateDescription.hpp.

Constructor & Destructor Documentation

RTT::scripting::StateDescription::StateDescription	(	const std::string &	_name,
		int	linenr
	)		`[inline]`

Construct a new State with entry, exit and handle nodes. The StateGraph owning the nodes is needed for processing each state.

Definition at line 66 of file StateDescription.hpp.

RTT::StateDescription::~StateDescription ( ) [virtual]

Definition at line 57 of file StateDescription.cpp.

Member Function Documentation

StateDescription * RTT::StateDescription::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > & replacementdss ) const [virtual]

Implements RTT::scripting::StateInterface.

Definition at line 60 of file StateDescription.cpp.

int RTT::scripting::StateDescription::getEntryPoint ( ) const [inline, virtual]

Get the beginning definition of this State.

Implements RTT::scripting::StateInterface.

Definition at line 78 of file StateDescription.hpp.

ProgramInterface* RTT::scripting::StateDescription::getEntryProgram ( ) const [inline, virtual]

Get the entry program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 93 of file StateDescription.hpp.

ProgramInterface* RTT::scripting::StateDescription::getExitProgram ( ) const [inline, virtual]

Get the exit program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 105 of file StateDescription.hpp.

ProgramInterface* RTT::scripting::StateDescription::getHandleProgram ( ) const [inline, virtual]

Get the handle program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 101 of file StateDescription.hpp.

const std::string& RTT::scripting::StateDescription::getName ( ) const [inline, virtual]

Get the name of this state.

Implements RTT::scripting::StateInterface.

Definition at line 74 of file StateDescription.hpp.

ProgramInterface* RTT::scripting::StateDescription::getRunProgram ( ) const [inline, virtual]

Get the run program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 97 of file StateDescription.hpp.

bool RTT::scripting::StateDescription::isDefined ( ) const [inline]

Definition at line 125 of file StateDescription.hpp.

StateDescription * RTT::StateDescription::postponeState ( )

This function returns a new state that contains all the data of this state ( its handle, entry, exit programs, and its name and inited state ), while this state's data is reset ( i.e. its handle, entry, exit programs are set to null, its name is cleared, and it is set to not inited ). This is used by the parser when it suddenly notices that it needs to insert a dummy state before the current to check preconditions.