RTT::CommandExecFunction Class Reference

A command which queues (dispatches) a FunctionFraph for execution in a ProgramProcessor. More...

#include <rtt/CommandExecFunction.hpp>

Inheritance diagram for RTT::CommandExecFunction:

Public Types
enum	Status { NotReady, Ready, Sent, NotAccepted, Accepted, Executed, NotValid, Valid, Done }
	The status progressions of a Dispatchable Command. More...
typedef boost::shared_ptr < DispatchInterface >	shared_ptr
	If you want to share ownership of DispatchInterface instances, use this shared_ptr type.
typedef CommandInterface_ptr	_ptr_type
typedef CommandInterface_var	_var_type
typedef CommandInterface_out	_out_type
Public Member Functions
	CommandExecFunction (CommandInterface init_com, boost::shared_ptr< ProgramInterface > foo, ProgramProcessor p, AssignableDataSource< ProgramInterface * > v=0, AssignableDataSource< bool > a=0)
	Create a Command to send a function to a ProgramProcessor.
void	readArguments ()
bool	ready () const
	The command's effect is done.
bool	dispatch ()
	Dispatch a command.
bool	execute ()
void	reset ()
	After reset(), another attempt to dispatch the command will be made upon execute().
virtual bool	sent () const
	Returns true if the command was sent to the CommandProcessor.
virtual bool	accepted () const
	Returns true if the command was accepted when sent to the CommandProcessor.
virtual bool	executed () const
	Returns true if the command was executed by the CommandProcessor.
virtual bool	valid () const
	Returns true if the command was valid, i.e.
virtual bool	done () const
	Returns true if the command is done.
ConditionInterface *	createCondition () const
	Create a condition which checks if this command is finished or not.
DispatchInterface *	clone () const
DispatchInterface *	copy (std::map< const DataSourceBase , DataSourceBase > &alreadyCloned) const
virtual ::RTT::Corba::CommandList *	getCommands (void)
virtual ::RTT::Corba::Descriptions *	getArguments (const char *command)
virtual char *	getResultType (const char *command)
virtual char *	getDescription (const char *command)
virtual ::RTT::Corba::Command_ptr	createCommand (const char *command, const ::RTT::Corba::Arguments &args)
virtual ::RTT::Corba::Command_ptr	createCommandAny (const char *command, const ::RTT::Corba::AnyArguments &args)
virtual ::CORBA::Boolean	_is_a (const char *type_id)
virtual const char *	_interface_repository_id (void) const
virtual ::CORBA::Boolean	marshal (TAO_OutputCDR &cdr)
Static Public Member Functions
static CommandInterface_ptr	_duplicate (CommandInterface_ptr obj)
static void	_tao_release (CommandInterface_ptr obj)
static CommandInterface_ptr	_narrow (::CORBA::Object_ptr obj)
static CommandInterface_ptr	_unchecked_narrow (::CORBA::Object_ptr obj)
static CommandInterface_ptr	_nil (void)
static void	_tao_any_destructor (void *)
Protected Member Functions
virtual void	RTT_Corba_CommandInterface_setup_collocation (void)
Friends
class	TAO::Narrow_Utils< CommandInterface >

Detailed Description

A command which queues (dispatches) a FunctionFraph for execution in a ProgramProcessor.

See ConditionExecFunction to check if it is done or not.

Definition at line 85 of file CommandExecFunction.hpp.

Member Enumeration Documentation

enum RTT::DispatchInterface::Status [inherited]

The status progressions of a Dispatchable Command.

The order of these enums is important and should not be altered.

Enumerator:

Ready	The command is not yet initialised.
Sent	The command is ready for execution.
NotAccepted	The command has been sent/dispatched to the CommandProcessor.
Accepted	The command was not accepted by the CommandProcessor.
Executed	The command was accepted by the CommandProcessor.
NotValid	The command was executed by the CommandProcessor.
Valid	The command's arguments were found to be invalid.
Done	The command's arguments were valid.

Definition at line 65 of file DispatchInterface.hpp.

Constructor & Destructor Documentation

RTT::CommandExecFunction::CommandExecFunction	(	CommandInterface *	init_com,
		boost::shared_ptr< ProgramInterface >	foo,
		ProgramProcessor *	p,
		AssignableDataSource< ProgramInterface * > *	v = `0`,
		AssignableDataSource< bool > *	a = `0`
	)

Create a Command to send a function to a ProgramProcessor.

Parameters:

	init_com	The command to execute before sending the function into the processor, in order to initialise it.
	foo	The function to run in the processor.
	p	The target processor which will run the function.
	v	Implementation specific parameter to support copy/clone semantics.