igstk::AscensionTracker Class Reference

Provides support for the Ascension trackers. More...

#include <igstkAscensionTracker.h>

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

List of all members.

Public Member Functions

void SetCommunication (CommunicationType *communication)
 The SetCommunication method is used to attach a communication object to the tracker object.
virtual unsigned int GetNumberOfTools ()
 Get the number of tools that have been detected.

Public Attributes

igstkStandardClassTraitsMacro(AscensionTracker,
Tracker) public typedef
igstk::SerialCommunication 
CommunicationType
 Macro with standard traits declarations.

Protected Types

typedef Tracker::ResultType ResultType
 typedef for internal boolean return type

Protected Member Functions

 AscensionTracker (void)
virtual ~AscensionTracker (void)
virtual ResultType InternalOpen (void)
 Open communication with the tracking device.
virtual ResultType InternalClose (void)
 Close communication with the tracking device.
virtual ResultType InternalActivateTools (void)
 Activate the tools attached to the tracking device.
virtual ResultType InternalDeactivateTools (void)
 Deactivate the tools attached to 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 VerifyTrackerToolInformation (const TrackerToolType *trackerTool)
 Verify tracker tool information.
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool)
 Add tracker tool entry from internal containers.
virtual ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool)
 Remove tracker tool from internal containers.
virtual ResultType InternalReset (void)
 Reset the tracking device to put it back to its original state.
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information.

Detailed Description

Provides support for the Ascension trackers.

This class provides an interface to Ascension Technology Corporation magnetic trackers.

Definition at line 36 of file igstkAscensionTracker.h.


Member Typedef Documentation

typedef for internal boolean return type

Reimplemented from igstk::Tracker.

Definition at line 65 of file igstkAscensionTracker.h.


Constructor & Destructor Documentation

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

Member Function Documentation

void igstk::AscensionTracker::SetCommunication ( CommunicationType communication  ) 

The SetCommunication method is used to attach a communication object to the tracker object.

virtual unsigned int igstk::AscensionTracker::GetNumberOfTools (  )  [virtual]

Get the number of tools that have been detected.

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

Open communication with the tracking device.

Implements igstk::Tracker.

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

Close communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::AscensionTracker::InternalActivateTools ( void   )  [protected, virtual]

Activate the tools attached to the tracking device.

virtual ResultType igstk::AscensionTracker::InternalDeactivateTools ( void   )  [protected, virtual]

Deactivate the tools attached to the tracking device.

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

Put the tracking device into tracking mode.

Implements igstk::Tracker.

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

Take the tracking device out of tracking mode.

Implements igstk::Tracker.

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

Update the status and the transforms for all TrackerTools.

Implements igstk::Tracker.

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

Update the status and the transforms.

This function is called by a separate thread.

Implements igstk::Tracker.

virtual ResultType igstk::AscensionTracker::VerifyTrackerToolInformation ( const TrackerToolType trackerTool  )  [protected, virtual]

Verify tracker tool information.

Implements igstk::Tracker.

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

Add tracker tool entry from internal containers.

Implements igstk::Tracker.

virtual ResultType igstk::AscensionTracker::RemoveTrackerToolFromInternalDataContainers ( const TrackerToolType trackerTool  )  [protected, virtual]

Remove tracker tool from internal containers.

Implements igstk::Tracker.

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

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

Implements igstk::Tracker.

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

Print object information.


Member Data Documentation

Macro with standard traits declarations.

Command Interpreter Communication type

Definition at line 41 of file igstkAscensionTracker.h.


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

Generated by  doxygen 1.6.2