IGSTK
|
Implementation of a class that simulates a tracker. More...
#include <igstkSimulatedTracker.h>
Protected Types | |
typedef Tracker::ResultType | ResultType |
![]() | |
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 | |
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. | |
![]() | |
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 TrackerToolsContainerType & | GetTrackerToolContainer () 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. | |
![]() | |
LoggerType * | GetLogger () 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 | |
![]() | |
typedef Object | Self |
General Typedefs. | |
typedef ::itk::Object | Superclass |
typedef ::itk::SmartPointer< Self > | Pointer |
typedef ::itk::SmartPointer < const Self > | ConstPointer |
typedef igstk::Logger | LoggerType |
![]() | |
void | RequestOpen (void) |
The "RequestOpen" method attempts to open communication with the tracking device. | |
void | RequestClose (void) |
The "RequestClose" method closes communication with the device. | |
void | RequestReset (void) |
The "RequestReset" tracker method should be used to bring the tracker | |
void | RequestStartTracking (void) |
The "RequestStartTracking" method readies the tracker for tracking the | |
void | RequestStopTracking (void) |
The "RequestStopTracking" stops tracker from tracking the tools. | |
void | RequestSetFrequency (double frequencyInHz) |
The "RequestSetFrequency" method defines the frequency at which the Transform information will be queried from the Tracker device. | |
void | RequestSetReferenceTool (TrackerToolType *trackerTool) |
Set a reference tracker tool. | |
virtual void | SetThreadingEnabled (bool _arg) |
SetThreadingEnabled(bool) : set m_ThreadingEnabled value. | |
virtual bool | GetThreadingEnabled () |
GetThreadingEnabled(bool) : get m_ThreadingEnabled value. | |
![]() | |
static Pointer | New (void) |
![]() | |
igstkStandardAbstractClassTraitsMacro(Tracker, Object) public typedef TrackerTool | TrackerToolType |
Macro with standard traits declarations. |
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.
|
protected |
Definition at line 57 of file igstkSimulatedTracker.h.
|
protected |
Macro with standard traits declarations.
|
protectedvirtual |
|
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
Implements igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.
|
protectedvirtual |
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.
|
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
Implements igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.
|
protectedvirtual |
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.
|
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
Implements igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.
|
protectedvirtual |
Verify tracker tool information.
Implements igstk::Tracker.
|
protectedvirtual |
This method will remove entries of the traceker tool from internal data containers.
Implements igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.
|
protectedvirtual |
Add tracker tool entry to internal containers.
Implements igstk::Tracker.
|
protectedvirtual |
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.
|
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
Implements igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.
|
protectedvirtual |
Print object information.
Reimplemented from igstk::Tracker.
Reimplemented in igstk::CircularSimulatedTracker.