Inheritance diagram for mtsMulticastCommandWrite< _argumentType >:

Public Types
typedef mtsMulticastCommandWriteBase	BaseType

typedef _argumentType	ArgumentType

typedef mtsGenericTypes < ArgumentType > ::FinalBaseType	ArgumentFinalType

Public Types inherited from mtsMulticastCommandWriteBase
typedef mtsCommandWriteBase	BaseType

typedef std::vector< BaseType * >	VectorType

Public Types inherited from mtsCommandWriteBase
typedef mtsCommandBase	BaseType

Public Member Functions
	mtsMulticastCommandWrite (const std::string &name, const ArgumentType &argumentPrototype)

	~mtsMulticastCommandWrite ()

virtual mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType CMN_UNUSED(blocking))

mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))

Public Member Functions inherited from mtsMulticastCommandWriteBase
	mtsMulticastCommandWriteBase (const std::string &name)

	~mtsMulticastCommandWriteBase ()

virtual bool	AddCommand (BaseType *command)

virtual bool	RemoveCommand (BaseType *command)

virtual mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0

virtual void	ToStream (std::ostream &outputStream) const

Public Member Functions inherited from mtsCommandWriteBase
	mtsCommandWriteBase (void)

	mtsCommandWriteBase (const std::string &name)

virtual	~mtsCommandWriteBase ()

size_t	NumberOfArguments (void) const

bool	Returns (void) const

virtual const mtsGenericObject *	GetArgumentPrototype (void) const

const cmnClassServicesBase *	GetArgumentClassServices (void) const

Public Member Functions inherited from mtsCommandBase
	mtsCommandBase (void)

	mtsCommandBase (const std::string &name)

virtual	~mtsCommandBase ()

const std::string &	GetName (void) const

virtual std::string	ToString (void) const

void	Enable (void)

void	Disable (void)

bool	IsEnabled (void) const

bool	IsDisabled (void) const

Additional Inherited Members
Protected Member Functions inherited from mtsCommandWriteBase
virtual void	SetArgumentPrototype (const mtsGenericObject *argumentPrototype)

Protected Attributes inherited from mtsMulticastCommandWriteBase
VectorType	Commands

Protected Attributes inherited from mtsCommandWriteBase
const mtsGenericObject *	ArgumentPrototype

Protected Attributes inherited from mtsCommandBase
std::string	Name

bool	EnableFlag

Detailed Description

This class contains a vector of two or more command objects. The primary use of this class is to send events to all observers.

Member Typedef Documentation

template<class _argumentType>

template<class _argumentType>

typedef _argumentType mtsMulticastCommandWrite< _argumentType >::ArgumentType

template<class _argumentType>

template<class _argumentType>

mtsMulticastCommandWrite< _argumentType >::mtsMulticastCommandWrite	(	const std::string &	name,
		const ArgumentType &	argumentPrototype
	)

inline

Default constructor. Does nothing.

template<class _argumentType>

mtsMulticastCommandWrite< _argumentType >::~mtsMulticastCommandWrite ( )

inline

Default destructor. Does nothing.

template<class _argumentType>

virtual mtsExecutionResult mtsMulticastCommandWrite< _argumentType >::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	CMN_UNUSEDblocking
	)

inlinevirtual

Execute all the commands in the composite.

template<class _argumentType>

mtsExecutionResult mtsMulticastCommandWrite< _argumentType >::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	blocking,
		mtsCommandWriteBase *	CMN_UNUSEDfinishedEventHandler
	)

inlinevirtual

The execute method. Method may be implemented by derived classes to run the actual operation on the receiver

Parameters

argument	The data passed to the operation method
blocking	Indicates whether caller wishes to block until command finishes
finishedEventHandler	Command object to invoke when blocking command is finished

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsForwardDeclarations.h
/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsMulticastCommandWrite.h