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

#include <ConditionExpire.hpp>

Inheritance diagram for RTT::scripting::ConditionExpire:
Inheritance graph

Public Member Functions

virtual ConditionInterfaceclone () const
 ConditionExpire (ticks t)
virtual bool evaluate ()
 Evaluate the Condition and return the outcome. More...
virtual void reset ()
virtual ~ConditionExpire ()
- Public Member Functions inherited from RTT::scripting::ConditionInterface
virtual ConditionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual ~ConditionInterface ()

Private Types

typedef os::TimeService::ticks ticks

Private Attributes

ticks time
ticks timestamp

Detailed Description

A conditional that evaluates true until a certain time has elapsed since construction or the last reset()

Definition at line 54 of file ConditionExpire.hpp.

Member Typedef Documentation

Definition at line 57 of file ConditionExpire.hpp.

Constructor & Destructor Documentation

RTT::scripting::ConditionExpire::ConditionExpire ( ticks  t)

Create a Condition that evaluates to false when t is reached

tthe time in os::TimeService::ticks on and after which the condition will evaluate to false

Definition at line 65 of file ConditionExpire.hpp.

virtual RTT::scripting::ConditionExpire::~ConditionExpire ( )

Definition at line 71 of file ConditionExpire.hpp.

Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 84 of file ConditionExpire.hpp.

virtual bool RTT::scripting::ConditionExpire::evaluate ( )

Evaluate the Condition and return the outcome.

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 74 of file ConditionExpire.hpp.

virtual void RTT::scripting::ConditionExpire::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 79 of file ConditionExpire.hpp.

Member Data Documentation

os::TimeService* RTT::scripting::ConditionExpire::hb

A local reference to the HeartBeat Generator

Definition at line 98 of file ConditionExpire.hpp.

ticks RTT::scripting::ConditionExpire::time

The expiration time, expressed in ticks

Definition at line 93 of file ConditionExpire.hpp.

ticks RTT::scripting::ConditionExpire::timestamp

Definition at line 94 of file ConditionExpire.hpp.

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

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