Public Member Functions | Private Attributes | List of all members
RTT::scripting::ConditionOnce Class Reference

#include <ConditionOnce.hpp>

Inheritance diagram for RTT::scripting::ConditionOnce:
Inheritance graph

Public Member Functions

ConditionInterfaceclone () 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 ConditionInterfacecopy (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.

whatsupply 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 ( )

Definition at line 49 of file ConditionOnce.cpp.

Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 66 of file ConditionOnce.cpp.

bool RTT::ConditionOnce::evaluate ( )

Evaluate the Condition and return the outcome.

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 52 of file ConditionOnce.cpp.

void RTT::ConditionOnce::reset ( )

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

Definition at line 80 of file ConditionOnce.hpp.

bool RTT::scripting::ConditionOnce::ran

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:

Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47