Orocos Real-Time Toolkit  2.9.0
Public Types | Public Member Functions | Public Attributes | List of all members
RTT::scripting::CommandBinary Struct Reference

#include <rtt/scripting/CommandBinary.hpp>

Inheritance diagram for RTT::scripting::CommandBinary:
RTT::base::ActionInterface

Public Types

typedef boost::shared_ptr< ActionInterfaceshared_ptr
 Use this type for shared pointer storage of an ActionInterface object. More...
 

Public Member Functions

 CommandBinary (base::ActionInterface *f, base::ActionInterface *s)
 
virtual ~CommandBinary ()
 
void readArguments ()
 This is invoked some time before execute() at a time when the action may read its function arguments. More...
 
virtual bool valid () const
 Inspect if this action was executed and valid. More...
 
virtual bool execute ()
 Execute the functionality of this action. More...
 
virtual void reset ()
 Reset this action. More...
 
virtual base::ActionInterfaceclone () const
 The Clone Software Pattern. More...
 
virtual base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More...
 

Public Attributes

base::ActionInterface_f
 
base::ActionInterface_s
 

Detailed Description

Definition at line 50 of file CommandBinary.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<ActionInterface> RTT::base::ActionInterface::shared_ptr
inherited

Use this type for shared pointer storage of an ActionInterface object.

Definition at line 78 of file ActionInterface.hpp.

Constructor & Destructor Documentation

RTT::scripting::CommandBinary::CommandBinary ( base::ActionInterface f,
base::ActionInterface s 
)
inline

Definition at line 54 of file CommandBinary.hpp.

Referenced by clone(), and copy().

virtual RTT::scripting::CommandBinary::~CommandBinary ( )
inlinevirtual

Definition at line 56 of file CommandBinary.hpp.

References _f, and _s.

Member Function Documentation

virtual base::ActionInterface* RTT::scripting::CommandBinary::clone ( ) const
inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 78 of file CommandBinary.hpp.

References RTT::base::ActionInterface::clone(), and CommandBinary().

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

When copying an Orocos program, we want identical internal::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 internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::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 internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented from RTT::base::ActionInterface.

Definition at line 81 of file CommandBinary.hpp.

References CommandBinary(), and RTT::base::ActionInterface::copy().

virtual bool RTT::scripting::CommandBinary::execute ( )
inlinevirtual

Execute the functionality of this action.

Returns
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 71 of file CommandBinary.hpp.

References RTT::base::ActionInterface::execute().

void RTT::scripting::CommandBinary::readArguments ( )
inlinevirtual

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 61 of file CommandBinary.hpp.

References RTT::base::ActionInterface::readArguments().

virtual void RTT::scripting::CommandBinary::reset ( )
inlinevirtual

Reset this action.

Must be used after execute() failed.

Reimplemented from RTT::base::ActionInterface.

Definition at line 74 of file CommandBinary.hpp.

References RTT::base::ActionInterface::reset().

virtual bool RTT::scripting::CommandBinary::valid ( ) const
inlinevirtual

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 67 of file CommandBinary.hpp.

References RTT::base::ActionInterface::valid().

Member Data Documentation

base::ActionInterface* RTT::scripting::CommandBinary::_f

Definition at line 52 of file CommandBinary.hpp.

Referenced by ~CommandBinary().

base::ActionInterface* RTT::scripting::CommandBinary::_s

Definition at line 53 of file CommandBinary.hpp.

Referenced by ~CommandBinary().


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