RTT::scripting::ConditionOnce Class Reference

#include <ConditionOnce.hpp>

Inheritance diagram for RTT::scripting::ConditionOnce:
Inheritance graph
[legend]

List of all members.

Public Member Functions

ConditionInterfaceclone () const
ConditionInterfaceclone () const
 ConditionOnce (bool what)
 ConditionOnce (bool what)
virtual bool evaluate ()
 Evaluate the Condition and return the outcome.
virtual bool evaluate ()
 Evaluate the Condition and return the outcome.
virtual void reset ()
virtual void reset ()
virtual ~ConditionOnce ()
virtual ~ConditionOnce ()

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 install/include/rtt/scripting/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 45 of file ConditionOnce.cpp.

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

Definition at line 48 of file ConditionOnce.cpp.

RTT::scripting::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.
virtual RTT::scripting::ConditionOnce::~ConditionOnce (  )  [virtual]

Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

ConditionInterface * RTT::ConditionOnce::clone (  )  const [virtual]

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 65 of file ConditionOnce.cpp.

virtual bool RTT::scripting::ConditionOnce::evaluate (  )  [virtual]

Evaluate the Condition and return the outcome.

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

Implements RTT::scripting::ConditionInterface.

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 51 of file ConditionOnce.cpp.

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

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 60 of file ConditionOnce.cpp.


Member Data Documentation

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

Definition at line 79 of file install/include/rtt/scripting/ConditionOnce.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:13 2013