IGSTK
|
Provides support for the Ascension trackers. More...
#include <igstkAscensionTracker.h>
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 TrackerToolsContainerType & | GetTrackerToolContainer () 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... | |
![]() | |
LoggerType * | GetLogger () 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 | |
![]() | |
typedef Object | Self |
General Typedefs. More... | |
typedef ::itk::Object | Superclass |
typedef ::itk::SmartPointer< Self > | Pointer |
typedef ::itk::SmartPointer < const Self > | ConstPointer |
typedef igstk::Logger | LoggerType |
![]() | |
static Pointer | New (void) |
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.
|
protected |
typedef for internal boolean return type
Definition at line 67 of file igstkAscensionTracker.h.
|
protected |
|
protectedvirtual |
void igstk::AscensionTracker::SetCommunication | ( | CommunicationType * | communication | ) |
The SetCommunication method is used to attach a communication object to the tracker object.
|
virtual |
Get the number of tools that have been detected.
|
protectedvirtual |
Open communication with the tracking device.
Implements igstk::Tracker.
|
protectedvirtual |
Close communication with the tracking device.
Implements igstk::Tracker.
|
protectedvirtual |
Activate the tools attached to the tracking device.
|
protectedvirtual |
Deactivate the tools attached to the tracking device.
|
protectedvirtual |
Put the tracking device into tracking mode.
Implements igstk::Tracker.
|
protectedvirtual |
Take the tracking device out of tracking mode.
Implements igstk::Tracker.
|
protectedvirtual |
Update the status and the transforms for all TrackerTools.
Implements igstk::Tracker.
|
protectedvirtual |
Update the status and the transforms.
This function is called by a separate thread.
Implements igstk::Tracker.
|
protectedvirtual |
Verify tracker tool information.
Implements igstk::Tracker.
|
protectedvirtual |
Add tracker tool entry from internal containers.
Implements igstk::Tracker.
|
protectedvirtual |
Remove tracker tool from internal containers.
Implements igstk::Tracker.
|
protectedvirtual |
Reset the tracking device to put it back to its original state.
Implements igstk::Tracker.
|
protectedvirtual |
Print object information.
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.