Public Member Functions | Private Attributes | List of all members
RTT::scripting::TryCommand Class Reference

#include <TryCommand.hpp>

Inheritance diagram for RTT::scripting::TryCommand:
Inheritance graph

Public Member Functions

TryCommandclone () const
TryCommandcopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool execute ()
void readArguments ()
void reset ()
internal::AssignableDataSource< bool >::shared_ptr result ()
base::ActionInterfacetheCommand () const
 TryCommand (base::ActionInterface *command, internal::AssignableDataSource< bool >::shared_ptr storage=0)
bool valid () const
 ~TryCommand ()
- Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual ~ActionInterface ()

Private Attributes

internal::AssignableDataSource< bool >::shared_ptr _result

Additional Inherited Members

- Public Types inherited from RTT::base::ActionInterface
typedef boost::shared_ptr< ActionInterfaceshared_ptr

Detailed Description

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

See also

Definition at line 59 of file TryCommand.hpp.

Constructor & Destructor Documentation

RTT::TryCommand::TryCommand ( base::ActionInterface command,
internal::AssignableDataSource< bool >::shared_ptr  storage = 0 

Try a command.

Definition at line 48 of file TryCommand.cpp.

RTT::TryCommand::~TryCommand ( )

Definition at line 53 of file TryCommand.cpp.

Member Function Documentation

TryCommand * RTT::TryCommand::clone ( ) const

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 100 of file TryCommand.cpp.

TryCommand * RTT::TryCommand::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned) const

Definition at line 105 of file TryCommand.cpp.

bool RTT::TryCommand::execute ( )

Execute the functionality of this action.

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 56 of file TryCommand.cpp.

void RTT::TryCommand::readArguments ( )

This is invoked some time before execute() at a time when the action may read its function arguments.

Implements RTT::base::ActionInterface.

Definition at line 82 of file TryCommand.cpp.

void RTT::TryCommand::reset ( )

Reset this action. Must be used after execute() failed.

Reimplemented from RTT::base::ActionInterface.

Definition at line 70 of file TryCommand.cpp.

AssignableDataSource< bool >::shared_ptr RTT::TryCommand::result ( )

Definition at line 96 of file TryCommand.cpp.

ActionInterface * RTT::TryCommand::theCommand ( ) const

Definition at line 92 of file TryCommand.cpp.

bool RTT::TryCommand::valid ( ) const

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 RTT::base::ActionInterface.

Definition at line 75 of file TryCommand.cpp.

Member Data Documentation

internal::AssignableDataSource<bool>::shared_ptr RTT::scripting::TryCommand::_result

Definition at line 64 of file TryCommand.hpp.

base::ActionInterface* RTT::scripting::TryCommand::c

Definition at line 65 of file TryCommand.hpp.

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

Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47