This command requests ultrasound parameter change in the client. More...
#include <src/PlusServer/Commands/vtkPlusSetUsParameterCommand.h>
Public Types | |
| typedef vtkPlusCommand | Superclass |
Public Member Functions | |
| virtual vtkPlusCommand * | Clone () |
| virtual PlusStatus | Execute () |
| virtual const char * | GetClassName () |
| virtual void | GetCommandNames (std::list< std::string > &cmdNames) |
| virtual std::string | GetDescription (const std::string &commandName) |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *aConfig) |
| void | SetNameToSetUsParameter () |
| vtkGetStdStringMacro (UsDeviceId) | |
| vtkSetStdStringMacro (UsDeviceId) | |
| virtual PlusStatus | WriteConfiguration (vtkXMLDataElement *aConfig) |
 Public Member Functions inherited from vtkPlusCommand | |
| virtual int | GetClientId () |
| virtual uint32_t | GetId () |
| virtual bool | GetRespondWithCommandMessage () |
| void | PopCommandResponses (PlusCommandResponseList &responses) |
| virtual void | SetClientId (int) |
| virtual void | SetCommandProcessor (vtkPlusCommandProcessor *processor) |
| virtual void | SetId (uint32_t) |
| void | SetMetaData (const igtl::MessageBase::MetaDataMap &metaData) |
| virtual void | SetRespondWithCommandMessage (bool) |
| vtkGetStdStringMacro (Name) | |
| vtkGetStdStringMacro (DeviceName) | |
| vtkSetStdStringMacro (Name) | |
| vtkSetStdStringMacro (DeviceName) | |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPlusSetUsParameterCommand * | New () |
| static vtkPlusSetUsParameterCommand * | SafeDownCast (vtkObject *o) |
| Static Public Member Functions inherited from vtkPlusCommand | |
| static PlusStatus | GenerateCommandDeviceName (const std::string &uid, std::string &outDeviceName) |
| static std::string | GenerateReplyDeviceName (uint32_t uid) |
| static std::string | GetPrefixFromCommandDeviceName (const std::string &deviceName) |
| static std::string | GetUidFromCommandDeviceName (const std::string &deviceName) |
| static bool | IsCommandDeviceName (const std::string &deviceName) |
| static bool | IsReplyDeviceName (const std::string &deviceName, const std::string &uid=std::string("")) |
Protected Member Functions | |
| vtkPlusUsDevice * | GetUsDevice () |
| void | operator= (const vtkPlusSetUsParameterCommand &) |
| vtkPlusSetUsParameterCommand () | |
| vtkPlusSetUsParameterCommand (const vtkPlusSetUsParameterCommand &) | |
| virtual | ~vtkPlusSetUsParameterCommand () |
| Protected Member Functions inherited from vtkPlusCommand | |
| virtual vtkPlusDataCollector * | GetDataCollector () |
| virtual vtkIGSIOTransformRepository * | GetTransformRepository () |
| void | QueueCommandResponse (PlusStatus status, const std::string &message, const std::string &error="", const igtl::MessageBase::MetaDataMap *metaData=nullptr) |
| PlusStatus | ValidateName () |
| vtkPlusCommand () | |
| virtual | ~vtkPlusCommand () |
Protected Attributes | |
| std::map< std::string, std::string > | RequestedParameterChanges |
| std::string | UsDeviceId |
| Protected Attributes inherited from vtkPlusCommand | |
| int | ClientId |
| vtkPlusCommandProcessor * | CommandProcessor |
| PlusCommandResponseList | CommandResponseQueue |
| std::string | DeviceName |
| uint32_t | Id |
| igtl::MessageBase::MetaDataMap | MetaData |
| std::string | Name |
| bool | RespondWithCommandMessage |
Additional Inherited Members | |
| Static Public Attributes inherited from vtkPlusCommand | |
| static const std::string | DEVICE_NAME_COMMAND = "CMD" |
| static const std::string | DEVICE_NAME_REPLY = "ACK" |
Detailed Description
This command requests ultrasound parameter change in the client.
Definition at line 21 of file vtkPlusSetUsParameterCommand.h.
Member Typedef Documentation
◆ Superclass
Definition at line 26 of file vtkPlusSetUsParameterCommand.h.
Constructor & Destructor Documentation
◆ vtkPlusSetUsParameterCommand() [1/2]
|
protected |
Definition at line 32 of file vtkPlusSetUsParameterCommand.cxx.
◆ ~vtkPlusSetUsParameterCommand()
|
protectedvirtual |
Definition at line 39 of file vtkPlusSetUsParameterCommand.cxx.
◆ vtkPlusSetUsParameterCommand() [2/2]
|
protected |
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Implements vtkPlusCommand.
Definition at line 28 of file vtkPlusSetUsParameterCommand.h.
◆ Execute()
|
virtual |
Executes the command
Implements vtkPlusCommand.
Definition at line 134 of file vtkPlusSetUsParameterCommand.cxx.
◆ GetClassName()
|
virtual |
◆ GetCommandNames()
|
virtual |
Get all the command names that this class can execute
Implements vtkPlusCommand.
Definition at line 57 of file vtkPlusSetUsParameterCommand.cxx.
◆ GetDescription()
|
virtual |
Gets the description for the specified command name.
Implements vtkPlusCommand.
Definition at line 64 of file vtkPlusSetUsParameterCommand.cxx.
◆ GetUsDevice()
|
protected |
Definition at line 273 of file vtkPlusSetUsParameterCommand.cxx.
◆ IsA()
|
virtual |
◆ IsTypeOf()
|
static |
◆ New()
|
static |
◆ operator=()
|
protected |
◆ PrintSelf()
|
virtual |
Reimplemented from vtkPlusCommand.
Definition at line 51 of file vtkPlusSetUsParameterCommand.cxx.
◆ ReadConfiguration()
|
virtual |
Read command parameters from XML
Reimplemented from vtkPlusCommand.
Definition at line 78 of file vtkPlusSetUsParameterCommand.cxx.
◆ SafeDownCast()
|
static |
◆ SetNameToSetUsParameter()
| void vtkPlusSetUsParameterCommand::SetNameToSetUsParameter | ( | ) |
Definition at line 45 of file vtkPlusSetUsParameterCommand.cxx.
◆ vtkGetStdStringMacro()
| vtkPlusSetUsParameterCommand::vtkGetStdStringMacro | ( | UsDeviceId | ) |
Id of the ultrasound device to change the parameters of at the next Execute
◆ vtkSetStdStringMacro()
| vtkPlusSetUsParameterCommand::vtkSetStdStringMacro | ( | UsDeviceId | ) |
◆ WriteConfiguration()
|
virtual |
Write command parameters to XML
Reimplemented from vtkPlusCommand.
Definition at line 110 of file vtkPlusSetUsParameterCommand.cxx.
Member Data Documentation
◆ RequestedParameterChanges
|
protected |
List of requested parameter changes. Key is the parameter name (e.g. DepthMm), value is the parameter value. The Execute function traverses this map and requests the parameter changes from the device.
Definition at line 65 of file vtkPlusSetUsParameterCommand.h.
◆ UsDeviceId
|
protected |
Definition at line 58 of file vtkPlusSetUsParameterCommand.h.
The documentation for this class was generated from the following files:
- src/PlusServer/Commands/vtkPlusSetUsParameterCommand.h
- src/PlusServer/Commands/vtkPlusSetUsParameterCommand.cxx
