mtsCommandVoidReturn Class Reference
[Multi Task Support]

#include <mtsCommandVoidReturn.h>

Inheritance diagram for mtsCommandVoidReturn:

[legend]Collaboration diagram for mtsCommandVoidReturn:

Detailed Description

A templated version of command object with zero arguments for execute. The template argument is the class type whose method is contained in the command object. This command is based on a void method, i.e. it requires the class and method name as well as an instantiation of the class to get and actual pointer on the method.

Definition at line 45 of file mtsCommandVoidReturn.h.

Public Types

typedef mtsCommandBase BaseType
typedef mtsCommandVoidReturn ThisType

Public Member Functions

mtsCommandVoidReturn (void)
mtsCommandVoidReturn (mtsCallableVoidReturnBase *callable, const std::string &name, const mtsGenericObject *resultPrototype)
virtual ~mtsCommandVoidReturn ()
virtual mtsExecutionResult Execute (mtsGenericObject &result)
mtsCallableVoidReturnBase * GetCallable (void) const
size_t NumberOfArguments (void) const
bool Returns (void) const
const mtsGenericObject * GetResultPrototype (void) const
void ToStream (std::ostream &outputStream) const

Protected Member Functions

void SetResultPrototype (const mtsGenericObject *resultPrototype)

Protected Attributes

mtsCallableVoidReturnBase * Callable
const mtsGenericObject * ResultPrototype

Member Typedef Documentation

typedef mtsCommandBase mtsCommandVoidReturn::BaseType

Base type

Reimplemented in mtsCommandQueuedVoidReturn.

Definition at line 49 of file mtsCommandVoidReturn.h.

typedef mtsCommandVoidReturn mtsCommandVoidReturn::ThisType

This type.

Reimplemented in mtsCommandQueuedVoidReturn.

Definition at line 52 of file mtsCommandVoidReturn.h.

Constructor & Destructor Documentation

mtsCommandVoidReturn::mtsCommandVoidReturn ( void )

The constructor. Does nothing.

mtsCommandVoidReturn::mtsCommandVoidReturn	(	mtsCallableVoidReturnBase *	callable,
		const std::string &	name,
		const mtsGenericObject *	resultPrototype
	)

The constructor.

Parameters:

	action	Pointer to the member function that is to be called by the invoker of the command
	classInstantiation	Pointer to the receiver of the command
	name	A string to identify the command.

virtual mtsCommandVoidReturn::~mtsCommandVoidReturn ( ) [virtual]

The destructor. Does nothing

Member Function Documentation

virtual mtsExecutionResult mtsCommandVoidReturn::Execute ( mtsGenericObject & result ) [virtual]

The execute method. Calling the execute method from the invoker applies the operation on the receiver.

Referenced by mtsFunctionVoidReturn::ConditionalWrap< _userType, >::Call(), and mtsFunctionVoidReturn::ConditionalWrap< _userType, true >::Call().

mtsCallableVoidReturnBase* mtsCommandVoidReturn::GetCallable ( void ) const

Get a direct pointer to the callable object. This method is used for queued commands. The caller should still use the Execute method which will queue the command. When the command is de-queued, one needs access to the callable object to call the final method or function.

size_t mtsCommandVoidReturn::NumberOfArguments ( void ) const [virtual]

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implements mtsCommandBase.

const mtsGenericObject* mtsCommandVoidReturn::GetResultPrototype ( void ) const

Return a pointer on the result prototype

void mtsCommandVoidReturn::ToStream ( std::ostream & outputStream ) const [virtual]

For debugging. Generate a human readable output for the command object

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedVoidReturn.