RTT::scripting::ConditionExpire Class Reference

#include <ConditionExpire.hpp>

Inheritance diagram for RTT::scripting::ConditionExpire:

Public Member Functions
virtual ConditionInterface *	clone () const
virtual ConditionInterface *	clone () const
	ConditionExpire (ticks t)
	ConditionExpire (ticks t)
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	~ConditionExpire ()
virtual	~ConditionExpire ()
Private Types
typedef os::TimeService::ticks	ticks
typedef os::TimeService::ticks	ticks
Private Attributes
os::TimeService *	hb
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 install/include/rtt/scripting/ConditionExpire.hpp.

Member Typedef Documentation

typedef os::TimeService::ticks RTT::scripting::ConditionExpire::ticks [private]

Definition at line 57 of file rtt/scripting/ConditionExpire.hpp.

typedef os::TimeService::ticks RTT::scripting::ConditionExpire::ticks [private]

Definition at line 57 of file install/include/rtt/scripting/ConditionExpire.hpp.

Constructor & Destructor Documentation

RTT::scripting::ConditionExpire::ConditionExpire ( ticks t ) [inline]

Create a Condition that evaluates to false when t is reached

Parameters:

t

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

Definition at line 65 of file install/include/rtt/scripting/ConditionExpire.hpp.

virtual RTT::scripting::ConditionExpire::~ConditionExpire ( ) [inline, virtual]

Definition at line 71 of file install/include/rtt/scripting/ConditionExpire.hpp.

RTT::scripting::ConditionExpire::ConditionExpire ( ticks t ) [inline]

Create a Condition that evaluates to false when t is reached

Parameters:

t

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

Definition at line 65 of file rtt/scripting/ConditionExpire.hpp.

virtual RTT::scripting::ConditionExpire::~ConditionExpire ( ) [inline, virtual]

Definition at line 71 of file rtt/scripting/ConditionExpire.hpp.

Member Function Documentation

virtual ConditionInterface* RTT::scripting::ConditionExpire::clone ( ) const [inline, virtual]

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 84 of file rtt/scripting/ConditionExpire.hpp.

virtual ConditionInterface* RTT::scripting::ConditionExpire::clone ( ) const [inline, virtual]

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 84 of file install/include/rtt/scripting/ConditionExpire.hpp.

virtual bool RTT::scripting::ConditionExpire::evaluate ( ) [inline, virtual]

Evaluate the Condition and return the outcome.

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

Implements RTT::scripting::ConditionInterface.

Definition at line 74 of file rtt/scripting/ConditionExpire.hpp.

virtual bool RTT::scripting::ConditionExpire::evaluate ( ) [inline, virtual]

Evaluate the Condition and return the outcome.

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

Implements RTT::scripting::ConditionInterface.

Definition at line 74 of file install/include/rtt/scripting/ConditionExpire.hpp.

virtual void RTT::scripting::ConditionExpire::reset ( ) [inline, 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 79 of file rtt/scripting/ConditionExpire.hpp.

virtual void RTT::scripting::ConditionExpire::reset ( ) [inline, 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 79 of file install/include/rtt/scripting/ConditionExpire.hpp.