mtsMulticastCommandWriteBase Class Reference

#include <mtsMulticastCommandWriteBase.h>

Inheritance diagram for mtsMulticastCommandWriteBase:

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

Public Member Functions
	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 ()
virtual mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))=0
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 ()
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 mtsCommandWriteBase
const mtsGenericObject *	ArgumentPrototype
Protected Attributes inherited from mtsCommandBase
std::string	Name
bool	EnableFlag

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

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

BaseType

typedef mtsCommandWriteBase mtsMulticastCommandWriteBase::BaseType

VectorType

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

Constructor & Destructor Documentation

mtsMulticastCommandWriteBase()

mtsMulticastCommandWriteBase::mtsMulticastCommandWriteBase ( const std::string & name )

inline

Default constructor. Does nothing.

~mtsMulticastCommandWriteBase()

mtsMulticastCommandWriteBase::~mtsMulticastCommandWriteBase ( )

inline

Default destructor. Does nothing.

Member Function Documentation

AddCommand()

virtual bool mtsMulticastCommandWriteBase::AddCommand ( BaseType * command )

virtual

Add a command to the composite.

Execute()

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

pure virtual

Execute all the commands in the composite.

Implements mtsCommandWriteBase.

RemoveCommand()

virtual bool mtsMulticastCommandWriteBase::RemoveCommand ( BaseType * command )

virtual

Remove a command from the composite.

ToStream()

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

virtual

Implements mtsCommandBase.

Member Data Documentation

Commands

VectorType mtsMulticastCommandWriteBase::Commands

protected

---

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

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