Orocos Real-Time Toolkit  2.6.0
Public Types | Public Member Functions
RTT::scripting::CommandString Class Reference

This command displays a string when executed. More...

#include <rtt/scripting/CommandString.hpp>

Inheritance diagram for RTT::scripting::CommandString:

List of all members.

Public Types

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

Public Member Functions

 CommandString (std::string s)
virtual void readArguments ()
 This is invoked some time before execute() at a time when the action may read its function arguments.
virtual bool execute ()
 Execute the functionality of this action.
virtual base::ActionInterfaceclone () const
 The Clone Software Pattern.
virtual void reset ()
 Reset this action.
virtual bool valid () const
 Inspect if this action was executed and valid.
virtual ActionInterfacecopy (std::map< const DataSourceBase *, 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.

Detailed Description

This command displays a string when executed.

Remove this low-level class since it's nowhere used.

Definition at line 52 of file CommandString.hpp.

Member Function Documentation

ActionInterface * RTT::ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > &  alreadyCloned) const [virtual, inherited]

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 in RTT::scripting::CallFunction, RTT::scripting::EvalCommand, RTT::scripting::CommandComposite, RTT::scripting::CommandDataSourceBool, RTT::internal::AssignCommand< T, S >, RTT::scripting::TryCommand, and RTT::scripting::CommandDataSource.

Definition at line 60 of file ActionInterface.cpp.

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

Referenced by RTT::internal::DataSourceCommand::copy(), RTT::scripting::TryCommand::copy(), RTT::internal::ActionAliasDataSource< T >::copy(), and RTT::internal::ActionAliasAssignableDataSource< T >::copy().

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

Execute the functionality of this action.

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 48 of file CommandString.cpp.

void RTT::ActionInterface::reset ( ) [virtual, inherited]
bool RTT::ActionInterface::valid ( ) const [virtual, inherited]

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 in RTT::scripting::CallFunction, RTT::scripting::CommandComposite, and RTT::scripting::TryCommand.

Definition at line 53 of file ActionInterface.cpp.

Referenced by RTT::scripting::VertexNode::isValid(), and RTT::scripting::TryCommand::valid().

The documentation for this class was generated from the following files: