IGSTK
Protected Types | Protected Member Functions

igstk::SimulatedTracker Class Reference

Implementation of a class that simulates a tracker. More...

#include <igstkSimulatedTracker.h>

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

List of all members.

Protected Types

typedef Tracker::ResultType ResultType

Protected Member Functions

 SimulatedTracker ()
 Macro with standard traits declarations.
virtual ~SimulatedTracker ()
virtual ResultType InternalOpen (void)
 The "InternalOpen" method opens communication with a tracking device.
virtual ResultType InternalStartTracking (void)
 The "InternalStartTracking" method starts tracking.
virtual ResultType InternalReset (void)
 The "InternalReset" method resets tracker to a known configuration.
virtual ResultType InternalStopTracking (void)
 The "InternalStopTracking" method stops tracking.
virtual ResultType InternalClose (void)
 The "InternalClose" method closes communication with a tracking device.
virtual ResultType VerifyTrackerToolInformation (const TrackerToolType *)
 Verify tracker tool information.
virtual ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *)
 This method will remove entries of the traceker tool from internal data containers.
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *)
 Add tracker tool entry to internal containers.
virtual ResultType InternalUpdateStatus (void)
 This is the most important method of the SimulatedTracker family.
virtual ResultType InternalThreadedUpdateStatus (void)
 The "InternalThreadedUpdateStatus" method updates tracker status.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.

Detailed Description

Implementation of a class that simulates a tracker.

The purpose of this class is to provide the behavior of a Tracker but under controlled conditions. This class is mainly intended as a helper device for testing other components of an IGS system. This simulated tracker generate transforms that correspond to a pre-programmed path in space.

By connecting this tracker to an object, you can validate whether the visualization, timing and interaction elements of the IGS application are behaving as expected or not.

Definition at line 41 of file igstkSimulatedTracker.h.


Member Typedef Documentation

Reimplemented from igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

Definition at line 57 of file igstkSimulatedTracker.h.


Constructor & Destructor Documentation

igstk::SimulatedTracker::SimulatedTracker ( ) [protected]

Macro with standard traits declarations.

virtual igstk::SimulatedTracker::~SimulatedTracker ( ) [protected, virtual]

Member Function Documentation

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

The "InternalOpen" method opens communication with a tracking device.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

The "InternalStartTracking" method starts tracking.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

The "InternalReset" method resets tracker to a known configuration.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

The "InternalStopTracking" method stops tracking.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

The "InternalClose" method closes communication with a tracking device.

This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

Verify tracker tool information.

Implements igstk::Tracker.

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

This method will remove entries of the traceker tool from internal data containers.

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

Add tracker tool entry to internal containers.

Implements igstk::Tracker.

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

This is the most important method of the SimulatedTracker family.

This method must be overloaded in derived classes in order to provide a particular pattern of movement.

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

The "InternalThreadedUpdateStatus" method updates tracker status.

This method is called in a separate thread. This method is to be implemented by a descendant class and responsible for device-specific processing

Implements igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.

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

Print object information.

Reimplemented from igstk::Tracker.

Reimplemented in igstk::CircularSimulatedTracker.


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