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

Public Member Functions

void SetCommunication (CommunicationType *communication)
 The SetCommunication method is used to attach a communication object to the tracker object. More...
 
virtual unsigned int GetNumberOfTools ()
 Get the number of tools that have been detected. More...
 
- Public Member Functions inherited from igstk::Tracker
void RequestOpen (void)
 The "RequestOpen" method attempts to open communication with the tracking device. More...
 
void RequestClose (void)
 The "RequestClose" method closes communication with the device. More...
 
void RequestReset (void)
 The "RequestReset" tracker method should be used to bring the tracker to some defined default state. More...
 
void RequestStartTracking (void)
 The "RequestStartTracking" method readies the tracker for tracking the tools connected to the tracker. More...
 
void RequestStopTracking (void)
 The "RequestStopTracking" stops tracker from tracking the tools. More...
 
void RequestSetFrequency (double frequencyInHz)
 The "RequestSetFrequency" method defines the frequency at which the Transform information will be queried from the Tracker device. More...
 
void RequestSetReferenceTool (TrackerToolType *trackerTool)
 Set a reference tracker tool. More...
 
virtual void SetThreadingEnabled (bool _arg)
 SetThreadingEnabled(bool) : set m_ThreadingEnabled value. More...
 
virtual bool GetThreadingEnabled ()
 GetThreadingEnabled(bool) : get m_ThreadingEnabled value. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardClassTraitsMacro(AscensionTracker,
Tracker) public typedef
igstk::SerialCommunication 
CommunicationType
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::Tracker
igstkStandardAbstractClassTraitsMacro(Tracker,
Object) public typedef
TrackerTool 
TrackerToolType
 Macro with standard traits declarations. More...
 

Protected Types

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

Protected Member Functions

 AscensionTracker (void)
 
virtual ~AscensionTracker (void)
 
virtual ResultType InternalOpen (void)
 Open communication with the tracking device. More...
 
virtual ResultType InternalClose (void)
 Close communication with the tracking device. More...
 
virtual ResultType InternalActivateTools (void)
 Activate the tools attached to the tracking device. More...
 
virtual ResultType InternalDeactivateTools (void)
 Deactivate the tools attached to the tracking device. More...
 
virtual ResultType InternalStartTracking (void)
 Put the tracking device into tracking mode. More...
 
virtual ResultType InternalStopTracking (void)
 Take the tracking device out of tracking mode. More...
 
virtual ResultType InternalUpdateStatus (void)
 Update the status and the transforms for all TrackerTools. More...
 
virtual ResultType InternalThreadedUpdateStatus (void)
 Update the status and the transforms. More...
 
virtual ResultType VerifyTrackerToolInformation (const TrackerToolType *trackerTool)
 Verify tracker tool information. More...
 
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool)
 Add tracker tool entry from internal containers. More...
 
virtual ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool)
 Remove tracker tool from internal containers. More...
 
virtual ResultType InternalReset (void)
 Reset the tracking device to put it back to its original state. More...
 
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information. More...
 
- Protected Member Functions inherited from igstk::Tracker
 Tracker (void)
 
virtual ~Tracker (void)
 
virtual TimePeriodType GetValidityTime ()
 Get the validity time. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used. More...
 
const TrackerToolsContainerTypeGetTrackerToolContainer () const
 Access method for the tracker tool container. More...
 
void ReportTrackingToolNotAvailable (TrackerToolType *trackerTool) const
 Report to tracker tool that it is not available for tracking. More...
 
void ReportTrackingToolVisible (TrackerToolType *trackerTool) const
 Report to tracker tool that it is visible. More...
 
void SetTrackerToolRawTransform (TrackerToolType *trackerTool, const TransformType transform)
 Set tracker tool raw transform. More...
 
void SetTrackerToolTransformUpdate (TrackerToolType *trackerTool, bool flag) const
 Turn on/off update flag of the tracker tool. More...
 
void ExitTrackingStateProcessing (void)
 Depending on the tracker type, the tracking thread should be terminated or left untouched when we stop tracking. More...
 
void ExitTrackingWithoutTerminatingTrackingThread ()
 Exit tracking without terminating tracking thread. More...
 
void ExitTrackingTerminatingTrackingThread ()
 Exit tracking after terminating tracking thread. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
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. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
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)
 

Detailed Description

Provides support for the Ascension trackers.

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

Definition at line 38 of file igstkAscensionTracker.h.

Member Typedef Documentation

typedef for internal boolean return type

Definition at line 67 of file igstkAscensionTracker.h.

Constructor & Destructor Documentation

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

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

Open communication with the tracking device.

Implements igstk::Tracker.

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

Close communication with the tracking device.

Implements igstk::Tracker.

virtual ResultType igstk::AscensionTracker::InternalActivateTools ( void  )
protectedvirtual

Activate the tools attached to the tracking device.

virtual ResultType igstk::AscensionTracker::InternalDeactivateTools ( void  )
protectedvirtual

Deactivate the tools attached to the tracking device.

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

Put the tracking device into tracking mode.

Implements igstk::Tracker.

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

Take the tracking device out of tracking mode.

Implements igstk::Tracker.

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

Update the status and the transforms for all TrackerTools.

Implements igstk::Tracker.

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

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

Verify tracker tool information.

Implements igstk::Tracker.

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

Add tracker tool entry from internal containers.

Implements igstk::Tracker.

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

Remove tracker tool from internal containers.

Implements igstk::Tracker.

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

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
protectedvirtual

Print object information.

Member Data Documentation

igstkStandardClassTraitsMacro ( AscensionTracker, Tracker ) public typedef igstk::SerialCommunication igstk::AscensionTracker::CommunicationType

Macro with standard traits declarations.

Command Interpreter Communication type

Definition at line 43 of file igstkAscensionTracker.h.


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