TryCommand Class Reference

#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/TryCommand.hpp>

Inheritance diagram for TryCommand:

List of all members.

---

Detailed Description

A command which tries another command and stores the result in a DataSource<bool>.

See also:

TryCommandResult.

Public Types
typedef boost::shared_ptr< ActionInterface >	shared_ptr
	Use this type for shared pointer storage of an ActionInterface object.
Public Member Functions
	TryCommand (CommandInterface *command, AssignableDataSource< bool >::shared_ptr storage=0)
	Try a command.
bool	execute ()
	Execute the functionality of this action.
void	reset ()
	Reset this action.
bool	valid () const
	Inspect if this action was executed and valid.
void	readArguments ()
	This is invoked some time before execute() at a time when the action may read its function arguments.
CommandInterface *	theCommand () const
AssignableDataSource< bool >::shared_ptr	result ()
TryCommand *	clone () const
	The Clone Software Pattern.
TryCommand *	copy (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.

---

Member Function Documentation

bool execute

(

)

[virtual]

Execute the functionality of this action.

Returns:

true if the action was accepted, false otherwise

Implements ActionInterface.

void reset

(

)

[virtual]

Reset this action.

Must be used after execute() failed.

Reimplemented from ActionInterface.

bool valid

(

)

const [virtual]

Inspect if this action was executed and valid.

This method may not be called before execute(). The default implementation returns always true, i.e. after execute(), it was executed. Override this method if it has more complex state semantics.

Reimplemented from ActionInterface.

TryCommand* 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 Action 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 ActionInterface uses a DataSource, it is important that you reimplement this function correctly though.

Reimplemented from ActionInterface.

---

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

• rtt/TryCommand.hpp

---