This command is used to answer the OpenIGTLink messages "GET_IMGMETA" and "GET_IMAGE". "GET_IMGMETA" returns all the image information from the devices that are connected at the time given. \ "GET_IMAGE" returns the requested volume and the ijkToRasTransform which belongs to the volume. The Ras coordinate system is the coordinate system defined in Plus as: "Ras". \ The image id is empty when the command is GET_IMGMETA, which means the data will be acquired from all of the connected devices. \ It is the id of the image selected on slicer for the command GET_IMAGE. More...
#include <src/PlusServer/Commands/vtkPlusGetImageCommand.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) |
| void | SetNameToGetImage () |
| void | SetNameToGetImageMeta () |
| vtkGetStdStringMacro (ImageId) | |
| vtkSetStdStringMacro (ImageId) | |
 Public Member Functions inherited from vtkPlusCommand | |
| virtual int | GetClientId () |
| virtual uint32_t | GetId () |
| virtual bool | GetRespondWithCommandMessage () |
| void | PopCommandResponses (PlusCommandResponseList &responses) |
| virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *aConfig) |
| 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) | |
| virtual PlusStatus | WriteConfiguration (vtkXMLDataElement *aConfig) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPlusGetImageCommand * | New () |
| static vtkPlusGetImageCommand * | 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 | |
| PlusStatus | ExecuteImageMetaReply (std::string &outErrorString) |
| PlusStatus | ExecuteImageReply (std::string &outErrorString) |
| std::string | GetImageMetaDatasetsCountAsString () |
| vtkPlusGetImageCommand () | |
| virtual | ~vtkPlusGetImageCommand () |
| 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 | ImageId |
| int | ImageMetaDatasetsCount |
| 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 is used to answer the OpenIGTLink messages "GET_IMGMETA" and "GET_IMAGE". "GET_IMGMETA" returns all the image information from the devices that are connected at the time given. \ "GET_IMAGE" returns the requested volume and the ijkToRasTransform which belongs to the volume. The Ras coordinate system is the coordinate system defined in Plus as: "Ras". \ The image id is empty when the command is GET_IMGMETA, which means the data will be acquired from all of the connected devices. \ It is the id of the image selected on slicer for the command GET_IMAGE.
Definition at line 22 of file vtkPlusGetImageCommand.h.
Member Typedef Documentation
◆ Superclass
Definition at line 27 of file vtkPlusGetImageCommand.h.
Constructor & Destructor Documentation
◆ vtkPlusGetImageCommand()
|
protected |
Definition at line 25 of file vtkPlusGetImageCommand.cxx.
◆ ~vtkPlusGetImageCommand()
|
protectedvirtual |
Definition at line 32 of file vtkPlusGetImageCommand.cxx.
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Implements vtkPlusCommand.
Definition at line 29 of file vtkPlusGetImageCommand.h.
◆ Execute()
|
virtual |
Executes the command
Implements vtkPlusCommand.
Definition at line 80 of file vtkPlusGetImageCommand.cxx.
◆ ExecuteImageMetaReply()
|
protected |
Send the image meta datasets from all the connected devices to slicer through openigtlink
Definition at line 174 of file vtkPlusGetImageCommand.cxx.
◆ ExecuteImageReply()
|
protected |
Prepare sending image as a response
Definition at line 115 of file vtkPlusGetImageCommand.cxx.
◆ GetClassName()
|
virtual |
◆ GetCommandNames()
|
virtual |
Get all the command names that this class can execute
Implements vtkPlusCommand.
Definition at line 43 of file vtkPlusGetImageCommand.cxx.
◆ GetDescription()
|
virtual |
Gets the description for the specified command name.
Implements vtkPlusCommand.
Definition at line 51 of file vtkPlusGetImageCommand.cxx.
◆ GetImageMetaDatasetsCountAsString()
|
protected |
Return ImageMetaDatasetsCount as string
◆ IsA()
|
virtual |
◆ IsTypeOf()
|
static |
◆ New()
|
static |
◆ PrintSelf()
|
virtual |
Reimplemented from vtkPlusCommand.
Definition at line 37 of file vtkPlusGetImageCommand.cxx.
◆ SafeDownCast()
|
static |
◆ SetNameToGetImage()
| void vtkPlusGetImageCommand::SetNameToGetImage | ( | ) |
Definition at line 74 of file vtkPlusGetImageCommand.cxx.
◆ SetNameToGetImageMeta()
| void vtkPlusGetImageCommand::SetNameToGetImageMeta | ( | ) |
Definition at line 68 of file vtkPlusGetImageCommand.cxx.
◆ vtkGetStdStringMacro()
| vtkPlusGetImageCommand::vtkGetStdStringMacro | ( | ImageId | ) |
Id of the device
◆ vtkSetStdStringMacro()
| vtkPlusGetImageCommand::vtkSetStdStringMacro | ( | ImageId | ) |
Member Data Documentation
◆ ImageId
|
protected |
Definition at line 61 of file vtkPlusGetImageCommand.h.
◆ ImageMetaDatasetsCount
|
protected |
How many image meta datasets are in total in the connected devices
Definition at line 64 of file vtkPlusGetImageCommand.h.
The documentation for this class was generated from the following files:
- src/PlusServer/Commands/vtkPlusGetImageCommand.h
- src/PlusServer/Commands/vtkPlusGetImageCommand.cxx
