This command allows OpenIGTLink commands to configure specific functionalities in the Atracsys device. See the documentation for command specifics. More...

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

Inheritance diagram for vtkPlusAtracsysCommand:

[legend]

Collaboration diagram for vtkPlusAtracsysCommand:

[legend]

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 (AtracsysDeviceId)

	vtkSetStdStringMacro (AtracsysDeviceId)

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 vtkPlusAtracsysCommand *	New ()

static vtkPlusAtracsysCommand *	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
vtkPlusAtracsysTracker *	GetAtracsysDevice ()

void	operator= (const vtkPlusAtracsysCommand &)

PlusStatus	StringToBool (std::string strVal, bool &boolVal)

	vtkPlusAtracsysCommand ()

	vtkPlusAtracsysCommand (const vtkPlusAtracsysCommand &)

virtual	~vtkPlusAtracsysCommand ()

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	AtracsysDeviceId

std::map< std::string, std::string >	CommandList

std::map< std::string, std::string >	EnableDisableTools

int	LedB

int	LedFreq

int	LedG

int	LedR

std::map< std::string, std::string >	Markers

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 allows OpenIGTLink commands to configure specific functionalities in the Atracsys device. See the documentation for command specifics.

Definition at line 21 of file vtkPlusAtracsysCommand.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusCommand vtkPlusAtracsysCommand::Superclass

Definition at line 26 of file vtkPlusAtracsysCommand.h.

Constructor & Destructor Documentation

◆ vtkPlusAtracsysCommand() [1/2]

vtkPlusAtracsysCommand::vtkPlusAtracsysCommand ( )

protected

Definition at line 32 of file vtkPlusAtracsysCommand.cxx.

◆ ~vtkPlusAtracsysCommand()

vtkPlusAtracsysCommand::~vtkPlusAtracsysCommand ( )

protectedvirtual

Definition at line 38 of file vtkPlusAtracsysCommand.cxx.

◆ vtkPlusAtracsysCommand() [2/2]

vtkPlusAtracsysCommand::vtkPlusAtracsysCommand ( const vtkPlusAtracsysCommand & )

protected

Member Function Documentation

◆ Clone()

virtual vtkPlusCommand* vtkPlusAtracsysCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 28 of file vtkPlusAtracsysCommand.h.

◆ Execute()

PlusStatus vtkPlusAtracsysCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 255 of file vtkPlusAtracsysCommand.cxx.

◆ GetAtracsysDevice()

vtkPlusAtracsysTracker * vtkPlusAtracsysCommand::GetAtracsysDevice ( )

protected

Definition at line 366 of file vtkPlusAtracsysCommand.cxx.

◆ GetClassName()

virtual const char* vtkPlusAtracsysCommand::GetClassName ( )

virtual

◆ GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 55 of file vtkPlusAtracsysCommand.cxx.

◆ GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 62 of file vtkPlusAtracsysCommand.cxx.

◆ IsA()

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

virtual

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusAtracsysCommand* vtkPlusAtracsysCommand::New ( )

static

◆ operator=()

void vtkPlusAtracsysCommand::operator= ( const vtkPlusAtracsysCommand & )

protected

◆ PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 49 of file vtkPlusAtracsysCommand.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusAtracsysCommand::ReadConfiguration ( vtkXMLDataElement * aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 75 of file vtkPlusAtracsysCommand.cxx.

◆ SafeDownCast()

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

static

◆ SetNameToSetUsParameter()

void vtkPlusAtracsysCommand::SetNameToSetUsParameter ( )

Definition at line 43 of file vtkPlusAtracsysCommand.cxx.

◆ StringToBool()

PlusStatus vtkPlusAtracsysCommand::StringToBool	(	std::string	strVal,
		bool &	boolVal
	)

protected

Definition at line 239 of file vtkPlusAtracsysCommand.cxx.

◆ vtkGetStdStringMacro()

vtkPlusAtracsysCommand::vtkGetStdStringMacro ( AtracsysDeviceId )

Id of the ultrasound device to change the parameters of at the next Execute

◆ vtkSetStdStringMacro()

vtkPlusAtracsysCommand::vtkSetStdStringMacro ( AtracsysDeviceId )

◆ WriteConfiguration()

PlusStatus vtkPlusAtracsysCommand::WriteConfiguration ( vtkXMLDataElement * aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 181 of file vtkPlusAtracsysCommand.cxx.

Member Data Documentation

◆ AtracsysDeviceId

std::string vtkPlusAtracsysCommand::AtracsysDeviceId

protected

Definition at line 58 of file vtkPlusAtracsysCommand.h.

◆ CommandList

std::map<std::string, std::string> vtkPlusAtracsysCommand::CommandList

protected

Definition at line 61 of file vtkPlusAtracsysCommand.h.

◆ EnableDisableTools

std::map<std::string, std::string> vtkPlusAtracsysCommand::EnableDisableTools

protected

Definition at line 67 of file vtkPlusAtracsysCommand.h.

◆ LedB

int vtkPlusAtracsysCommand::LedB

protected

Definition at line 72 of file vtkPlusAtracsysCommand.h.

◆ LedFreq

int vtkPlusAtracsysCommand::LedFreq

protected

Definition at line 73 of file vtkPlusAtracsysCommand.h.

◆ LedG

int vtkPlusAtracsysCommand::LedG

protected

Definition at line 71 of file vtkPlusAtracsysCommand.h.

◆ LedR

int vtkPlusAtracsysCommand::LedR

protected

Definition at line 70 of file vtkPlusAtracsysCommand.h.

◆ Markers

std::map<std::string, std::string> vtkPlusAtracsysCommand::Markers

protected

Definition at line 64 of file vtkPlusAtracsysCommand.h.

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

src/PlusServer/Commands/vtkPlusAtracsysCommand.h
src/PlusServer/Commands/vtkPlusAtracsysCommand.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlusAtracsysCommand() [1/2]

◆ ~vtkPlusAtracsysCommand()

◆ vtkPlusAtracsysCommand() [2/2]

Member Function Documentation

◆ Clone()

◆ Execute()

◆ GetAtracsysDevice()

◆ GetClassName()

◆ GetCommandNames()

◆ GetDescription()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ReadConfiguration()

◆ SafeDownCast()

◆ SetNameToSetUsParameter()

◆ StringToBool()

◆ vtkGetStdStringMacro()

◆ vtkSetStdStringMacro()

◆ WriteConfiguration()

Member Data Documentation

◆ AtracsysDeviceId

◆ CommandList

◆ EnableDisableTools

◆ LedB

◆ LedFreq

◆ LedG

◆ LedR

◆ Markers