RTT::scripting::ConditionBinaryCompositeOR Class Reference

#include <rtt/scripting/ConditionComposite.hpp>

Inheritance diagram for RTT::scripting::ConditionBinaryCompositeOR:

Public Member Functions
	ConditionBinaryCompositeOR (ConditionInterface *l, ConditionInterface *r)
	If l evaluates to true, evaluate and return the result, otherwise, return false. More...
virtual ConditionInterface *	clone () const
	The Clone Software Pattern. More...
ConditionBinaryCompositeOR *	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...
virtual	~ConditionBinaryCompositeOR ()
virtual bool	evaluate ()
	Evaluate the Condition and return the outcome. More...
virtual void	reset ()
	Some conditions need to be reset at some points. More...

Detailed Description

Definition at line 97 of file ConditionComposite.hpp.

Constructor & Destructor Documentation

RTT::scripting::ConditionBinaryCompositeOR::ConditionBinaryCompositeOR ( ConditionInterface *  l, ConditionInterface *  r  )

inline

If l evaluates to true, evaluate and return the result, otherwise, return false.

Constructor takes ownership of l and r.

Definition at line 108 of file ConditionComposite.hpp.

virtual RTT::scripting::ConditionBinaryCompositeOR::~ConditionBinaryCompositeOR ( )

inlinevirtual

Definition at line 122 of file ConditionComposite.hpp.

Member Function Documentation

virtual ConditionInterface* RTT::scripting::ConditionBinaryCompositeOR::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 113 of file ConditionComposite.hpp.

References RTT::scripting::ConditionInterface::clone().

ConditionBinaryCompositeOR* RTT::scripting::ConditionBinaryCompositeOR::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 118 of file ConditionComposite.hpp.

References RTT::scripting::ConditionInterface::copy().

virtual bool RTT::scripting::ConditionBinaryCompositeOR::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 127 of file ConditionComposite.hpp.

References RTT::scripting::ConditionInterface::evaluate().

virtual void RTT::scripting::ConditionBinaryCompositeOR::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 135 of file ConditionComposite.hpp.

References RTT::scripting::ConditionInterface::reset().

---

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

• rtt/scripting/ConditionComposite.hpp