IGSTK
Public Member Functions | Protected Member Functions | List of all members
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]

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.
- Public Member Functions inherited from igstk::TrackerTool
virtual TransformType GetCalibrationTransform ()
 Get the calibration transform for this tool.
void SetCalibrationTransform (const TransformType &)
 Set the calibration transform for this tool.
virtual bool GetUpdated ()
 Get whether the tool was updated during tracker UpdateStatus()
virtual void RequestConfigure (void)
 The "RequestConfigure" method attempts to configure the tracker tool.
virtual void RequestDetachFromTracker ()
 The "RequestDetachFromTracker" method detaches the tracker tool from the tracker.
const std::string GetTrackerToolIdentifier () const
 Access the unique identifier to the tracker tool.
virtual void RequestAttachToTracker (TrackerType *)
 The "RequestAttachToTracker" method attaches the tracker tool to a tracker.
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Protected Member Functions

 PolarisTrackerTool ()
virtual ~PolarisTrackerTool ()
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.
- Protected Member Functions inherited from igstk::TrackerTool
 TrackerTool (void)
virtual ~TrackerTool (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void SetTrackerToolIdentifier (const std::string identifier)
 Set a unique identifier to the tracker tool.
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
virtual ~Object (void)
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Additional Inherited Members

- Public Types inherited from igstk::TrackerTool
typedef Transform TransformType
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Public Attributes inherited from igstk::TrackerTool
igstkStandardAbstractClassTraitsMacro(TrackerTool,
Object) public typedef Tracker 
TrackerType
 Macro with standard traits declarations.

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

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
protectedvirtual

Print object information.


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