igstk::TrackerTool Class Reference

Abstract superclass for concrete IGSTK TrackerTool classes. More...

#include <igstkTrackerTool.h>

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

List of all members.

Public Types

typedef Transform TransformType

Public Member Functions

virtual TransformType GetCalibrationTransform ()
 Get the calibration transform for this tool.
void SetCalibrationTransform (const TransformType &)
 Set the calibration transform for this tool.
virtual bool GetUpdated ()
 Get whether the tool was updated during tracker UpdateStatus().
virtual void RequestConfigure (void)
 The "RequestConfigure" method attempts to configure the tracker tool.
virtual void RequestDetachFromTracker ()
 The "RequestDetachFromTracker" method detaches the tracker tool from the tracker.
const std::string GetTrackerToolIdentifier () const
 Access the unique identifier to the tracker tool.
virtual void RequestAttachToTracker (TrackerType *)
 The "RequestAttachToTracker" method attaches the tracker tool to a tracker.

Public Attributes

igstkStandardAbstractClassTraitsMacro(TrackerTool,
Object) public typedef Tracker 
TrackerType
 Macro with standard traits declarations.

Protected Member Functions

 TrackerTool (void)
virtual ~TrackerTool (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void SetTrackerToolIdentifier (const std::string identifier)
 Set a unique identifier to the tracker tool.

Detailed Description

Abstract superclass for concrete IGSTK TrackerTool classes.

This class provides a generic implementation of a tool of a tracker. This may contain hardware specific details of the tool, along with the fields for position, orientation and error associated with the measurement used.

igstkDummyTrackerTool.png

TrackerTool State Machine Diagram

Definition at line 72 of file igstkTrackerTool.h.


Member Typedef Documentation

Definition at line 84 of file igstkTrackerTool.h.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual TransformType igstk::TrackerTool::GetCalibrationTransform (  )  [virtual]

Get the calibration transform for this tool.

void igstk::TrackerTool::SetCalibrationTransform ( const TransformType  ) 

Set the calibration transform for this tool.

virtual bool igstk::TrackerTool::GetUpdated (  )  [virtual]

Get whether the tool was updated during tracker UpdateStatus().

virtual void igstk::TrackerTool::RequestConfigure ( void   )  [virtual]

The "RequestConfigure" method attempts to configure the tracker tool.

virtual void igstk::TrackerTool::RequestDetachFromTracker (  )  [virtual]

The "RequestDetachFromTracker" method detaches the tracker tool from the tracker.

const std::string igstk::TrackerTool::GetTrackerToolIdentifier (  )  const

Access the unique identifier to the tracker tool.

virtual void igstk::TrackerTool::RequestAttachToTracker ( TrackerType  )  [virtual]

The "RequestAttachToTracker" method attaches the tracker tool to a tracker.

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

Print the object information in a stream.

Reimplemented from igstk::Object.

Reimplemented in igstk::AuroraTrackerTool.

void igstk::TrackerTool::SetTrackerToolIdentifier ( const std::string  identifier  )  [protected]

Set a unique identifier to the tracker tool.


Member Data Documentation

igstkStandardAbstractClassTraitsMacro ( TrackerTool, Object ) public typedef Tracker igstk::TrackerTool::TrackerType

Macro with standard traits declarations.

Definition at line 77 of file igstkTrackerTool.h.


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

Generated on Tue Dec 22 03:55:49 2009 for IGSTK by  doxygen 1.6.1