cisst-saw
|
#include <mtsCommandWrite.h>
Public Types | |
typedef mtsCommandWriteBase | BaseType |
typedef _classType | ClassType |
typedef mtsCommandWriteGeneric < ClassType > | ThisType |
typedef void(_classType::* | ActionType )(const mtsGenericObject &) |
![]() | |
typedef mtsCommandBase | BaseType |
Public Member Functions | |
mtsCommandWriteGeneric (ActionType action, ClassType *classInstantiation, const std::string &name, const mtsGenericObject *argumentPrototype) | |
virtual | ~mtsCommandWriteGeneric () |
mtsExecutionResult | Execute (const mtsGenericObject &argument, mtsBlockingType CMN_UNUSED(blocking)) |
mtsExecutionResult | Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler)) |
void | ToStream (std::ostream &outputStream) const |
![]() | |
mtsCommandWriteBase (void) | |
mtsCommandWriteBase (const std::string &name) | |
virtual | ~mtsCommandWriteBase () |
virtual mtsExecutionResult | Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0 |
size_t | NumberOfArguments (void) const |
bool | Returns (void) const |
virtual const mtsGenericObject * | GetArgumentPrototype (void) const |
const cmnClassServicesBase * | GetArgumentClassServices (void) const |
![]() | |
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 |
Protected Attributes | |
ActionType | Action |
ClassType * | ClassInstantiation |
![]() | |
const mtsGenericObject * | ArgumentPrototype |
![]() | |
std::string | Name |
bool | EnableFlag |
Additional Inherited Members | |
![]() | |
virtual void | SetArgumentPrototype (const mtsGenericObject *argumentPrototype) |
typedef void(_classType::* mtsCommandWriteGeneric< _classType >::ActionType)(const mtsGenericObject &) |
Typedef for pointer to member function of the specific interface class.
typedef mtsCommandWriteBase mtsCommandWriteGeneric< _classType >::BaseType |
typedef _classType mtsCommandWriteGeneric< _classType >::ClassType |
Typedef for the specific interface.
typedef mtsCommandWriteGeneric<ClassType> mtsCommandWriteGeneric< _classType >::ThisType |
This type.
|
inline |
The constructor.
action | Pointer to the member function that is to be called by the invoker of the command |
classInstantiation | Pointer to the receiver of the command |
name | A string to identify the command. |
|
inlinevirtual |
The destructor. Does nothing
|
inline |
The execute method. Calling the execute method from the invoker applies the operation on the receiver.
obj | The data passed to the operation method |
|
inlinevirtual |
The execute method. Method may be implemented by derived classes to run the actual operation on the receiver
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 |
Implements mtsCommandWriteBase.
|
inlinevirtual |
Implements mtsCommandBase.
|
protected |
The pointer to member function of the receiver class that is to be invoked for a particular instance of the command
|
protected |
Stores the receiver object of the command