cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
mtsMulticastCommandWriteGeneric Class Reference

#include <mtsMulticastCommandWrite.h>

Inheritance diagram for mtsMulticastCommandWriteGeneric:
mtsMulticastCommandWriteBase mtsCommandWriteBase mtsCommandBase

Public Types

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

Public Member Functions

 mtsMulticastCommandWriteGeneric (const std::string &name, const mtsGenericObject &argumentPrototype)
 
 ~mtsMulticastCommandWriteGeneric ()
 
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 mtsGenericObjectGetArgumentPrototype (void) const
 
const cmnClassServicesBaseGetArgumentClassServices (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 mtsGenericObjectArgumentPrototype
 
- Protected Attributes inherited from mtsCommandBase
std::string Name
 
bool EnableFlag
 

Member Typedef Documentation

Constructor & Destructor Documentation

mtsMulticastCommandWriteGeneric::mtsMulticastCommandWriteGeneric ( const std::string &  name,
const mtsGenericObject argumentPrototype 
)
inline

Default constructor. Does nothing.

mtsMulticastCommandWriteGeneric::~mtsMulticastCommandWriteGeneric ( )
inline

Default destructor. Does nothing.

Member Function Documentation

virtual mtsExecutionResult mtsMulticastCommandWriteGeneric::Execute ( const mtsGenericObject argument,
mtsBlockingType   CMN_UNUSEDblocking 
)
inlinevirtual

Execute all the commands in the composite.

mtsExecutionResult mtsMulticastCommandWriteGeneric::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
argumentThe data passed to the operation method
blockingIndicates whether caller wishes to block until command finishes
finishedEventHandlerCommand object to invoke when blocking command is finished
Returns
the execution result (mtsExecutionResult)

Implements mtsCommandWriteBase.


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