vtkPlusWinProbeCommand Class Reference

This command is for communicating with vtkPlusWinProbeDevices.This command is used for communicating with a WinProbe device. More...

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

Inheritance diagram for vtkPlusWinProbeCommand:

Collaboration diagram for vtkPlusWinProbeCommand:

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 std::string	GetDeviceId () const
virtual bool	GetResponseExpected ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
virtual void	ResponseExpectedOff ()
virtual void	ResponseExpectedOn ()
virtual void	SetDeviceId (const std::string &deviceId)
void	SetNameToWinProbeDevice ()
virtual void	SetResponseExpected (bool)
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 vtkPlusWinProbeCommand *	New ()
static vtkPlusWinProbeCommand *	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
std::string	GetCommandIndex () const
std::string	GetCommandName () const
std::string	GetCommandValue () const
void	SetCommandIndex (const std::string &text)
void	SetCommandName (const std::string &text)
void	SetCommandValue (const std::string &text)
	vtkPlusWinProbeCommand ()
virtual	~vtkPlusWinProbeCommand ()
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 ()

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"
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

Detailed Description

This command is for communicating with vtkPlusWinProbeDevices.

This command is used for communicating with a WinProbe device.

Definition at line 23 of file vtkPlusWinProbeCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusWinProbeCommand::Superclass

Definition at line 27 of file vtkPlusWinProbeCommand.h.

Constructor & Destructor Documentation

vtkPlusWinProbeCommand()

vtkPlusWinProbeCommand::vtkPlusWinProbeCommand ( )

protected

Definition at line 22 of file vtkPlusWinProbeCommand.cxx.

~vtkPlusWinProbeCommand()

vtkPlusWinProbeCommand::~vtkPlusWinProbeCommand ( )

protectedvirtual

Definition at line 30 of file vtkPlusWinProbeCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusWinProbeCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 29 of file vtkPlusWinProbeCommand.h.

Execute()

PlusStatus vtkPlusWinProbeCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 188 of file vtkPlusWinProbeCommand.cxx.

GetClassName()

virtual const char* vtkPlusWinProbeCommand::GetClassName ( )

virtual

GetCommandIndex()

std::string vtkPlusWinProbeCommand::GetCommandIndex ( ) const

protected

Definition at line 103 of file vtkPlusWinProbeCommand.cxx.

GetCommandName()

std::string vtkPlusWinProbeCommand::GetCommandName ( ) const

protected

Definition at line 79 of file vtkPlusWinProbeCommand.cxx.

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 48 of file vtkPlusWinProbeCommand.cxx.

GetCommandValue()

std::string vtkPlusWinProbeCommand::GetCommandValue ( ) const

protected

Definition at line 91 of file vtkPlusWinProbeCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 55 of file vtkPlusWinProbeCommand.cxx.

GetDeviceId()

std::string vtkPlusWinProbeCommand::GetDeviceId ( ) const

virtual

Id of the device that the text will be sent to

Definition at line 67 of file vtkPlusWinProbeCommand.cxx.

GetResponseExpected()

virtual bool vtkPlusWinProbeCommand::GetResponseExpected ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusWinProbeCommand* vtkPlusWinProbeCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 36 of file vtkPlusWinProbeCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusWinProbeCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 115 of file vtkPlusWinProbeCommand.cxx.

ResponseExpectedOff()

virtual void vtkPlusWinProbeCommand::ResponseExpectedOff ( )

virtual

ResponseExpectedOn()

virtual void vtkPlusWinProbeCommand::ResponseExpectedOn ( )

virtual

SafeDownCast()

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

static

SetCommandIndex()

void vtkPlusWinProbeCommand::SetCommandIndex ( const std::string &  text )

protected

Definition at line 109 of file vtkPlusWinProbeCommand.cxx.

SetCommandName()

void vtkPlusWinProbeCommand::SetCommandName ( const std::string &  text )

protected

Definition at line 85 of file vtkPlusWinProbeCommand.cxx.

SetCommandValue()

void vtkPlusWinProbeCommand::SetCommandValue ( const std::string &  text )

protected

Definition at line 97 of file vtkPlusWinProbeCommand.cxx.

SetDeviceId()

void vtkPlusWinProbeCommand::SetDeviceId ( const std::string &  deviceId )

virtual

Definition at line 73 of file vtkPlusWinProbeCommand.cxx.

SetNameToWinProbeDevice()

void vtkPlusWinProbeCommand::SetNameToWinProbeDevice

(

)

Definition at line 42 of file vtkPlusWinProbeCommand.cxx.

SetResponseExpected()

virtual void vtkPlusWinProbeCommand::SetResponseExpected ( bool  )

virtual

If true then the command waits for a response and returns with the received text in the command response.

WriteConfiguration()

PlusStatus vtkPlusWinProbeCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 160 of file vtkPlusWinProbeCommand.cxx.

---

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

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