RTT::scripting::ConditionOnce Class Reference

#include <ConditionOnce.hpp>

Inheritance diagram for RTT::scripting::ConditionOnce:

Public Member Functions
ConditionInterface *	clone () const
	ConditionOnce (bool what)
virtual bool	evaluate ()
	Evaluate the Condition and return the outcome. More...
virtual void	reset ()
virtual	~ConditionOnce ()
Public Member Functions inherited from RTT::scripting::ConditionInterface
virtual ConditionInterface *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual	~ConditionInterface ()

Private Attributes
bool	_what
bool	ran

Detailed Description

A conditional that evaluates the first time true and afterwards always false (or vice versa).

Definition at line 53 of file ConditionOnce.hpp.

Constructor & Destructor Documentation

RTT::ConditionOnce::ConditionOnce

(

bool

what

)

Create a condition which will return once true or once false.

Parameters

what	supply false it must return once false and supply true if it must return once true.

Definition at line 46 of file ConditionOnce.cpp.

RTT::ConditionOnce::~ConditionOnce ( )

virtual

Definition at line 49 of file ConditionOnce.cpp.

Member Function Documentation

ConditionInterface * RTT::ConditionOnce::clone ( ) const

virtual

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 66 of file ConditionOnce.cpp.

bool RTT::ConditionOnce::evaluate ( )

virtual

Evaluate the Condition and return the outcome.

Returns

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 52 of file ConditionOnce.cpp.

void RTT::ConditionOnce::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.

Reimplemented from RTT::scripting::ConditionInterface.

Definition at line 61 of file ConditionOnce.cpp.

Member Data Documentation

bool RTT::scripting::ConditionOnce::_what

private

Definition at line 80 of file ConditionOnce.hpp.

bool RTT::scripting::ConditionOnce::ran

private

Becomes true after one evaluation after its reset() method has been called.

Definition at line 79 of file ConditionOnce.hpp.

---

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

• ConditionOnce.hpp
• ConditionOnce.cpp