Orocos Real-Time Toolkit  2.9.0
Public Member Functions | List of all members
RTT::scripting::StateDescription Class Reference

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

#include <rtt/scripting/StateDescription.hpp>

Inheritance diagram for RTT::scripting::StateDescription:
RTT::scripting::StateInterface

Public Member Functions

 StateDescription (const std::string &_name, int linenr)
 Construct a new State with entry, exit and handle nodes. More...
 
virtual ~StateDescription ()
 
const std::string & getName () const
 Get the name of this state. More...
 
void setName (const std::string &newname)
 
void setEntryPoint (int line)
 
int getEntryPoint () const
 Get the beginning definition of this State. More...
 
StateDescriptionpostponeState ()
 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. More...
 
ProgramInterfacegetEntryProgram () const
 Get the entry program of this State. More...
 
ProgramInterfacegetRunProgram () const
 Get the run program of this State. More...
 
ProgramInterfacegetHandleProgram () const
 Get the handle program of this State. More...
 
ProgramInterfacegetExitProgram () const
 Get the exit program of this State. More...
 
void setEntryProgram (ProgramInterfacePtr entry)
 
void setRunProgram (ProgramInterfacePtr run)
 
void setHandleProgram (ProgramInterfacePtr handle)
 
void setExitProgram (ProgramInterfacePtr exit)
 
bool isDefined () const
 
void setDefined (bool d)
 
StateDescriptioncopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replacementdss) const
 
virtual void loaded (ExecutionEngine *ee)
 

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.

Referenced by copy(), and postponeState().

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
int RTT::scripting::StateDescription::getEntryPoint ( ) const
inlinevirtual

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
inlinevirtual

Get the entry program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 93 of file StateDescription.hpp.

Referenced by RTT::scripting::StateGraphParser::getParserResult().

ProgramInterface* RTT::scripting::StateDescription::getExitProgram ( ) const
inlinevirtual

Get the exit program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 105 of file StateDescription.hpp.

Referenced by RTT::scripting::StateGraphParser::getParserResult().

ProgramInterface* RTT::scripting::StateDescription::getHandleProgram ( ) const
inlinevirtual

Get the handle program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 101 of file StateDescription.hpp.

Referenced by RTT::scripting::StateGraphParser::getParserResult().

const std::string& RTT::scripting::StateDescription::getName ( ) const
inlinevirtual

Get the name of this state.

Implements RTT::scripting::StateInterface.

Definition at line 74 of file StateDescription.hpp.

Referenced by RTT::scripting::StateGraphParser::getParserResult(), and postponeState().

ProgramInterface* RTT::scripting::StateDescription::getRunProgram ( ) const
inlinevirtual

Get the run program of this State.

Implements RTT::scripting::StateInterface.

Definition at line 97 of file StateDescription.hpp.

Referenced by RTT::scripting::StateGraphParser::getParserResult().

bool RTT::scripting::StateDescription::isDefined ( ) const
inline
void StateInterface::loaded ( ExecutionEngine ee)
virtualinherited
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.

Deprecated:
by new precondition semantics.

Definition at line 45 of file StateDescription.cpp.

References getName(), isDefined(), setDefined(), setEntryProgram(), setExitProgram(), setHandleProgram(), setRunProgram(), and StateDescription().

Referenced by RTT::scripting::StateGraphParser::storeOffset().

void RTT::scripting::StateDescription::setDefined ( bool  d)
inline
void RTT::scripting::StateDescription::setEntryPoint ( int  line)
inline
void RTT::scripting::StateDescription::setEntryProgram ( ProgramInterfacePtr  entry)
inline
void RTT::scripting::StateDescription::setExitProgram ( ProgramInterfacePtr  exit)
inline
void RTT::scripting::StateDescription::setHandleProgram ( ProgramInterfacePtr  handle)
inline
void RTT::scripting::StateDescription::setName ( const std::string &  newname)
inline

Definition at line 75 of file StateDescription.hpp.

void RTT::scripting::StateDescription::setRunProgram ( ProgramInterfacePtr  run)
inline

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