#include <FunctionGraph.hpp>

Inheritance diagram for RTT::scripting::FunctionGraph:

Public Types
typedef boost::graph_traits < Graph >::edge_descriptor	Edge
typedef EdgeCondition::EdgeProperty	EdgeProperty
typedef boost::adjacency_list < boost::vecS, boost::listS, boost::directedS, VertProperty, EdgeProperty >	Graph
typedef boost::graph_traits < Graph >::vertex_descriptor	Vertex
typedef VertexNode::VertProperty	VertProperty
Public Member Functions
void	addArgument (base::AttributeBase *a)
void	clearArguments ()
virtual FunctionGraph *	clone () const
virtual FunctionGraph *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &replacementdss) const
Vertex	currentNode () const
void	debugPrintout () const
virtual bool	execute ()
Vertex	exitNode () const
void	finish ()
	FunctionGraph (const std::string &name, bool unload_on_stop)
	FunctionGraph (const FunctionGraph &orig)
std::vector < base::AttributeBase * >	getArguments () const
const Graph &	getGraph () const
Graph &	getGraph ()
virtual int	getLineNumber () const
virtual const std::string &	getName () const
base::AttributeBase *	getResult () const
std::string	getText () const
virtual void	loading ()
virtual bool	needsStart () const
virtual bool	pause ()
Vertex	previousNode () const
virtual void	reset ()
void	setName (const std::string &_name)
void	setProgramService (ServicePtr myservice)
void	setResult (base::AttributeBase *r)
void	setText (const std::string &t)
void	setUnloadOnStop (bool unload_on_stop)
virtual bool	start ()
Vertex	startNode () const
virtual bool	step ()
virtual bool	stepDone () const
virtual bool	stop ()
virtual void	unloading ()
	~FunctionGraph ()
Protected Member Functions
bool	executeStep ()
bool	executeUntil ()
Protected Attributes
std::string	_text
std::vector < base::AttributeBase * >	args
ServicePtr	context
Vertex	exitv
bool	mstep
bool	munload_on_stop
std::string	myName
bool	pausing
Graph	program
base::AttributeBase *	retn
Vertex	startv
Private Attributes
Vertex	current
Vertex	previous

Detailed Description

This class represents a function. It has much in common with a program but is only used for storing a Graph.

Definition at line 59 of file FunctionGraph.hpp.

Member Typedef Documentation

typedef boost::graph_traits<Graph>::edge_descriptor RTT::scripting::FunctionGraph::Edge

Definition at line 72 of file FunctionGraph.hpp.

typedef EdgeCondition::EdgeProperty RTT::scripting::FunctionGraph::EdgeProperty

Definition at line 63 of file FunctionGraph.hpp.

typedef boost::adjacency_list<boost::vecS, boost::listS, boost::directedS, VertProperty, EdgeProperty> RTT::scripting::FunctionGraph::Graph

Definition at line 70 of file FunctionGraph.hpp.

typedef boost::graph_traits<Graph>::vertex_descriptor RTT::scripting::FunctionGraph::Vertex

Definition at line 71 of file FunctionGraph.hpp.

typedef VertexNode::VertProperty RTT::scripting::FunctionGraph::VertProperty

Definition at line 64 of file FunctionGraph.hpp.

Constructor & Destructor Documentation

RTT::FunctionGraph::FunctionGraph	(	const std::string &	name,
		bool	unload_on_stop
	)

Create a FunctionGraph with a given name.

Parameters:

name The name of this script.

unload_on_stop Set to true to force an unload when the script stops or an error is encountered. The unload is forced by returning false in execute(), as defined in the ExecutableInterface. This flag should only be set to true for scripts that don't have a service associated (see setProgramService() ), since the service is destroyed when the function is unloaded. You can override this behavior after construction by using setUnloadOnStop().

Definition at line 59 of file FunctionGraph.cpp.

RTT::FunctionGraph::FunctionGraph ( const FunctionGraph & orig )

Copy a FunctionGraph.

Definition at line 69 of file FunctionGraph.cpp.

RTT::FunctionGraph::~FunctionGraph ( )

Definition at line 114 of file FunctionGraph.cpp.

Member Function Documentation

void RTT::scripting::FunctionGraph::addArgument ( base::AttributeBase * a ) [inline]

Definition at line 248 of file FunctionGraph.hpp.

void RTT::FunctionGraph::clearArguments ( )

Clear the arguments vector and release all base::AttributeBase resources.

Definition at line 459 of file FunctionGraph.cpp.

FunctionGraph * RTT::FunctionGraph::clone ( ) const [virtual]

Implements RTT::scripting::ProgramInterface.

Definition at line 432 of file FunctionGraph.cpp.

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

Clone this Program. This will produce a completely new instance, that has nothing in common with this one. It takes care to properly map identical DataSources to identical DataSources.

Parameters:

alreadyMappedData A map of some DataSources used in this program to new DataSources that should replace them in the new Program. This is provided, because in some cases the outside world also keeps references to datasources used somewhere in this programgraph. It is then important that when this Program is copied, the outside world has a way to get a reference to the corresponding datasources in the new program. We do this by allowing it to map some datasources itself, and simply provide us a list of its mappings.

Implements RTT::scripting::ProgramInterface.

Definition at line 383 of file FunctionGraph.cpp.

Vertex RTT::scripting::FunctionGraph::currentNode ( ) const [inline]

Definition at line 212 of file FunctionGraph.hpp.

void RTT::FunctionGraph::debugPrintout ( ) const

Definition at line 437 of file FunctionGraph.cpp.

bool RTT::FunctionGraph::execute ( ) [virtual]

Execute as much actions until the program needs to wait on a condition to become true. When paused, only execute one action.

Returns:: false if a program error occured.

Implements RTT::scripting::ProgramInterface.

Definition at line 199 of file FunctionGraph.cpp.

bool RTT::FunctionGraph::executeStep ( ) [protected]

Definition at line 290 of file FunctionGraph.cpp.

bool RTT::FunctionGraph::executeUntil ( ) [protected]

Definition at line 228 of file FunctionGraph.cpp.

Vertex RTT::scripting::FunctionGraph::exitNode ( ) const [inline]

Definition at line 222 of file FunctionGraph.hpp.

void RTT::FunctionGraph::finish ( )

To be called after a function is constructed.

Definition at line 94 of file FunctionGraph.cpp.

std::vector<base::AttributeBase*> RTT::scripting::FunctionGraph::getArguments ( ) const [inline, virtual]

Return an ordered list of this funcion's arguments.

Implements RTT::scripting::ProgramInterface.

Definition at line 240 of file FunctionGraph.hpp.

const Graph& RTT::scripting::FunctionGraph::getGraph ( ) const [inline]

Definition at line 227 of file FunctionGraph.hpp.

Graph& RTT::scripting::FunctionGraph::getGraph ( ) [inline]

Definition at line 232 of file FunctionGraph.hpp.

int RTT::FunctionGraph::getLineNumber ( ) const [virtual]

Return the current 'line number' of the program.

Implements RTT::scripting::ProgramInterface.

Definition at line 378 of file FunctionGraph.cpp.

const std::string & RTT::FunctionGraph::getName ( ) const [virtual]

Programs can be refered to by name.

Implements RTT::scripting::ProgramInterface.

Definition at line 358 of file FunctionGraph.cpp.

base::AttributeBase* RTT::scripting::FunctionGraph::getResult ( ) const [inline, virtual]

Get the return value of this program.

Implements RTT::scripting::ProgramInterface.

Definition at line 244 of file FunctionGraph.hpp.

std::string RTT::FunctionGraph::getText ( ) const [virtual]

Return the program text to which getLineNumber() refers.

Implements RTT::scripting::ProgramInterface.

Definition at line 368 of file FunctionGraph.cpp.

void RTT::FunctionGraph::loading ( ) [virtual]

Informs this object that it got loaded in an ExecutionEngine. Called by load() after the engine pointer is set.

Reimplemented from RTT::base::ExecutableInterface.

Definition at line 136 of file FunctionGraph.cpp.

virtual bool RTT::scripting::FunctionGraph::needsStart ( ) const [inline, virtual]

Returns true if a start() is necessary when this function is loaded with ExecutionEngine::runFunction(). Functions that unload_on_stop == true don't need to be started since they will start themselves when loaded in the EE.

Implements RTT::scripting::ProgramInterface.

Definition at line 156 of file FunctionGraph.hpp.

bool RTT::FunctionGraph::pause ( ) [virtual]

Pause or start-and-pause the execution of this program.

Implements RTT::scripting::ProgramInterface.

Definition at line 173 of file FunctionGraph.cpp.

Vertex RTT::scripting::FunctionGraph::previousNode ( ) const [inline]

Definition at line 217 of file FunctionGraph.hpp.

void RTT::FunctionGraph::reset ( ) [virtual]

Identical to stop();

Implements RTT::scripting::ProgramInterface.

Definition at line 345 of file FunctionGraph.cpp.