RTT::scripting::StateDescription Class Reference

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

#include <StateDescription.hpp>

Inheritance diagram for RTT::scripting::StateDescription:
Inheritance graph
[legend]

List of all members.

Public Member Functions

StateDescription * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replacementdss) const
StateDescription * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replacementdss) const
int getEntryPoint () const
int getEntryPoint () const
ProgramInterface * getEntryProgram () const
ProgramInterface * getEntryProgram () const
ProgramInterface * getExitProgram () const
ProgramInterface * getExitProgram () const
ProgramInterface * getHandleProgram () const
ProgramInterface * getHandleProgram () const
const std::string & getName () const
 Get the name of this state.
const std::string & getName () const
 Get the name of this state.
ProgramInterface * getRunProgram () const
ProgramInterface * getRunProgram () const
bool isDefined () const
bool isDefined () const
StateDescription * postponeState ()
StateDescription * postponeState ()
void setDefined (bool d)
void setDefined (bool d)
void setEntryPoint (int line)
void setEntryPoint (int line)
void setEntryProgram (ProgramInterfacePtr entry)
void setEntryProgram (ProgramInterfacePtr entry)
void setExitProgram (ProgramInterfacePtr exit)
void setExitProgram (ProgramInterfacePtr exit)
void setHandleProgram (ProgramInterfacePtr handle)
void setHandleProgram (ProgramInterfacePtr handle)
void setName (const std::string &newname)
void setName (const std::string &newname)
void setRunProgram (ProgramInterfacePtr run)
void setRunProgram (ProgramInterfacePtr run)
 StateDescription (const std::string &_name, int linenr)
 StateDescription (const std::string &_name, int linenr)
virtual ~StateDescription ()
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 install/include/rtt/scripting/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 install/include/rtt/scripting/StateDescription.hpp.

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

Definition at line 57 of file StateDescription.cpp.

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 rtt/scripting/StateDescription.hpp.

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

Member Function Documentation

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

Implements RTT::scripting::StateInterface.

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

Implements RTT::scripting::StateInterface.

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 rtt/scripting/StateDescription.hpp.

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 install/include/rtt/scripting/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 rtt/scripting/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 install/include/rtt/scripting/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 rtt/scripting/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 install/include/rtt/scripting/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 rtt/scripting/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 install/include/rtt/scripting/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 rtt/scripting/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 install/include/rtt/scripting/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 rtt/scripting/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 install/include/rtt/scripting/StateDescription.hpp.

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

Definition at line 125 of file rtt/scripting/StateDescription.hpp.

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

Definition at line 125 of file install/include/rtt/scripting/StateDescription.hpp.

StateDescription* RTT::scripting::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.
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.

void RTT::scripting::StateDescription::setDefined ( bool  d  )  [inline]

Definition at line 130 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setDefined ( bool  d  )  [inline]

Definition at line 130 of file install/include/rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setEntryPoint ( int  line  )  [inline]

Definition at line 77 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setEntryPoint ( int  line  )  [inline]

Definition at line 77 of file install/include/rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setEntryProgram ( ProgramInterfacePtr  entry  )  [inline]

Definition at line 109 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setEntryProgram ( ProgramInterfacePtr  entry  )  [inline]

Definition at line 109 of file install/include/rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setExitProgram ( ProgramInterfacePtr  exit  )  [inline]

Definition at line 121 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setExitProgram ( ProgramInterfacePtr  exit  )  [inline]

Definition at line 121 of file install/include/rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setHandleProgram ( ProgramInterfacePtr  handle  )  [inline]

Definition at line 117 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setHandleProgram ( ProgramInterfacePtr  handle  )  [inline]

Definition at line 117 of file install/include/rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setName ( const std::string &  newname  )  [inline]

Definition at line 75 of file rtt/scripting/StateDescription.hpp.

void RTT::scripting::StateDescription::setName ( const std::string &  newname  )  [inline]

Definition at line 75 of file install/include/rtt/scripting/StateDescription.hpp.

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

Definition at line 113 of file rtt/scripting/StateDescription.hpp.

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

Definition at line 113 of file install/include/rtt/scripting/StateDescription.hpp.

Member Data Documentation

int RTT::scripting::StateDescription::entrypoint [private]

Definition at line 59 of file install/include/rtt/scripting/StateDescription.hpp.

bool RTT::scripting::StateDescription::inited [private]

Definition at line 60 of file install/include/rtt/scripting/StateDescription.hpp.

ProgramInterfacePtr RTT::scripting::StateDescription::mentry [private]

Definition at line 54 of file install/include/rtt/scripting/StateDescription.hpp.

ProgramInterfacePtr RTT::scripting::StateDescription::mexit [private]

Definition at line 55 of file install/include/rtt/scripting/StateDescription.hpp.

ProgramInterfacePtr RTT::scripting::StateDescription::mhandle [private]

Definition at line 56 of file install/include/rtt/scripting/StateDescription.hpp.

ProgramInterfacePtr RTT::scripting::StateDescription::mrun [private]

Definition at line 57 of file install/include/rtt/scripting/StateDescription.hpp.

std::string RTT::scripting::StateDescription::name [private]

Definition at line 58 of file install/include/rtt/scripting/StateDescription.hpp.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:16 2013