RTT::scripting::ConditionInterface Class Reference

This interface represents the concept of a condition which can be evaluated and return true or false. More...

#include <ConditionInterface.hpp>

Inheritance diagram for RTT::scripting::ConditionInterface:

Public Member Functions
virtual ConditionInterface *	clone () const =0
virtual ConditionInterface *	clone () const =0
virtual ConditionInterface *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
virtual ConditionInterface *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
virtual bool	evaluate ()=0
	Evaluate the Condition and return the outcome.
virtual bool	evaluate ()=0
	Evaluate the Condition and return the outcome.
virtual void	reset ()
virtual void	reset ()
virtual	~ConditionInterface ()
virtual	~ConditionInterface ()

Detailed Description

This interface represents the concept of a condition which can be evaluated and return true or false.

Todo:: This class is a light-weight implementation of a internal::DataSource<bool>. It may be profitable to remove this low level class and replace its use by internal::DataSource<bool>. That would also cause the removal of most Condition* classes.

Todo:: This class is a light-weight implementation of a internal::DataSource<bool>. It may be profitable to remove this low level class and replace its use by internal::DataSource<bool>. That would also cause the removal of most Condition* classes.

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

Constructor & Destructor Documentation

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

Definition at line 44 of file ConditionInterface.cpp.

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

Member Function Documentation

virtual ConditionInterface* RTT::scripting::ConditionInterface::clone ( ) const [pure virtual]

The Clone Software Pattern.

virtual ConditionInterface* RTT::scripting::ConditionInterface::clone ( ) const [pure virtual]

The Clone Software Pattern.

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

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.

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

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.

virtual bool RTT::scripting::ConditionInterface::evaluate ( ) [pure virtual]

Evaluate the Condition and return the outcome.

Returns:: true if the condition is satisfied, false otherwise.

virtual bool RTT::scripting::ConditionInterface::evaluate ( ) [pure virtual]

Evaluate the Condition and return the outcome.

Returns:: true if the condition is satisfied, false otherwise.

virtual void RTT::scripting::ConditionInterface::reset ( ) [virtual]

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.

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

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.

Definition at line 47 of file ConditionInterface.cpp.

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

RTT::scripting::ConditionInterface Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation