RTT::scripting::ConditionCache Class Reference

#include <ConditionCache.hpp>

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

List of all members.

Public Member Functions

virtual ConditionInterfaceclone () const
virtual ConditionInterfaceclone () const
 ConditionCache (ConditionInterface *c, internal::AssignableDataSource< bool >::shared_ptr ds=internal::AssignableDataSource< bool >::shared_ptr())
 ConditionCache (ConditionInterface *c, internal::AssignableDataSource< bool >::shared_ptr ds=internal::AssignableDataSource< bool >::shared_ptr())
virtual ConditionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual ConditionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool evaluate ()
 Evaluate the Condition and return the outcome.
virtual bool evaluate ()
 Evaluate the Condition and return the outcome.
internal::DataSource< bool >
::shared_ptr 
getResult ()
internal::DataSource< bool >
::shared_ptr 
getResult ()
virtual void reset ()
virtual void reset ()
virtual ~ConditionCache ()
virtual ~ConditionCache ()

Private Attributes

boost::shared_ptr
< ConditionInterface
mc
internal::AssignableDataSource
< bool >::shared_ptr 
result

Detailed Description

A conditional that evaluates and caches another Condition. In order to read the cached value, use ConditionBoolDataSource. By default, and after a reset, the cached condition returned in getResult() returns false.

Definition at line 54 of file install/include/rtt/scripting/ConditionCache.hpp.


Constructor & Destructor Documentation

RTT::scripting::ConditionCache::ConditionCache ( ConditionInterface c,
internal::AssignableDataSource< bool >::shared_ptr  ds = internal::AssignableDataSource<bool>::shared_ptr() 
) [inline]
virtual RTT::scripting::ConditionCache::~ConditionCache (  )  [inline, virtual]
RTT::scripting::ConditionCache::ConditionCache ( ConditionInterface c,
internal::AssignableDataSource< bool >::shared_ptr  ds = internal::AssignableDataSource<bool>::shared_ptr() 
) [inline]

Definition at line 60 of file rtt/scripting/ConditionCache.hpp.

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

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


Member Function Documentation

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

A clone will cache the same condition.

Implements RTT::scripting::ConditionInterface.

Definition at line 89 of file rtt/scripting/ConditionCache.hpp.

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

A clone will cache the same condition.

Implements RTT::scripting::ConditionInterface.

Definition at line 89 of file install/include/rtt/scripting/ConditionCache.hpp.

virtual ConditionInterface* RTT::scripting::ConditionCache::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [inline, 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 81 of file rtt/scripting/ConditionCache.hpp.

virtual ConditionInterface* RTT::scripting::ConditionCache::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [inline, 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 81 of file install/include/rtt/scripting/ConditionCache.hpp.

virtual bool RTT::scripting::ConditionCache::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 69 of file rtt/scripting/ConditionCache.hpp.

virtual bool RTT::scripting::ConditionCache::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 69 of file install/include/rtt/scripting/ConditionCache.hpp.

internal::DataSource<bool>::shared_ptr RTT::scripting::ConditionCache::getResult (  )  [inline]

Definition at line 79 of file rtt/scripting/ConditionCache.hpp.

internal::DataSource<bool>::shared_ptr RTT::scripting::ConditionCache::getResult (  )  [inline]
virtual void RTT::scripting::ConditionCache::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 75 of file rtt/scripting/ConditionCache.hpp.

virtual void RTT::scripting::ConditionCache::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 75 of file install/include/rtt/scripting/ConditionCache.hpp.


Member Data Documentation


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:12 2013