IGSTK
Public Member Functions | Protected Member Functions | List of all members
igstk::AuroraTracker Class Reference

Provides support for the AURORA magnetic tracker. More...

#include <igstkAuroraTracker.h>

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

Public Member Functions

virtual bool GetSimulatedTestMaintainCoverage ()

Protected Member Functions

 AuroraTracker (void)
virtual ~AuroraTracker (void)
virtual ResultType VerifyTrackerToolInformation (const TrackerToolType *)
 Verify tracker tool information.
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.
virtual ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool)
 Remove tracker tool entry from internal containers.
- Protected Member Functions inherited from igstk::NDITracker
 NDITracker (void)
virtual ~NDITracker (void)
virtual ResultType InternalOpen (void)
 Open communication with the tracking device.
virtual ResultType InternalClose (void)
 Close communication with the tracking device.
virtual ResultType InternalStartTracking (void)
 Put the tracking device into tracking mode.
virtual ResultType InternalStopTracking (void)
 Take the tracking device out of tracking mode.
virtual ResultType InternalUpdateStatus (void)
 Update the status and the transforms for all TrackerTools.
virtual ResultType InternalThreadedUpdateStatus (void)
 Update the status and the transforms.
virtual ResultType InternalReset (void)
 Reset the tracking device to put it back to its original state.
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool)
 Add tracker tool entry to internal containers.
CommandInterpreterType::Pointer GetCommandInterpreter () const
 Get method for the command interpreter This will method will be used by the derived classes.
ResultType CheckError (CommandInterpreterType *) const
 Helper function for reporting interpreter errors.
virtual void SetPortHandleToBeAdded (int _arg)
 Set port handle to be added.
- Protected Member Functions inherited from igstk::Tracker
 Tracker (void)
virtual ~Tracker (void)
virtual TimePeriodType GetValidityTime ()
 Get the validity time.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
const TrackerToolsContainerTypeGetTrackerToolContainer () const
 Access method for the tracker tool container.
void ReportTrackingToolNotAvailable (TrackerToolType *trackerTool) const
 Report to tracker tool that it is not available for tracking.
void ReportTrackingToolVisible (TrackerToolType *trackerTool) const
 Report to tracker tool that it is visible.
void SetTrackerToolRawTransform (TrackerToolType *trackerTool, const TransformType transform)
 Set tracker tool raw transform.
void SetTrackerToolTransformUpdate (TrackerToolType *trackerTool, bool flag) const
 Turn on/off update flag of the tracker tool.
void ExitTrackingStateProcessing (void)
 Depending on the tracker type, the tracking thread should be terminated or left untouched when we stop tracking.
void ExitTrackingWithoutTerminatingTrackingThread ()
 Exit tracking without terminating tracking thread.
void ExitTrackingTerminatingTrackingThread ()
 Exit tracking after terminating tracking thread.
- 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::Object
typedef Object Self
 General Typedefs.
typedef ::itk::Object Superclass
typedef ::itk::SmartPointer< SelfPointer
typedef ::itk::SmartPointer
< const Self
ConstPointer
typedef igstk::Logger LoggerType
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Public Attributes inherited from igstk::Tracker
igstkStandardAbstractClassTraitsMacro(Tracker,
Object) public typedef
TrackerTool 
TrackerToolType
 Macro with standard traits declarations.
- Protected Types inherited from igstk::NDITracker
typedef
igstk::NDICommandInterpreter 
CommandInterpreterType
 typedef for command interpreter
typedef Tracker::ResultType ResultType
 typedef for internal boolean return type

Detailed Description

Provides support for the AURORA magnetic tracker.

This class provides an interface to the Aurora magnetic tracking system, which is manufactured by Northern Digital Inc. in Waterloo, Ontario, Canada.

The use of two 5DOF tools on a single port is supported. In order to use the Aurora in this configuration, a splitter for the port is required, as well as an SROM file that can work with the two tools in question.

Definition at line 48 of file igstkAuroraTracker.h.

Constructor & Destructor Documentation

igstk::AuroraTracker::AuroraTracker ( void  )
protected
virtual igstk::AuroraTracker::~AuroraTracker ( void  )
protectedvirtual

Member Function Documentation

virtual bool igstk::AuroraTracker::GetSimulatedTestMaintainCoverage ( )
virtual
virtual ResultType igstk::AuroraTracker::VerifyTrackerToolInformation ( const TrackerToolType )
protectedvirtual

Verify tracker tool information.

Implements igstk::NDITracker.

virtual ResultType igstk::AuroraTracker::ValidateSpecifiedFrequency ( double  frequencyInHz)
protectedvirtual

The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.

Reimplemented from igstk::NDITracker.

virtual void igstk::AuroraTracker::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const
protectedvirtual

Print object information.

Reimplemented from igstk::NDITracker.

virtual ResultType igstk::AuroraTracker::RemoveTrackerToolFromInternalDataContainers ( const TrackerToolType trackerTool)
protectedvirtual

Remove tracker tool entry from internal containers.

Reimplemented from igstk::NDITracker.


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