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

#include <rtt/scripting/CommandIllegal.hpp>

Inheritance diagram for RTT::scripting::CommandIllegal:

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

Public Member Functions
	CommandIllegal (const std::string &cmd)
	Construct a new CommandIllegal with the illegal std::stringcommand as argument. More...

	CommandIllegal (const std::string &cmd, const std::string &descr)
	Construct a new CommandIllegal with the illegal std::stringcommand as argument and a description. More...

void	readArguments ()
	This is invoked some time before execute() at a time when the action may read its function arguments. More...

virtual bool	execute ()
	Execute the functionality of this action. More...

virtual void	warn ()
	Preferably, this function is executed right after a CommandIllegal has been created. More...

virtual base::ActionInterface *	clone () const
	The Clone Software Pattern. More...

virtual void	reset ()
	Reset this action. More...

virtual bool	valid () const
	Inspect if this action was executed and valid. More...

virtual ActionInterface *	copy (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. More...

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.

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::CommandIllegal::CommandIllegal ( const std::string & cmd )

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

Parameters

cmd	command 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

cmd	command that failed
descr	description

Definition at line 48 of file CommandIllegal.cpp.

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.

ActionInterface * ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > & alreadyCloned ) const

virtualinherited

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, RTT::scripting::CommandBinary, 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::CommandBinary::copy(), RTT::scripting::TryCommand::copy(), RTT::internal::ActionAliasDataSource< T >::copy(), and RTT::internal::ActionAliasAssignableDataSource< T >::copy().

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.

References RTT::os::cout, and RTT::os::endl().

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 ActionInterface::reset ( )

virtualinherited

Reset this action.

Must be used after execute() failed.

Reimplemented in RTT::scripting::CallFunction, RTT::scripting::EvalCommand, RTT::scripting::CommandDataSourceBool, RTT::internal::AssignCommand< T, S >, RTT::scripting::TryCommand, RTT::scripting::CommandBinary, RTT::scripting::CommandCounter, and RTT::scripting::CommandDataSource.

Definition at line 50 of file ActionInterface.cpp.

Referenced by RTT::scripting::StateMachine::activate(), RTT::internal::DataSourceCommand::reset(), RTT::scripting::CommandBinary::reset(), RTT::scripting::TryCommand::reset(), RTT::internal::ActionAliasDataSource< T >::reset(), RTT::internal::ActionAliasAssignableDataSource< T >::reset(), and RTT::scripting::VertexNode::startExecution().

bool ActionInterface::valid ( ) const

virtualinherited

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, RTT::scripting::TryCommand, and RTT::scripting::CommandBinary.

Definition at line 53 of file ActionInterface.cpp.

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

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.

References RTT::os::cout, and RTT::os::endl().

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

rtt/scripting/CommandIllegal.hpp
rtt/scripting/CommandIllegal.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation