igstk::PolarisTrackerTool Class Reference

A Polaris-specific TrackerTool class. More...

#include <igstkPolarisTrackerTool.h>

Inheritance diagram for igstk::PolarisTrackerTool:

Inheritance graph
[legend]
Collaboration diagram for igstk::PolarisTrackerTool:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 igstkStandardClassTraitsMacro (PolarisTrackerTool, TrackerTool) void RequestSetPortNumber(unsigned int portNumber)
 Macro with standard traits declarations.
void RequestSelectWiredTrackerTool ()
 Set the TrackerTool to be wired.
void RequestSelectWirelessTrackerTool ()
 Set the TrackerTool to be wireless.
void RequestSetSROMFileName (const std::string &filename)
 Request set the SROM file name.
void RequestSetPartNumber (const std::string &toolId)
 Request set the PartNumber.
bool IsToolWirelessType () const
 Check if the tracker tool is wireless type.
bool IsSROMFileNameSpecified () const
 Check if SROM file name specified.
bool IsPartNumberSpecified () const
 Check if Tool part number is specified.
 igstkGetStringMacro (SROMFileName)
 Get SROM file name.
virtual unsigned int GetPortNumber ()
 Get tracker tool port number.
 igstkGetStringMacro (PartNumber)
 Get tracker tool part number.

Protected Member Functions

 PolarisTrackerTool ()
virtual ~PolarisTrackerTool ()
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.


Detailed Description

A Polaris-specific TrackerTool class.

This class is a for providing Polaris-specific functionality for TrackerTools, and also to allow compile-time type enforcement for other classes and functions that specifically require an Polaris tool.

igstkPolarisTrackerTool.png

PolarisTrackerTool State

Machine Diagram"

Machine Diagram"

Definition at line 55 of file igstkPolarisTrackerTool.h.


Constructor & Destructor Documentation

igstk::PolarisTrackerTool::PolarisTrackerTool (  )  [protected]

virtual igstk::PolarisTrackerTool::~PolarisTrackerTool (  )  [protected, virtual]


Member Function Documentation

igstk::PolarisTrackerTool::igstkStandardClassTraitsMacro ( PolarisTrackerTool  ,
TrackerTool   
)

Macro with standard traits declarations.

Request setting the port number. The tool can only be attached to a tracker after its port number has been defined. Valid port numbers are in [0,11].

void igstk::PolarisTrackerTool::RequestSelectWiredTrackerTool (  ) 

Set the TrackerTool to be wired.

void igstk::PolarisTrackerTool::RequestSelectWirelessTrackerTool (  ) 

Set the TrackerTool to be wireless.

void igstk::PolarisTrackerTool::RequestSetSROMFileName ( const std::string &  filename  ) 

Request set the SROM file name.

void igstk::PolarisTrackerTool::RequestSetPartNumber ( const std::string &  toolId  ) 

Request set the PartNumber.

bool igstk::PolarisTrackerTool::IsToolWirelessType (  )  const

Check if the tracker tool is wireless type.

bool igstk::PolarisTrackerTool::IsSROMFileNameSpecified (  )  const

Check if SROM file name specified.

bool igstk::PolarisTrackerTool::IsPartNumberSpecified (  )  const

Check if Tool part number is specified.

igstk::PolarisTrackerTool::igstkGetStringMacro ( SROMFileName   ) 

Get SROM file name.

virtual unsigned int igstk::PolarisTrackerTool::GetPortNumber (  )  [virtual]

Get tracker tool port number.

igstk::PolarisTrackerTool::igstkGetStringMacro ( PartNumber   ) 

Get tracker tool part number.

virtual void igstk::PolarisTrackerTool::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const [protected, virtual]

Print object information.


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

Generated on Thu Feb 12 09:45:56 2009 for IGSTK by  doxygen 1.5.8