RTT::scripting::CommandBinary Struct Reference

#include <CommandBinary.hpp>

Inheritance diagram for RTT::scripting::CommandBinary:

Public Member Functions
virtual base::ActionInterface *	clone () const
	CommandBinary (base::ActionInterface *f, base::ActionInterface *s)
virtual base::ActionInterface *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool	execute ()
void	readArguments ()
virtual void	reset ()
virtual bool	valid () const
virtual	~CommandBinary ()
Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterface *	copy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual	~ActionInterface ()

Public Attributes
base::ActionInterface *	_f
base::ActionInterface *	_s

Additional Inherited Members
Public Types inherited from RTT::base::ActionInterface
typedef boost::shared_ptr< ActionInterface >	shared_ptr

Detailed Description

Definition at line 50 of file CommandBinary.hpp.

Constructor & Destructor Documentation

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

inline

Definition at line 54 of file CommandBinary.hpp.

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

inlinevirtual

Definition at line 56 of file CommandBinary.hpp.

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.

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

inlinevirtual

Definition at line 81 of file CommandBinary.hpp.

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.

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.

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.

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.

Member Data Documentation

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

Definition at line 52 of file CommandBinary.hpp.

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

Definition at line 53 of file CommandBinary.hpp.

---

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

• CommandBinary.hpp