RTT::scripting::TryCommandResult Class Reference

#include <TryCommand.hpp>

Inheritance diagram for RTT::scripting::TryCommandResult:

Public Member Functions
ConditionInterface *	clone () const
ConditionInterface *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool	evaluate ()
	Evaluate the Condition and return the outcome. More...
	TryCommandResult (internal::DataSource< bool >::shared_ptr ec, bool invert)
	~TryCommandResult ()
Public Member Functions inherited from RTT::scripting::ConditionInterface
virtual void	reset ()
virtual	~ConditionInterface ()

Private Attributes
bool	_invert
internal::DataSource< bool >::shared_ptr	c

Detailed Description

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

See also

TryCommand

Definition at line 96 of file TryCommand.hpp.

Constructor & Destructor Documentation

RTT::TryCommandResult::TryCommandResult	(	internal::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.

Definition at line 111 of file TryCommand.cpp.

RTT::TryCommandResult::~TryCommandResult

(

)

Definition at line 114 of file TryCommand.cpp.

Member Function Documentation

ConditionInterface * RTT::TryCommandResult::clone ( ) const

virtual

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 123 of file TryCommand.cpp.

ConditionInterface * RTT::TryCommandResult::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 127 of file TryCommand.cpp.

bool RTT::TryCommandResult::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 118 of file TryCommand.cpp.

Member Data Documentation

bool RTT::scripting::TryCommandResult::_invert

private

Definition at line 100 of file TryCommand.hpp.

internal::DataSource<bool>::shared_ptr RTT::scripting::TryCommandResult::c

private

Definition at line 99 of file TryCommand.hpp.

---

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

• TryCommand.hpp
• TryCommand.cpp