MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
TrackingDeviceTestClass Class Reference
Inheritance diagram for TrackingDeviceTestClass:
mitk::TrackingDevice

Public Member Functions

 mitkClassMacro (TrackingDeviceTestClass, mitk::TrackingDevice)
 
 itkFactorylessNewMacro (Self) itkCloneMacro(Self) bool OpenConnection() override
 
bool CloseConnection () override
 Closes the connection to the device.
 
bool StartTracking () override
 start retrieving tracking data from the device.
 
mitk::TrackingToolGetTool (unsigned int) const override
 Return tool with index toolNumber.
 
unsigned int GetToolCount () const override
 Returns number of tracking tools.
 
- Public Member Functions inherited from mitk::TrackingDevice
 mitkClassMacroItkParent (TrackingDevice, itk::Object)
 
virtual bool OpenConnection ()=0
 Opens a connection to the device.
 
virtual bool StopTracking ()
 stop retrieving tracking data from the device. stop retrieving tracking data from the device. This may only be called after StartTracking was called (e.g. the object is in Tracking mode). This will change the object state from Tracking to Ready.
 
virtual mitk::TrackingToolGetToolByName (std::string name) const
 Returns the tool with the given tool name.
 
virtual void SetRotationMode (RotationMode r)
 
 itkGetConstMacro (RotationMode, RotationMode)
 
TrackingDeviceState GetState () const
 return current object state (Setup, Ready or Tracking)
 
TrackingDeviceType GetType () const
 Deprecated! Use the more specific getData or GetTrackingDeviceName instead. return device type identifier.
 
void SetType (TrackingDeviceType type)
 Deprecated! Use the more specific setDeviceData instead. set device type.
 
std::string GetTrackingDeviceName ()
 Convenient Method to get the Name of the Tracking Device. This is identical with GetData().Line and can be used to compare with TrackingDeviceTypeInformation::GetTrackingDeviceName() to check if you have a specific device.
 
TrackingDeviceData GetData () const
 return device data
 
void SetData (TrackingDeviceData data)
 set device type
 
virtual bool IsDeviceInstalled ()
 
virtual bool AutoDetectToolsAvailable ()
 
virtual bool AddSingleToolIsAvailable ()
 
virtual mitk::NavigationToolStorage::Pointer AutoDetectTools ()
 

Additional Inherited Members

- Public Types inherited from mitk::TrackingDevice
enum  RotationMode { RotationStandard , RotationTransposed }
 
enum  TrackingDeviceState { Setup , Ready , Tracking }
 
- Protected Member Functions inherited from mitk::TrackingDevice
void SetState (TrackingDeviceState state)
 change object state
 
 TrackingDevice ()
 
 ~TrackingDevice () override
 
- Protected Attributes inherited from mitk::TrackingDevice
TrackingDeviceData m_Data
 current device Data
 
bool m_StopTracking
 signal stop to tracking thread
 
std::mutex m_StopTrackingMutex
 mutex to control access to m_StopTracking
 
std::mutex m_TrackingFinishedMutex
 mutex to manage control flow of StopTracking()
 
std::mutex m_StateMutex
 mutex to control access to m_State
 
RotationMode m_RotationMode
 defines the rotation mode Standard or Transposed, Standard is default
 

Detailed Description

Create new class and derive it from TrackingDevice

Definition at line 42 of file mitkTrackingDeviceTest.cpp.

Member Function Documentation

◆ CloseConnection()

bool TrackingDeviceTestClass::CloseConnection ( )
inlineoverridevirtual

Closes the connection to the device.

This may only be called if there is currently a connection to the device, but tracking is not running (e.g. object is in Ready state) Closes the connection with the device

Implements mitk::TrackingDevice.

Definition at line 51 of file mitkTrackingDeviceTest.cpp.

◆ GetTool()

mitk::TrackingTool * TrackingDeviceTestClass::GetTool ( unsigned int toolNumber) const
inlineoverridevirtual

Return tool with index toolNumber.

tools are numbered from 0 to GetToolCount() - 1.

Implements mitk::TrackingDevice.

Definition at line 53 of file mitkTrackingDeviceTest.cpp.

◆ GetToolCount()

unsigned int TrackingDeviceTestClass::GetToolCount ( ) const
inlineoverridevirtual

Returns number of tracking tools.

Implements mitk::TrackingDevice.

Definition at line 54 of file mitkTrackingDeviceTest.cpp.

◆ itkFactorylessNewMacro()

TrackingDeviceTestClass::itkFactorylessNewMacro ( Self )
inlineoverride

Definition at line 47 of file mitkTrackingDeviceTest.cpp.

◆ mitkClassMacro()

TrackingDeviceTestClass::mitkClassMacro ( TrackingDeviceTestClass ,
mitk::TrackingDevice  )

◆ StartTracking()

bool TrackingDeviceTestClass::StartTracking ( )
inlineoverridevirtual

start retrieving tracking data from the device.

This may only be called after the connection to the device has been established with a call to OpenConnection() (E.g. object is in Ready mode). This will change the object state from Ready to Tracking

Implements mitk::TrackingDevice.

Definition at line 52 of file mitkTrackingDeviceTest.cpp.


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