RTT::scripting::CmdCollectCondition Struct Reference

A DataSource that collects the result of a CmdFunction. More...

#include <rtt/scripting/CmdFunction.hpp>

Inheritance diagram for RTT::scripting::CmdCollectCondition:

Public Member Functions
	CmdCollectCondition (DataSource< SendStatus >::shared_ptr ds)
void	reset ()
	Some conditions need to be reset at some points. More...
bool	evaluate ()
	Evaluate the Condition and return the outcome. More...
virtual CmdCollectCondition *	clone () const
	The Clone Software Pattern. More...
virtual CmdCollectCondition *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
	When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More...

Public Attributes
DataSource< SendStatus >::shared_ptr	collectds

Detailed Description

A DataSource that collects the result of a CmdFunction.

Definition at line 131 of file CmdFunction.hpp.

Constructor & Destructor Documentation

RTT::scripting::CmdCollectCondition::CmdCollectCondition ( DataSource< SendStatus >::shared_ptr  ds )

inline

Definition at line 137 of file CmdFunction.hpp.

Member Function Documentation

virtual CmdCollectCondition* RTT::scripting::CmdCollectCondition::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 152 of file CmdFunction.hpp.

virtual CmdCollectCondition* RTT::scripting::CmdCollectCondition::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned ) const

inlinevirtual

When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly.

This is different from the clone function, where we simply want a new Command that can replace the old one directly.

This function takes a map that maps the old internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::DataSource, whether it has already been copied, and if so, reuse the existing copy.

To keep old source working, the standard implementation of this function simply calls the clone function. If your ConditionInterface uses a internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::scripting::ConditionInterface.

Definition at line 156 of file CmdFunction.hpp.

References RTT::internal::DataSource< T >::copy().

bool RTT::scripting::CmdCollectCondition::evaluate ( )

inlinevirtual

Evaluate the Condition and return the outcome.

Returns

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 144 of file CmdFunction.hpp.

References RTT::internal::DataSource< T >::rvalue(), and RTT::SendNotReady.

void RTT::scripting::CmdCollectCondition::reset ( )

inlinevirtual

Some conditions need to be reset at some points.

E.g. a scripting::ConditionDuration counts the time since the first time a Command was executed, and if this time exceeds a certain preset time, returns true. Therefore, it needs to be reset, i.e. it needs to start counting, when the command is first executed.. scripting::ConditionOnce has a similar need. This function is called at such times.

Reimplemented from RTT::scripting::ConditionInterface.

Definition at line 142 of file CmdFunction.hpp.

Member Data Documentation

DataSource<SendStatus>::shared_ptr RTT::scripting::CmdCollectCondition::collectds

Definition at line 134 of file CmdFunction.hpp.

---

The documentation for this struct was generated from the following file:

• rtt/scripting/CmdFunction.hpp