RTT::TryCommandResult Class Reference

Returns the (accept/reject) status of another command. More...

#include <rtt/TryCommand.hpp>

Inheritance diagram for RTT::TryCommandResult:
RTT::ConditionInterface

List of all members.

Public Member Functions

 TryCommandResult (DataSource< bool >::shared_ptr ec, bool invert)
 Pass TryCommand::result() to the first parameter of the command you want to check.
bool evaluate ()
 Evaluate the Condition and return the outcome.
ConditionInterfaceclone () const
 The Clone Software Pattern.
ConditionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
 When copying an Orocos program, we want identical DataSource's to be mapped to identical DataSources, in order for the program to work correctly.
virtual void reset ()
 Some conditions need to be reset at some points.

Detailed Description

Returns the (accept/reject) status of another command.

See also:
TryCommand

Definition at line 94 of file TryCommand.hpp.


Constructor & Destructor Documentation

RTT::TryCommandResult::TryCommandResult ( DataSource< bool >::shared_ptr  ec,
bool  invert 
)

Pass TryCommand::result() to the first parameter of the command you want to check.

If invert is true, TryCommandResult::evaluate() will return true if the original command failed. If invert is false, evaluate() will return the return value of the original command.


Member Function Documentation

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

When copying an Orocos program, we want identical 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 DataSource's onto their new replacements. This way, it is possible to check before cloning a 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 DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::ConditionInterface.

bool RTT::TryCommandResult::evaluate (  )  [virtual]

Evaluate the Condition and return the outcome.

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

Implements RTT::ConditionInterface.

virtual void RTT::ConditionInterface::reset (  )  [virtual, inherited]

Some conditions need to be reset at some points.

E.g. a 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.. ConditionOnce has a similar need. This function is called at such times.

Reimplemented in RTT::ConditionBoolDataSource, RTT::ConditionBinaryCompositeAND, RTT::ConditionDSDuration, RTT::ConditionDuration, RTT::ConditionExpire, and RTT::ConditionOnce.


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:22:45 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3