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

A simulated tracker that reports a circular movement. More...

#include <igstkCircularSimulatedTracker.h>

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

Public Member Functions

virtual double GetRadius ()
virtual void SetAngularSpeed (double _arg)
 Angular Speed measured in degrees per second.
virtual double GetAngularSpeed ()

Protected Types

typedef Tracker::ResultType ResultType
typedef
RealTimeClock::TimeStampType 
TimeType
- Protected Types inherited from igstk::SimulatedTracker
typedef Tracker::ResultType ResultType
- 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

 CircularSimulatedTracker ()
virtual ~CircularSimulatedTracker ()
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 (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 InternalUpdateStatus (void)
 This is the most important method of this class.
virtual ResultType InternalThreadedUpdateStatus (void)
 The "InternalThreadedUpdateStatus" method updates tracker status.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.
- Protected Member Functions inherited from igstk::SimulatedTracker
 SimulatedTracker ()
 Macro with standard traits declarations.
virtual ~SimulatedTracker ()
virtual ResultType VerifyTrackerToolInformation (const TrackerToolType *)
 Verify tracker tool information.
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *)
 Add tracker tool entry to internal containers.
- Protected Member Functions inherited from igstk::Tracker
 Tracker (void)
virtual ~Tracker (void)
virtual TimePeriodType GetValidityTime ()
 Get the validity time.
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.
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
- 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

A simulated tracker that reports a circular movement.

The purpose of this class is to provide a minimal implementation of a Tracker. This class is intended only for minimal demos and for debugging applications. It is not intended to be used in a real application to be deployed in a surgery room.

Definition at line 37 of file igstkCircularSimulatedTracker.h.

Member Typedef Documentation

Definition at line 60 of file igstkCircularSimulatedTracker.h.

Definition at line 61 of file igstkCircularSimulatedTracker.h.

Constructor & Destructor Documentation

igstk::CircularSimulatedTracker::CircularSimulatedTracker ( )
protected
virtual igstk::CircularSimulatedTracker::~CircularSimulatedTracker ( )
protectedvirtual

Member Function Documentation

virtual double igstk::CircularSimulatedTracker::GetRadius ( )
virtual
virtual void igstk::CircularSimulatedTracker::SetAngularSpeed ( double  _arg)
virtual

Angular Speed measured in degrees per second.

virtual double igstk::CircularSimulatedTracker::GetAngularSpeed ( )
virtual
virtual ResultType igstk::CircularSimulatedTracker::InternalOpen ( void  )
protectedvirtual

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

Reimplemented from igstk::SimulatedTracker.

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

The "InternalStartTracking" method starts tracking.

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

Reimplemented from igstk::SimulatedTracker.

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

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

Reimplemented from igstk::SimulatedTracker.

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

The "InternalStopTracking" method stops tracking.

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

Reimplemented from igstk::SimulatedTracker.

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

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

Reimplemented from igstk::SimulatedTracker.

virtual ResultType igstk::CircularSimulatedTracker::VerifyTrackerToolInformation ( TrackerToolType )
protectedvirtual

Verify tracker tool information.

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

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

Reimplemented from igstk::SimulatedTracker.

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

This is the most important method of this class.

It computes the transform that will be passed to the TrackerTool.

Reimplemented from igstk::SimulatedTracker.

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

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

Reimplemented from igstk::SimulatedTracker.

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

Print object information.

Reimplemented from igstk::SimulatedTracker.


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