Public Member Functions | Public Attributes | List of all members
RTT::scripting::CommandDataSource Struct Reference

#include <CommandDataSource.hpp>

Inheritance diagram for RTT::scripting::CommandDataSource:
Inheritance graph

Public Member Functions

base::ActionInterfaceclone () const
 CommandDataSource (base::DataSourceBase::shared_ptr dsb)
base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool execute ()
void readArguments ()
void reset ()
- Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual bool valid () const
virtual ~ActionInterface ()

Public Attributes

base::DataSourceBase::shared_ptr _dsb

Additional Inherited Members

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

Detailed Description

A Command which evaluates a base::DataSourceBase and always returns true.

Definition at line 51 of file CommandDataSource.hpp.

Constructor & Destructor Documentation

RTT::scripting::CommandDataSource::CommandDataSource ( base::DataSourceBase::shared_ptr  dsb)

Definition at line 55 of file CommandDataSource.hpp.

Member Function Documentation

base::ActionInterface* RTT::scripting::CommandDataSource::clone ( ) const

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 71 of file CommandDataSource.hpp.

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

Definition at line 75 of file CommandDataSource.hpp.

bool RTT::scripting::CommandDataSource::execute ( )

Execute the functionality of this action.

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 62 of file CommandDataSource.hpp.

void RTT::scripting::CommandDataSource::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 58 of file CommandDataSource.hpp.

void RTT::scripting::CommandDataSource::reset ( )

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

Reimplemented from RTT::base::ActionInterface.

Definition at line 67 of file CommandDataSource.hpp.

Member Data Documentation

base::DataSourceBase::shared_ptr RTT::scripting::CommandDataSource::_dsb

Definition at line 54 of file CommandDataSource.hpp.

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

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