RTT::scripting::ConditionDuration Class Reference

#include <ConditionDuration.hpp>

Inheritance diagram for RTT::scripting::ConditionDuration:

Public Member Functions
ConditionInterface *	clone () const
	ConditionDuration (nsecs t, bool invert=false)
virtual bool	evaluate ()
	Evaluate the Condition and return the outcome.
virtual void	reset ()
virtual	~ConditionDuration ()
Private Types
typedef os::TimeService::nsecs	nsecs
typedef os::TimeService::ticks	ticks
Private Attributes
bool	_invert
os::TimeService *	hb
ticks	mark
nsecs	time

Detailed Description

A conditional that evaluates true after a certain time has passed. The behaviour can be inverted upon construction.

Definition at line 54 of file ConditionDuration.hpp.

Member Typedef Documentation

typedef os::TimeService::nsecs RTT::scripting::ConditionDuration::nsecs [private]

Definition at line 57 of file ConditionDuration.hpp.

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

Definition at line 58 of file ConditionDuration.hpp.

Constructor & Destructor Documentation

RTT::ConditionDuration::ConditionDuration	(	nsecs	t,
		bool	invert = `false`
	)

Create a condition that changes after t nano seconds

Parameters:

	t	the period of time starting from reset()
	invert	If false (default) then the condition will raise to true after t. If true then the condition will fall to false after t.

Definition at line 46 of file ConditionDuration.cpp.

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

Definition at line 51 of file ConditionDuration.cpp.

Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 64 of file ConditionDuration.cpp.

bool RTT::ConditionDuration::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 54 of file ConditionDuration.cpp.

void RTT::ConditionDuration::reset ( void ) [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 59 of file ConditionDuration.cpp.