vtkPlusUSDigitalEncoderCommand Class Reference

This command controls USDigitalEncodersTracker devices.This command is used for controlling a USDigitalEncodersTracker device to reset or retrieve the positions of its individual encoders. More...

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

Inheritance diagram for vtkPlusUSDigitalEncoderCommand:

Collaboration diagram for vtkPlusUSDigitalEncoderCommand:

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	SetNameToEncoderCommand ()
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 vtkPlusUSDigitalEncoderCommand *	New ()
static vtkPlusUSDigitalEncoderCommand *	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
	vtkPlusUSDigitalEncoderCommand ()
virtual	~vtkPlusUSDigitalEncoderCommand ()
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::list< std::pair< std::string, std::string > >	CommandList
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 controls USDigitalEncodersTracker devices.

This command is used for controlling a USDigitalEncodersTracker device to reset or retrieve the positions of its individual encoders.

Definition at line 24 of file vtkPlusUSDigitalEncoderCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusUSDigitalEncoderCommand::Superclass

Definition at line 29 of file vtkPlusUSDigitalEncoderCommand.h.

Constructor & Destructor Documentation

vtkPlusUSDigitalEncoderCommand()

vtkPlusUSDigitalEncoderCommand::vtkPlusUSDigitalEncoderCommand ( )

protected

Definition at line 21 of file vtkPlusUSDigitalEncoderCommand.cxx.

~vtkPlusUSDigitalEncoderCommand()

vtkPlusUSDigitalEncoderCommand::~vtkPlusUSDigitalEncoderCommand ( )

protectedvirtual

Definition at line 28 of file vtkPlusUSDigitalEncoderCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusUSDigitalEncoderCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 31 of file vtkPlusUSDigitalEncoderCommand.h.

Execute()

PlusStatus vtkPlusUSDigitalEncoderCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 133 of file vtkPlusUSDigitalEncoderCommand.cxx.

GetClassName()

virtual const char* vtkPlusUSDigitalEncoderCommand::GetClassName ( )

virtual

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 39 of file vtkPlusUSDigitalEncoderCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 46 of file vtkPlusUSDigitalEncoderCommand.cxx.

GetDeviceId()

std::string vtkPlusUSDigitalEncoderCommand::GetDeviceId ( ) const

virtual

Id of the device that the command will be sent to

Definition at line 58 of file vtkPlusUSDigitalEncoderCommand.cxx.

GetResponseExpected()

virtual bool vtkPlusUSDigitalEncoderCommand::GetResponseExpected ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusUSDigitalEncoderCommand* vtkPlusUSDigitalEncoderCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 70 of file vtkPlusUSDigitalEncoderCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusUSDigitalEncoderCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 77 of file vtkPlusUSDigitalEncoderCommand.cxx.

ResponseExpectedOff()

virtual void vtkPlusUSDigitalEncoderCommand::ResponseExpectedOff ( )

virtual

ResponseExpectedOn()

virtual void vtkPlusUSDigitalEncoderCommand::ResponseExpectedOn ( )

virtual

SafeDownCast()

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

static

SetDeviceId()

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

virtual

Definition at line 64 of file vtkPlusUSDigitalEncoderCommand.cxx.

SetNameToEncoderCommand()

void vtkPlusUSDigitalEncoderCommand::SetNameToEncoderCommand

(

)

Definition at line 33 of file vtkPlusUSDigitalEncoderCommand.cxx.

SetResponseExpected()

virtual void vtkPlusUSDigitalEncoderCommand::SetResponseExpected ( bool  )

virtual

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

WriteConfiguration()

PlusStatus vtkPlusUSDigitalEncoderCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 122 of file vtkPlusUSDigitalEncoderCommand.cxx.

Member Data Documentation

CommandList

std::list<std::pair<std::string, std::string> > vtkPlusUSDigitalEncoderCommand::CommandList

protected

Definition at line 65 of file vtkPlusUSDigitalEncoderCommand.h.

---

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

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