RTT::StateDescription Class Reference

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

#include <rtt/StateDescription.hpp>

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

List of all members.

Public Member Functions

 StateDescription (const std::string &_name, ProgramProcessor *pproc, int linenr)
 Construct a new State with entry, exit and handle nodes.
const std::string & getName () const
 Get the name of this state.
void setName (const std::string &newname)
void setEntryPoint (int line)
int getEntryPoint () const
 Get the beginning definition of this State.
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.
ProgramInterfacegetEntryProgram () const
 Get the entry program of this State.
ProgramInterfacegetRunProgram () const
 Get the run program of this State.
ProgramInterfacegetHandleProgram () const
 Get the handle program of this State.
ProgramInterfacegetExitProgram () const
 Get the exit program of this State.
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 DataSourceBase *, DataSourceBase * > &replacementdss) const

Detailed Description

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

Definition at line 47 of file StateDescription.hpp.


Constructor & Destructor Documentation

RTT::StateDescription::StateDescription ( const std::string &  _name,
ProgramProcessor pproc,
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 56 of file StateDescription.hpp.


Member Function Documentation

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.

The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:22:44 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3