RTT::scripting::ConditionBinaryCompositeOR Class Reference

#include <ConditionComposite.hpp>

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

List of all members.

Public Member Functions

virtual ConditionInterfaceclone () const
virtual ConditionInterfaceclone () const
 ConditionBinaryCompositeOR (ConditionInterface *l, ConditionInterface *r)
 ConditionBinaryCompositeOR (ConditionInterface *l, ConditionInterface *r)
ConditionBinaryCompositeORcopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
ConditionBinaryCompositeORcopy (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.
virtual void reset ()
virtual void reset ()
virtual ~ConditionBinaryCompositeOR ()
virtual ~ConditionBinaryCompositeOR ()

Private Attributes

ConditionInterfacelhs
ConditionInterfacerhs

Detailed Description

Definition at line 97 of file install/include/rtt/scripting/ConditionComposite.hpp.


Constructor & Destructor Documentation

RTT::scripting::ConditionBinaryCompositeOR::ConditionBinaryCompositeOR ( ConditionInterface l,
ConditionInterface r 
) [inline]

If l evaluates to true, evaluate and return the result, otherwise, return false. Constructor takes ownership of l and r.

Definition at line 108 of file install/include/rtt/scripting/ConditionComposite.hpp.

virtual RTT::scripting::ConditionBinaryCompositeOR::~ConditionBinaryCompositeOR (  )  [inline, virtual]
RTT::scripting::ConditionBinaryCompositeOR::ConditionBinaryCompositeOR ( ConditionInterface l,
ConditionInterface r 
) [inline]

If l evaluates to true, evaluate and return the result, otherwise, return false. Constructor takes ownership of l and r.

Definition at line 108 of file rtt/scripting/ConditionComposite.hpp.

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

Definition at line 122 of file rtt/scripting/ConditionComposite.hpp.


Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 113 of file rtt/scripting/ConditionComposite.hpp.

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

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 113 of file install/include/rtt/scripting/ConditionComposite.hpp.

ConditionBinaryCompositeOR* RTT::scripting::ConditionBinaryCompositeOR::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 118 of file rtt/scripting/ConditionComposite.hpp.

ConditionBinaryCompositeOR* RTT::scripting::ConditionBinaryCompositeOR::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 118 of file install/include/rtt/scripting/ConditionComposite.hpp.

virtual bool RTT::scripting::ConditionBinaryCompositeOR::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 127 of file rtt/scripting/ConditionComposite.hpp.

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

virtual void RTT::scripting::ConditionBinaryCompositeOR::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 135 of file rtt/scripting/ConditionComposite.hpp.

virtual void RTT::scripting::ConditionBinaryCompositeOR::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 135 of file install/include/rtt/scripting/ConditionComposite.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