RTT::scripting::TryCommand Class Reference

#include <TryCommand.hpp>

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

List of all members.

Public Member Functions

TryCommandclone () const
TryCommandclone () const
TryCommandcopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
TryCommandcopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool execute ()
bool execute ()
void readArguments ()
void readArguments ()
void reset ()
void reset ()
internal::AssignableDataSource
< bool >::shared_ptr 
result ()
internal::AssignableDataSource
< bool >::shared_ptr 
result ()
base::ActionInterfacetheCommand () const
base::ActionInterfacetheCommand () const
 TryCommand (base::ActionInterface *command, internal::AssignableDataSource< bool >::shared_ptr storage=0)
 TryCommand (base::ActionInterface *command, internal::AssignableDataSource< bool >::shared_ptr storage=0)
bool valid () const
bool valid () const
 ~TryCommand ()
 ~TryCommand ()

Private Attributes

internal::AssignableDataSource
< bool >::shared_ptr 
_result
base::ActionInterfacec

Detailed Description

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

See also:
TryCommandResult.

Definition at line 59 of file install/include/rtt/scripting/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.

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

Try a command.

RTT::scripting::TryCommand::~TryCommand (  ) 

Member Function Documentation

TryCommand* RTT::scripting::TryCommand::clone (  )  const [virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

TryCommand * RTT::TryCommand::clone (  )  const [virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 100 of file TryCommand.cpp.

TryCommand* RTT::scripting::TryCommand::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const
TryCommand* RTT::scripting::TryCommand::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const
bool RTT::scripting::TryCommand::execute (  )  [virtual]

Execute the functionality of this action.

Returns:
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

bool RTT::TryCommand::execute (  )  [virtual]

Execute the functionality of this action.

Returns:
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 56 of file TryCommand.cpp.

void RTT::scripting::TryCommand::readArguments (  )  [virtual]

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

Implements RTT::base::ActionInterface.

void RTT::TryCommand::readArguments (  )  [virtual]

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::scripting::TryCommand::reset (  )  [virtual]

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

Reimplemented from RTT::base::ActionInterface.

void RTT::TryCommand::reset (  )  [virtual]

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

Reimplemented from RTT::base::ActionInterface.

Definition at line 70 of file TryCommand.cpp.

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

Definition at line 96 of file TryCommand.cpp.

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

Definition at line 92 of file TryCommand.cpp.

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

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

Definition at line 75 of file TryCommand.cpp.


Member Data Documentation

Definition at line 64 of file install/include/rtt/scripting/TryCommand.hpp.

Definition at line 65 of file install/include/rtt/scripting/TryCommand.hpp.


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:16 2013