IGSTK
Protected Types | Protected Member Functions | List of all members
igstk::NDITracker Class Reference

Provides support for the NDI trackers. More...

#include <igstkNDITracker.h>

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

Protected Types

typedef
igstk::NDICommandInterpreter 
CommandInterpreterType
 typedef for command interpreter
typedef Tracker::ResultType ResultType
 typedef for internal boolean return type
- Protected Types inherited from igstk::Tracker
enum  ResultType { FAILURE = 0, SUCCESS }
typedef Transform::TimePeriodType TimePeriodType
 typedef for times used by the tracker
typedef Transform TransformType
 typedefs from Transform class
typedef std::map< std::string,
TrackerToolType * > 
TrackerToolsContainerType
 typedefs from TrackerTool class

Protected Member Functions

 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 VerifyTrackerToolInformation (const TrackerToolType *)=0
 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 ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool)
 Remove tracker tool entry from internal containers.
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool)
 Add tracker tool entry to internal containers.
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.
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
- Public Member Functions inherited from igstk::Tracker
void RequestOpen (void)
 The "RequestOpen" method attempts to open communication with the tracking device.
void RequestClose (void)
 The "RequestClose" method closes communication with the device.
void RequestReset (void)
 
The "RequestReset" tracker method should be used to bring the tracker

to some defined default state.

void RequestStartTracking (void)
 
The "RequestStartTracking" method readies the tracker for tracking the

tools connected to the tracker.

void RequestStopTracking (void)
 The "RequestStopTracking" stops tracker from tracking the tools.
void RequestSetFrequency (double frequencyInHz)
 The "RequestSetFrequency" method defines the frequency at which the Transform information will be queried from the Tracker device.
void RequestSetReferenceTool (TrackerToolType *trackerTool)
 Set a reference tracker tool.
virtual void SetThreadingEnabled (bool _arg)
 SetThreadingEnabled(bool) : set m_ThreadingEnabled value.
virtual bool GetThreadingEnabled ()
 GetThreadingEnabled(bool) : get m_ThreadingEnabled value.
- 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.

Detailed Description

Provides support for the NDI trackers.

Definition at line 35 of file igstkNDITracker.h.

Member Typedef Documentation

typedef for command interpreter

Definition at line 58 of file igstkNDITracker.h.

typedef for internal boolean return type

Definition at line 61 of file igstkNDITracker.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual ResultType igstk::NDITracker::InternalOpen ( void  )
protectedvirtual

Open communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalClose ( void  )
protectedvirtual

Close communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalStartTracking ( void  )
protectedvirtual

Put the tracking device into tracking mode.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalStopTracking ( void  )
protectedvirtual

Take the tracking device out of tracking mode.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalUpdateStatus ( void  )
protectedvirtual

Update the status and the transforms for all TrackerTools.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalThreadedUpdateStatus ( void  )
protectedvirtual

Update the status and the transforms.

This function is called by a separate thread.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalReset ( void  )
protectedvirtual

Reset the tracking device to put it back to its original state.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::VerifyTrackerToolInformation ( const TrackerToolType )
protectedpure virtual

Verify tracker tool information.

Implements igstk::Tracker.

Implemented in igstk::AuroraTracker, and igstk::PolarisTracker.

virtual ResultType igstk::NDITracker::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::Tracker.

Reimplemented in igstk::AuroraTracker, and igstk::PolarisTracker.

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

Remove tracker tool entry from internal containers.

Implements igstk::Tracker.

Reimplemented in igstk::AuroraTracker.

virtual ResultType igstk::NDITracker::AddTrackerToolToInternalDataContainers ( const TrackerToolType trackerTool)
protectedvirtual

Add tracker tool entry to internal containers.

Implements igstk::Tracker.

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

Print object information.

Reimplemented in igstk::AuroraTracker, and igstk::PolarisTracker.

CommandInterpreterType::Pointer igstk::NDITracker::GetCommandInterpreter ( ) const
protected

Get method for the command interpreter This will method will be used by the derived classes.

ResultType igstk::NDITracker::CheckError ( CommandInterpreterType ) const
protected

Helper function for reporting interpreter errors.

virtual void igstk::NDITracker::SetPortHandleToBeAdded ( int  _arg)
protectedvirtual

Set port handle to be added.


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