vtkPlusStealthLinkCommand Class Reference

This command reconstructs a volume from an image sequence and saves it to disk or sends it to the client in an IMAGE message. More...

#include <src/PlusServer/Commands/vtkPlusStealthLinkCommand.h>

Inheritance diagram for vtkPlusStealthLinkCommand:

Collaboration diagram for vtkPlusStealthLinkCommand:

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 bool	GetKeepReceivedDicomFiles ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
virtual void	SetKeepReceivedDicomFiles (bool)
void	SetNameToGetExam ()
	vtkGetStdStringMacro (StealthLinkDeviceId)
	vtkGetStdStringMacro (DicomImagesOutputDirectory)
	vtkGetStdStringMacro (VolumeEmbeddedTransformToFrame)
	vtkSetStdStringMacro (StealthLinkDeviceId)
	vtkSetStdStringMacro (DicomImagesOutputDirectory)
	vtkSetStdStringMacro (VolumeEmbeddedTransformToFrame)
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 vtkPlusStealthLinkCommand *	New ()
static vtkPlusStealthLinkCommand *	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
vtkPlusStealthLinkTracker *	GetStealthLinkDevice ()
PlusStatus	ProcessImageReply (const std::string &imageId, vtkImageData *volumeToSend, vtkMatrix4x4 *imageToReferenceOrientationMatrixWithSpacing, std::string &resultMessage)
	vtkPlusStealthLinkCommand ()
virtual	~vtkPlusStealthLinkCommand ()
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	DicomImagesOutputDirectory
bool	KeepReceivedDicomFiles
std::string	StealthLinkDeviceId
std::string	VolumeEmbeddedTransformToFrame
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 reconstructs a volume from an image sequence and saves it to disk or sends it to the client in an IMAGE message.

Definition at line 23 of file vtkPlusStealthLinkCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusStealthLinkCommand::Superclass

Definition at line 27 of file vtkPlusStealthLinkCommand.h.

Constructor & Destructor Documentation

vtkPlusStealthLinkCommand()

vtkPlusStealthLinkCommand::vtkPlusStealthLinkCommand ( )

protected

Definition at line 29 of file vtkPlusStealthLinkCommand.cxx.

~vtkPlusStealthLinkCommand()

vtkPlusStealthLinkCommand::~vtkPlusStealthLinkCommand ( )

protectedvirtual

Definition at line 35 of file vtkPlusStealthLinkCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusStealthLinkCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 29 of file vtkPlusStealthLinkCommand.h.

Execute()

PlusStatus vtkPlusStealthLinkCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 121 of file vtkPlusStealthLinkCommand.cxx.

GetClassName()

virtual const char* vtkPlusStealthLinkCommand::GetClassName ( )

virtual

GetCommandNames()

void vtkPlusStealthLinkCommand::GetCommandNames ( std::list< std::string > &  cmdNames )

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 46 of file vtkPlusStealthLinkCommand.cxx.

GetDescription()

std::string vtkPlusStealthLinkCommand::GetDescription ( const std::string &  commandName )

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 53 of file vtkPlusStealthLinkCommand.cxx.

GetKeepReceivedDicomFiles()

virtual bool vtkPlusStealthLinkCommand::GetKeepReceivedDicomFiles ( )

virtual

If enabled then the DICOM files received through StealthLink will be preserved in the DicomImagesOutputDirectory. If disabled then the DICOM files are deleted after the volume is sent through OpenIGTLink.

GetStealthLinkDevice()

vtkPlusStealthLinkTracker * vtkPlusStealthLinkCommand::GetStealthLinkDevice ( )

protected

Definition at line 183 of file vtkPlusStealthLinkCommand.cxx.

IsA()

virtual int vtkPlusStealthLinkCommand::IsA ( const char *  type )

virtual

IsTypeOf()

static int vtkPlusStealthLinkCommand::IsTypeOf ( const char *  type )

static

New()

static vtkPlusStealthLinkCommand* vtkPlusStealthLinkCommand::New ( )

static

PrintSelf()

void vtkPlusStealthLinkCommand::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Reimplemented from vtkPlusCommand.

Definition at line 40 of file vtkPlusStealthLinkCommand.cxx.

ProcessImageReply()

PlusStatus vtkPlusStealthLinkCommand::ProcessImageReply ( const std::string &  imageId, vtkImageData *  volumeToSend, vtkMatrix4x4 *  imageToReferenceOrientationMatrixWithSpacing, std::string &  resultMessage  )

protected

Saves image to disk (if requested) and prepare sending image as a response (if requested)

Definition at line 167 of file vtkPlusStealthLinkCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusStealthLinkCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 71 of file vtkPlusStealthLinkCommand.cxx.

SafeDownCast()

static vtkPlusStealthLinkCommand* vtkPlusStealthLinkCommand::SafeDownCast ( vtkObject *  o )

static

SetKeepReceivedDicomFiles()

virtual void vtkPlusStealthLinkCommand::SetKeepReceivedDicomFiles ( bool  )

virtual

SetNameToGetExam()

void vtkPlusStealthLinkCommand::SetNameToGetExam

(

)

Set the command to get the exam data (image and Ras to VolumeEmbeddedTransformToFrame coordinate system transform). In the future there may be other command names.

Definition at line 65 of file vtkPlusStealthLinkCommand.cxx.

vtkGetStdStringMacro() [1/3]

vtkPlusStealthLinkCommand::vtkGetStdStringMacro

(

StealthLinkDeviceId

)

Id of the stealthlink device

vtkGetStdStringMacro() [2/3]

vtkPlusStealthLinkCommand::vtkGetStdStringMacro

(

DicomImagesOutputDirectory

)

The folder in which the dicom images will be stored. The default value is: PlusOutputDirectory\StealthLinkDicomOutput

vtkGetStdStringMacro() [3/3]

vtkPlusStealthLinkCommand::vtkGetStdStringMacro

(

VolumeEmbeddedTransformToFrame

)

The frame reference in which the image will be represented. Example if this is RAS then image will be defined in RAS coordinate system, if Reference, the image will be in reference coordinate system

vtkSetStdStringMacro() [1/3]

vtkPlusStealthLinkCommand::vtkSetStdStringMacro

(

StealthLinkDeviceId

)

vtkSetStdStringMacro() [2/3]

vtkPlusStealthLinkCommand::vtkSetStdStringMacro

(

DicomImagesOutputDirectory

)

vtkSetStdStringMacro() [3/3]

vtkPlusStealthLinkCommand::vtkSetStdStringMacro

(

VolumeEmbeddedTransformToFrame

)

WriteConfiguration()

PlusStatus vtkPlusStealthLinkCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 107 of file vtkPlusStealthLinkCommand.cxx.

Member Data Documentation

DicomImagesOutputDirectory

std::string vtkPlusStealthLinkCommand::DicomImagesOutputDirectory

protected

Definition at line 85 of file vtkPlusStealthLinkCommand.h.

KeepReceivedDicomFiles

bool vtkPlusStealthLinkCommand::KeepReceivedDicomFiles

protected

Definition at line 87 of file vtkPlusStealthLinkCommand.h.

StealthLinkDeviceId

std::string vtkPlusStealthLinkCommand::StealthLinkDeviceId

protected

Definition at line 84 of file vtkPlusStealthLinkCommand.h.

VolumeEmbeddedTransformToFrame

std::string vtkPlusStealthLinkCommand::VolumeEmbeddedTransformToFrame

protected

Definition at line 86 of file vtkPlusStealthLinkCommand.h.

---

The documentation for this class was generated from the following files:

• src/PlusServer/Commands/vtkPlusStealthLinkCommand.h
• src/PlusServer/Commands/vtkPlusStealthLinkCommand.cxx