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

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

 AuroraTrackerTool ()
virtual ~AuroraTrackerTool ()
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)
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

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

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
protectedvirtual

Print object information.

Reimplemented from igstk::TrackerTool.


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