This command requests camera control parameter change in the client. More...
#include <src/PlusServer/Commands/vtkPlusSetCameraControlParameterCommand.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 | SetNameToSetCameraControlParameter () |
| vtkGetStdStringMacro (CameraDeviceId) | |
| vtkSetStdStringMacro (CameraDeviceId) | |
| 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 vtkPlusSetCameraControlParameterCommand * | New () |
| static vtkPlusSetCameraControlParameterCommand * | 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 | |
| vtkPlusDevice * | GetCameraDevice () |
| void | operator= (const vtkPlusSetCameraControlParameterCommand &) |
| vtkPlusSetCameraControlParameterCommand () | |
| vtkPlusSetCameraControlParameterCommand (const vtkPlusSetCameraControlParameterCommand &) | |
| virtual | ~vtkPlusSetCameraControlParameterCommand () |
| 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::string | CameraDeviceId |
| std::map< std::string, std::string > | RequestedParameterChanges |
| 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 camera control parameter change in the client.
Definition at line 19 of file vtkPlusSetCameraControlParameterCommand.h.
Member Typedef Documentation
◆ Superclass
Definition at line 24 of file vtkPlusSetCameraControlParameterCommand.h.
Constructor & Destructor Documentation
◆ vtkPlusSetCameraControlParameterCommand() [1/2]
|
protected |
Definition at line 32 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ ~vtkPlusSetCameraControlParameterCommand()
|
protectedvirtual |
Definition at line 39 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ vtkPlusSetCameraControlParameterCommand() [2/2]
|
protected |
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Implements vtkPlusCommand.
Definition at line 26 of file vtkPlusSetCameraControlParameterCommand.h.
◆ Execute()
|
virtual |
Executes the command
Implements vtkPlusCommand.
Definition at line 132 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ GetCameraDevice()
|
protected |
Definition at line 258 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ GetClassName()
|
virtual |
◆ GetCommandNames()
|
virtual |
Get all the command names that this class can execute
Implements vtkPlusCommand.
Definition at line 57 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ GetDescription()
|
virtual |
Gets the description for the specified command name.
Implements vtkPlusCommand.
Definition at line 64 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ IsA()
|
virtual |
◆ IsTypeOf()
|
static |
◆ New()
|
static |
◆ operator=()
|
protected |
◆ PrintSelf()
|
virtual |
Reimplemented from vtkPlusCommand.
Definition at line 51 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ ReadConfiguration()
|
virtual |
Read command parameters from XML
Reimplemented from vtkPlusCommand.
Definition at line 76 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ SafeDownCast()
|
static |
◆ SetNameToSetCameraControlParameter()
| void vtkPlusSetCameraControlParameterCommand::SetNameToSetCameraControlParameter | ( | ) |
Definition at line 45 of file vtkPlusSetCameraControlParameterCommand.cxx.
◆ vtkGetStdStringMacro()
| vtkPlusSetCameraControlParameterCommand::vtkGetStdStringMacro | ( | CameraDeviceId | ) |
Id of the camera device to change the parameters of at the next Execute
◆ vtkSetStdStringMacro()
| vtkPlusSetCameraControlParameterCommand::vtkSetStdStringMacro | ( | CameraDeviceId | ) |
◆ WriteConfiguration()
|
virtual |
Write command parameters to XML
Reimplemented from vtkPlusCommand.
Definition at line 108 of file vtkPlusSetCameraControlParameterCommand.cxx.
Member Data Documentation
◆ CameraDeviceId
|
protected |
Definition at line 56 of file vtkPlusSetCameraControlParameterCommand.h.
◆ 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 63 of file vtkPlusSetCameraControlParameterCommand.h.
The documentation for this class was generated from the following files:
- src/PlusServer/Commands/vtkPlusSetCameraControlParameterCommand.h
- src/PlusServer/Commands/vtkPlusSetCameraControlParameterCommand.cxx
