Public Member Functions | Private Types | Private Attributes
RTT::scripting::ConditionDSDuration Class Reference

#include <ConditionDSDuration.hpp>

Inheritance diagram for RTT::scripting::ConditionDSDuration:
Inheritance graph

List of all members.

Public Member Functions

ConditionInterfaceclone () const
 ConditionDSDuration (internal::DataSource< double >::shared_ptr ds, bool invert=false)
virtual ConditionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool evaluate ()
 Evaluate the Condition and return the outcome.
virtual void reset ()
virtual ~ConditionDSDuration ()

Private Types

typedef os::TimeService::nsecs nsecs
typedef os::TimeService::ticks ticks

Private Attributes

bool _invert
ticks mark
internal::DataSource< double >

Detailed Description

A conditional that evaluates true after a certain time (in seconds) has passed, given by a DataSource. The behaviour can be inverted upon construction.

Definition at line 56 of file ConditionDSDuration.hpp.

Member Typedef Documentation

Definition at line 59 of file ConditionDSDuration.hpp.

Definition at line 60 of file ConditionDSDuration.hpp.

Constructor & Destructor Documentation

RTT::ConditionDSDuration::ConditionDSDuration ( internal::DataSource< double >::shared_ptr  ds,
bool  invert = false 

Create a condition that changes after ds->get() seconds.

dsA internal::DataSource containing the period of time starting from reset()
invertIf false (default) then the condition will raise to true after ds->get() seconds. If true then the condition will fall to false after ds->get() seconds.

Definition at line 45 of file ConditionDSDuration.cpp.

Definition at line 50 of file ConditionDSDuration.cpp.

Member Function Documentation

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 63 of file ConditionDSDuration.cpp.

ConditionInterface * RTT::ConditionDSDuration::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned) const [virtual]

When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. This is different from the clone function, where we simply want a new Command that can replace the old one directly.

This function takes a map that maps the old internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::DataSource, whether it has already been copied, and if so, reuse the existing copy.

To keep old source working, the standard implementation of this function simply calls the clone function. If your ConditionInterface uses a internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::scripting::ConditionInterface.

Definition at line 68 of file ConditionDSDuration.cpp.

Evaluate the Condition and return the outcome.

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 53 of file ConditionDSDuration.cpp.

void RTT::ConditionDSDuration::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 58 of file ConditionDSDuration.cpp.

Member Data Documentation

Invert the time comparison to 'smaller then'

Definition at line 100 of file ConditionDSDuration.hpp.

A local reference to the HeartBeat Generator

Definition at line 91 of file ConditionDSDuration.hpp.

The time the evaluation is called the first time

Definition at line 95 of file ConditionDSDuration.hpp.

The expiration time, expressed in ticks

Definition at line 86 of file ConditionDSDuration.hpp.

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

Author(s): RTT Developers
autogenerated on Mon Oct 6 2014 03:14:00