mtsCommandVoid Class Reference
[Multi Task Support]

#include <mtsCommandVoid.h>

Inheritance diagram for mtsCommandVoid:

[legend]Collaboration diagram for mtsCommandVoid:

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 46 of file mtsCommandVoid.h.

Public Types

typedef mtsCommandBase BaseType
typedef mtsCommandVoid ThisType

Public Member Functions

mtsCommandVoid (void)
mtsCommandVoid (mtsCallableVoidBase *callable, const std::string &name)
virtual ~mtsCommandVoid ()
virtual mtsExecutionResult Execute (mtsBlockingType CMN_UNUSED(blocking))
mtsCallableVoidBase * GetCallable (void) const
void ToStream (std::ostream &outputStream) const
size_t NumberOfArguments (void) const
bool Returns (void) const

Protected Attributes

mtsCallableVoidBase * Callable

Member Typedef Documentation

typedef mtsCommandVoid mtsCommandVoid::ThisType

This type.

Reimplemented in mtsCommandQueuedVoid.

Definition at line 52 of file mtsCommandVoid.h.

Constructor & Destructor Documentation

mtsCommandVoid::mtsCommandVoid ( void )

The constructor. Does nothing.

mtsCommandVoid::mtsCommandVoid	(	mtsCallableVoidBase *	callable,
		const std::string &	name
	)

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 mtsCommandVoid::~mtsCommandVoid ( ) [virtual]

The destructor. Does nothing

Member Function Documentation

virtual mtsExecutionResult mtsCommandVoid::Execute ( mtsBlockingType CMN_UNUSED(blocking) ) [virtual]

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

mtsCallableVoidBase* mtsCommandVoid::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.

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

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

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedVoid, mtsCommandVoidProxy, and mtsMulticastCommandVoid.

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

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

Implements mtsCommandBase.