Definition at line 44 of file mtsCommandBase.h.
| mtsCommandBase::mtsCommandBase | ( | void | ) | [inline] |
The constructor. Does nothing
Definition at line 63 of file mtsCommandBase.h.
| mtsCommandBase::mtsCommandBase | ( | const std::string & | name | ) | [inline] |
Constructor with command name.
Definition at line 69 of file mtsCommandBase.h.
| virtual mtsCommandBase::~mtsCommandBase | ( | ) | [inline, virtual] |
The destructor. Does nothing
Definition at line 75 of file mtsCommandBase.h.
| virtual std::string mtsCommandBase::ToString | ( | void | ) | const [inline, virtual] |
For debugging. Generate a human readable output for the command object
Definition at line 80 of file mtsCommandBase.h.
References ToStream().
| virtual void mtsCommandBase::ToStream | ( | std::ostream & | outputStream | ) | const [pure virtual] |
For debugging. Generate a human readable output for the command object
Implemented in mtsCommandFilteredWrite, mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >, mtsCommandQualifiedReadBase, mtsCommandQualifiedReadProxy, mtsCommandQueuedVoid, mtsCommandQueuedVoidReturn, mtsCommandQueuedWriteGeneric, mtsCommandQueuedWriteBase, mtsCommandQueuedWriteReturn, mtsCommandRead, mtsCommandReadProxy, mtsCommandVoid, mtsCommandVoidProxy, mtsCommandVoidReturn, mtsCommandWrite< _classType, _argumentType >, mtsCommandWriteGeneric< _classType >, mtsCommandWriteProxy, mtsCommandWriteReturn, mtsMulticastCommandVoid, and mtsMulticastCommandWriteBase.
Referenced by operator<<(), and ToString().
| virtual size_t mtsCommandBase::NumberOfArguments | ( | void | ) | const [pure virtual] |
Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.
| void mtsCommandBase::Enable | ( | void | ) | [inline] |
Set and access the "enable" flag. This flag is used to determine if the command actually uses the provided method or function when it is executed.
Definition at line 98 of file mtsCommandBase.h.
References EnableFlag.
| void mtsCommandBase::Disable | ( | void | ) | [inline] |
Set and access the "enable" flag. This flag is used to determine if the command actually uses the provided method or function when it is executed.
Definition at line 102 of file mtsCommandBase.h.
References EnableFlag.
Referenced by mtsCommandQualifiedReadProxy::mtsCommandQualifiedReadProxy(), mtsCommandReadProxy::mtsCommandReadProxy(), mtsCommandVoidProxy::mtsCommandVoidProxy(), and mtsCommandWriteProxy::mtsCommandWriteProxy().
| bool mtsCommandBase::IsEnabled | ( | void | ) | const [inline] |
Set and access the "enable" flag. This flag is used to determine if the command actually uses the provided method or function when it is executed.
Definition at line 106 of file mtsCommandBase.h.
References EnableFlag.
Referenced by mtsCommandWriteGeneric< _classType >::ToStream(), mtsCommandVoidProxy::ToStream(), mtsCommandWrite< _classType, _argumentType >::ToStream(), mtsCommandQualifiedReadProxy::ToStream(), mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ToStream(), mtsCommandReadProxy::ToStream(), and mtsCommandWriteProxy::ToStream().
| bool mtsCommandBase::IsDisabled | ( | void | ) | const [inline] |
Set and access the "enable" flag. This flag is used to determine if the command actually uses the provided method or function when it is executed.
Definition at line 110 of file mtsCommandBase.h.
References EnableFlag.
Referenced by mtsCommandVoidProxy::Execute(), mtsCommandQualifiedReadProxy::Execute(), mtsCommandReadProxy::Execute(), and mtsCommandWriteProxy::Execute().
| const std::string& mtsCommandBase::GetName | ( | void | ) | const [inline] |
Get the command name. This method doesn't allow to change the command name.
Definition at line 117 of file mtsCommandBase.h.
References Name.
std::string mtsCommandBase::Name [protected] |
Name used for the command. The name is provided to the constructor and can be accessed using the method GetName().
Definition at line 53 of file mtsCommandBase.h.
Referenced by mtsCommandQueuedWrite< _argumentType >::Execute(), GetName(), mtsCommandWriteGeneric< _classType >::ToStream(), mtsCommandVoidProxy::ToStream(), mtsCommandWrite< _classType, _argumentType >::ToStream(), mtsCommandQualifiedReadProxy::ToStream(), mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ToStream(), mtsCommandReadProxy::ToStream(), and mtsCommandWriteProxy::ToStream().
bool mtsCommandBase::EnableFlag [protected] |
Flag used to determine is the command actually executes the provided method or function. This "gated" command can be useful to turn on/off and event callback or to prevent calling a method owned by an object being deleted.
Definition at line 59 of file mtsCommandBase.h.
Referenced by Disable(), Enable(), IsDisabled(), and IsEnabled().