cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
mtsCommandWriteBase Class Referenceabstract
cisstMultiTask

#include <mtsCommandWriteBase.h>

Inheritance diagram for mtsCommandWriteBase:
mtsCommandBase mtsCommandFilteredWrite mtsCommandQueuedWriteBase mtsCommandWrite< _classType, _argumentType > mtsCommandWriteGeneric< _classType > mtsMulticastCommandWriteBase mtsCommandQueuedWrite< _argumentType > mtsCommandQueuedWriteGeneric mtsMulticastCommandWrite< _argumentType > mtsMulticastCommandWriteGeneric mtsCommandFilteredQueuedWrite

Public Types

typedef mtsCommandBase BaseType
 

Public Member Functions

 mtsCommandWriteBase (void)
 
 mtsCommandWriteBase (const std::string &name)
 
virtual ~mtsCommandWriteBase ()
 
virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0
 
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 ()
 
const std::string & GetName (void) const
 
virtual std::string ToString (void) const
 
virtual void ToStream (std::ostream &outputStream) const =0
 
void Enable (void)
 
void Disable (void)
 
bool IsEnabled (void) const
 
bool IsDisabled (void) const
 

Protected Member Functions

virtual void SetArgumentPrototype (const mtsGenericObject *argumentPrototype)
 

Protected Attributes

const mtsGenericObject * ArgumentPrototype
 
- Protected Attributes inherited from mtsCommandBase
std::string Name
 
bool EnableFlag
 

Friends

class mtsMulticastCommandWriteBase
 
class mtsCommandQueuedWriteGeneric
 

Detailed Description

A base class of command object with an execute method that takes one argument.

Member Typedef Documentation

typedef mtsCommandBase mtsCommandWriteBase::BaseType

Constructor & Destructor Documentation

mtsCommandWriteBase::mtsCommandWriteBase ( void  )
inline

The constructor. Does nothing

mtsCommandWriteBase::mtsCommandWriteBase ( const std::string &  name)
inline
virtual mtsCommandWriteBase::~mtsCommandWriteBase ( )
inlinevirtual

The destructor. Does nothing

Member Function Documentation

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

The execute method. Abstract method to 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
Returns
the execution result (mtsExecutionResult)

Implemented in mtsCommandQueuedWriteBase, mtsMulticastCommandWriteBase, and mtsCommandFilteredWrite.

virtual mtsExecutionResult mtsCommandWriteBase::Execute ( const mtsGenericObject &  argument,
mtsBlockingType  blocking,
mtsCommandWriteBase *  CMN_UNUSEDfinishedEventHandler 
)
pure virtual

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)

Implemented in mtsCommandWriteGeneric< _classType >, mtsCommandWrite< _classType, _argumentType >, mtsMulticastCommandWriteGeneric, mtsMulticastCommandWrite< _argumentType >, and mtsCommandFilteredWrite.

const cmnClassServicesBase* mtsCommandWriteBase::GetArgumentClassServices ( void  ) const
inline

Return const pointer of class services associated to the argument type.

virtual const mtsGenericObject* mtsCommandWriteBase::GetArgumentPrototype ( void  ) const
inlinevirtual

Return a pointer on the argument prototype

Reimplemented in mtsCommandQueuedWriteGeneric, mtsCommandQueuedWrite< _argumentType >, mtsCommandFilteredWrite, and mtsCommandFilteredQueuedWrite.

size_t mtsCommandWriteBase::NumberOfArguments ( void  ) const
inlinevirtual

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

Implements mtsCommandBase.

bool mtsCommandWriteBase::Returns ( void  ) const
inlinevirtual

Implements mtsCommandBase.

virtual void mtsCommandWriteBase::SetArgumentPrototype ( const mtsGenericObject *  argumentPrototype)
inlineprotectedvirtual

Reimplemented in mtsCommandQueuedWriteGeneric.

Friends And Related Function Documentation

friend class mtsCommandQueuedWriteGeneric
friend
friend class mtsMulticastCommandWriteBase
friend

Member Data Documentation

const mtsGenericObject* mtsCommandWriteBase::ArgumentPrototype
protected
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.6