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]

List of all members.

Protected Types

typedef
igstk::NDICommandInterpreter 
CommandInterpreterType
 typedef for command interpreter
typedef Tracker::ResultType ResultType
 typedef for internal boolean return type

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.

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

Reimplemented from igstk::Tracker.

Definition at line 61 of file igstkNDITracker.h.


Constructor & Destructor Documentation

igstk::NDITracker::NDITracker ( void   )  [protected]
virtual igstk::NDITracker::~NDITracker ( void   )  [protected, virtual]

Member Function Documentation

virtual ResultType igstk::NDITracker::InternalOpen ( void   )  [protected, virtual]

Open communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalClose ( void   )  [protected, virtual]

Close communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalStartTracking ( void   )  [protected, virtual]

Put the tracking device into tracking mode.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalStopTracking ( void   )  [protected, virtual]

Take the tracking device out of tracking mode.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalUpdateStatus ( void   )  [protected, virtual]

Update the status and the transforms for all TrackerTools.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalThreadedUpdateStatus ( void   )  [protected, virtual]

Update the status and the transforms.

This function is called by a separate thread.

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::InternalReset ( void   )  [protected, virtual]

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

Implements igstk::Tracker.

virtual ResultType igstk::NDITracker::VerifyTrackerToolInformation ( const TrackerToolType  )  [protected, pure virtual]

Verify tracker tool information.

Implements igstk::Tracker.

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

virtual ResultType igstk::NDITracker::ValidateSpecifiedFrequency ( double  frequencyInHz  )  [protected, virtual]

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  )  [protected, virtual]

Remove tracker tool entry from internal containers.

Implements igstk::Tracker.

Reimplemented in igstk::AuroraTracker.

virtual ResultType igstk::NDITracker::AddTrackerToolToInternalDataContainers ( const TrackerToolType trackerTool  )  [protected, virtual]

Add tracker tool entry to internal containers.

Implements igstk::Tracker.

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

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  )  [protected, virtual]

Set port handle to be added.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sun Aug 30 05:50:12 2009 for IGSTK by  doxygen 1.6.1