IGSTK
Public Member Functions | Protected Member Functions

igstk::AuroraTrackerTool Class Reference

An Aurora-specific TrackerTool class. More...

#include <igstkAuroraTrackerTool.h>

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

List of all members.

Public Member Functions

 igstkStandardClassTraitsMacro (AuroraTrackerTool, TrackerTool) void RequestSetPortNumber(unsigned int portNumber)
 Macro with standard traits declarations.
void RequestSetChannelNumber (unsigned int channelNumber)
 Request set the channel number.
void RequestSetSROMFileName (const std::string &filename)
 Request set the SROM file name.
void RequestSetPartNumber (const std::string &toolId)
 Request set the PartNumber.
void RequestSelect5DOFTrackerTool ()
 Request select 5DOF (five degrees of freedom) tracker tool.
void RequestSelect6DOFTrackerTool ()
 Request select 6DOF (six degrees of freedom) tracker tool.
bool IsSROMFileNameSpecified () const
 Check if SROM file name specified.
bool IsPartNumberSpecified () const
 Check if Part number is specified.
 igstkGetStringMacro (SROMFileName)
 Get SROM file name.
virtual unsigned int GetPortNumber ()
 Get tracker tool port number.
virtual unsigned int GetChannelNumber ()
 Get tracker tool channel number.
 igstkGetStringMacro (PartNumber)
 Get tracker tool part number.
bool IsTrackerTool5DOF () const
 Check if the tracker tool selected is 5DOF or 6DOF (five or six degrees of freedom)

Protected Member Functions

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

Detailed Description

An Aurora-specific TrackerTool class.

This class provides Aurora-specific functionality for TrackerTools, and also allows compile-time type enforcement for other classes and functions that specifically require an Aurora tool.

Definition at line 50 of file igstkAuroraTrackerTool.h.


Constructor & Destructor Documentation

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

Member Function Documentation

igstk::AuroraTrackerTool::igstkStandardClassTraitsMacro ( AuroraTrackerTool  ,
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,3].

void igstk::AuroraTrackerTool::RequestSetChannelNumber ( unsigned int  channelNumber)

Request set the channel number.

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

Request set the SROM file name.

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

Request set the PartNumber.

void igstk::AuroraTrackerTool::RequestSelect5DOFTrackerTool ( )

Request select 5DOF (five degrees of freedom) tracker tool.

void igstk::AuroraTrackerTool::RequestSelect6DOFTrackerTool ( )

Request select 6DOF (six degrees of freedom) tracker tool.

bool igstk::AuroraTrackerTool::IsSROMFileNameSpecified ( ) const

Check if SROM file name specified.

bool igstk::AuroraTrackerTool::IsPartNumberSpecified ( ) const

Check if Part number is specified.

igstk::AuroraTrackerTool::igstkGetStringMacro ( SROMFileName  )

Get SROM file name.

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

Get tracker tool port number.

virtual unsigned int igstk::AuroraTrackerTool::GetChannelNumber ( ) [virtual]

Get tracker tool channel number.

igstk::AuroraTrackerTool::igstkGetStringMacro ( PartNumber  )

Get tracker tool part number.

bool igstk::AuroraTrackerTool::IsTrackerTool5DOF ( ) const

Check if the tracker tool selected is 5DOF or 6DOF (five or six degrees of freedom)

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

Print object information.

Reimplemented from igstk::TrackerTool.


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