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

#include <TryCommand.hpp>

Inheritance diagram for RTT::scripting::EvalCommand:
Inheritance graph

Public Member Functions

internal::AssignableDataSource< bool >::shared_ptr cache ()
base::ActionInterfaceclone () const
base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 EvalCommand (internal::DataSource< bool >::shared_ptr ds, internal::AssignableDataSource< bool >::shared_ptr cache=0)
bool execute ()
void readArguments ()
void reset ()
 ~EvalCommand ()
- Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual bool valid () const
virtual ~ActionInterface ()

Private Attributes

internal::AssignableDataSource< bool >::shared_ptr _cache
internal::DataSource< bool >::shared_ptr _ds

Additional Inherited Members

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

Detailed Description

Evaluates a internal::DataSource<bool> in a command. The result will be evaluated in a EvalCommandResult, so this Command returns always true : ie the evaluation itself always succeeds. An EvalCommand should never be dispatched, since the EvalCommandResult assumes the EvalCommand has been executed when evaluated.

See also

Definition at line 127 of file TryCommand.hpp.

Constructor & Destructor Documentation

RTT::EvalCommand::EvalCommand ( internal::DataSource< bool >::shared_ptr  ds,
internal::AssignableDataSource< bool >::shared_ptr  cache = 0 

Definition at line 131 of file TryCommand.cpp.

RTT::EvalCommand::~EvalCommand ( )

Definition at line 135 of file TryCommand.cpp.

Member Function Documentation

AssignableDataSource< bool >::shared_ptr RTT::EvalCommand::cache ( )

Definition at line 152 of file TryCommand.cpp.

ActionInterface * RTT::EvalCommand::clone ( ) const

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 156 of file TryCommand.cpp.

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

Definition at line 161 of file TryCommand.cpp.

bool RTT::EvalCommand::execute ( )

Execute the functionality of this action.

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 141 of file TryCommand.cpp.

void RTT::EvalCommand::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 138 of file TryCommand.cpp.

void RTT::EvalCommand::reset ( )

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

Reimplemented from RTT::base::ActionInterface.

Definition at line 147 of file TryCommand.cpp.

Member Data Documentation

internal::AssignableDataSource<bool>::shared_ptr RTT::scripting::EvalCommand::_cache

Definition at line 131 of file TryCommand.hpp.

internal::DataSource<bool>::shared_ptr RTT::scripting::EvalCommand::_ds

Definition at line 133 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