mtsMulticastCommandVoid Class Reference

#include <mtsMulticastCommandVoid.h>

Inheritance diagram for mtsMulticastCommandVoid:

Public Types
typedef mtsCommandVoid	BaseType
typedef std::vector< BaseType * >	VectorType
Public Types inherited from mtsCommandVoid
typedef mtsCommandBase	BaseType
typedef mtsCommandVoid	ThisType

Public Member Functions
	mtsMulticastCommandVoid (const std::string &name)
	~mtsMulticastCommandVoid ()
virtual bool	AddCommand (BaseType *command)
virtual bool	RemoveCommand (BaseType *command)
virtual mtsExecutionResult	Execute (mtsBlockingType CMN_UNUSED(blocking))
virtual void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsCommandVoid
	mtsCommandVoid (void)
	mtsCommandVoid (mtsCallableVoidBase *callable, const std::string &name)
virtual	~mtsCommandVoid ()
virtual mtsExecutionResult	Execute (mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))
mtsCallableVoidBase *	GetCallable (void) const
size_t	NumberOfArguments (void) const
bool	Returns (void) const
Public Member Functions inherited from mtsCommandBase
	mtsCommandBase (void)
	mtsCommandBase (const std::string &name)
virtual	~mtsCommandBase ()
virtual std::string	ToString (void) const
void	Enable (void)
void	Disable (void)
bool	IsEnabled (void) const
bool	IsDisabled (void) const
const std::string &	GetName (void) const

Protected Attributes
VectorType	Commands
Protected Attributes inherited from mtsCommandVoid
mtsCallableVoidBase *	Callable
Protected Attributes inherited from mtsCommandBase
std::string	Name
bool	EnableFlag

Detailed Description

This class contains a vector of two or more command objects. Currently it is used by composite interface, where the command needs to be chained, such that it is executed on more than one interface. This is the no argument version, that is the execute method takes no argument.

Member Typedef Documentation

BaseType

typedef mtsCommandVoid mtsMulticastCommandVoid::BaseType

VectorType

typedef std::vector<BaseType *> mtsMulticastCommandVoid::VectorType

Constructor & Destructor Documentation

mtsMulticastCommandVoid()

mtsMulticastCommandVoid::mtsMulticastCommandVoid

(

const std::string &

name

)

Default constructor. Does nothing.

~mtsMulticastCommandVoid()

mtsMulticastCommandVoid::~mtsMulticastCommandVoid

(

)

Default destructor. Does nothing.

Member Function Documentation

AddCommand()

virtual bool mtsMulticastCommandVoid::AddCommand ( BaseType * command )

virtual

Add a command to the composite.

Execute()

virtual mtsExecutionResult mtsMulticastCommandVoid::Execute ( mtsBlockingType CMN_UNUSEDblocking )

virtual

Execute all the commands in the composite.

Reimplemented from mtsCommandVoid.

RemoveCommand()

virtual bool mtsMulticastCommandVoid::RemoveCommand ( BaseType * command )

virtual

Remove a command from the composite.

ToStream()

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

virtual

Reimplemented from mtsCommandVoid.

Member Data Documentation

Commands

VectorType mtsMulticastCommandVoid::Commands

protected

Vector to commands that constitute the composite command.

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsMulticastCommandVoid.h