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

A Command indicating that an error was encountered somewhere, most likely during the construction of another command. More...

#include <CommandIllegal.hpp>

Inheritance diagram for RTT::scripting::CommandIllegal:
Inheritance graph
[legend]

Public Member Functions

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

Private Member Functions

 CommandIllegal ()
 

Private Attributes

std::string description
 
std::string illCmd
 

Additional Inherited Members

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

Detailed Description

A Command indicating that an error was encountered somewhere, most likely during the construction of another command.

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

Definition at line 57 of file CommandIllegal.hpp.

Constructor & Destructor Documentation

RTT::CommandIllegal::CommandIllegal ( const std::string &  cmd)

Construct a new CommandIllegal with the illegal std::stringcommand as argument

Parameters
cmdcommand that failed

Definition at line 44 of file CommandIllegal.cpp.

RTT::CommandIllegal::CommandIllegal ( const std::string &  cmd,
const std::string &  descr 
)

Construct a new CommandIllegal with the illegal std::stringcommand as argument and a description

Parameters
cmdcommand that failed
descrdescription

Definition at line 48 of file CommandIllegal.cpp.

RTT::scripting::CommandIllegal::CommandIllegal ( )
private

Forbidden

Member Function Documentation

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

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 94 of file CommandIllegal.hpp.

bool RTT::CommandIllegal::execute ( )
virtual

Execute the functionality of this action.

Returns
true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 52 of file CommandIllegal.cpp.

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

void RTT::CommandIllegal::warn ( )
virtual

Preferably, this function is executed right after a CommandIllegal has been created. This function can give feedback about a failed command before the CommandIllegal is actually executed

Definition at line 60 of file CommandIllegal.cpp.

Member Data Documentation

std::string RTT::scripting::CommandIllegal::description
private

Definition at line 106 of file CommandIllegal.hpp.

std::string RTT::scripting::CommandIllegal::illCmd
private

Definition at line 105 of file CommandIllegal.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:46