IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::TrackerTool Class Referenceabstract

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]

Public Types

typedef Transform TransformType
 
- 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
 

Public Member Functions

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

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

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. More...
 
void SetTrackerToolIdentifier (const std::string identifier)
 Set a unique identifier to the tracker tool. 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

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 

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

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
protectedvirtual

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: