mitkTrackingDevice.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/


#ifndef MITKTRACKINGDEVICE_H_HEADER_INCLUDED_C1C2FCD2
#define MITKTRACKINGDEVICE_H_HEADER_INCLUDED_C1C2FCD2

#include <MitkIGTExports.h>
#include "itkObject.h"
#include "mitkCommon.h"
#include "mitkTrackingTypes.h"
#include "mitkNavigationToolStorage.h"
#include <mutex>

namespace mitk {
    class TrackingTool; // interface for a tool that can be tracked by the TrackingDevice

    class MITKIGT_EXPORT TrackingDevice : public itk::Object
    {
    public:
      mitkClassMacroItkParent(TrackingDevice, itk::Object);

      enum RotationMode {RotationStandard, RotationTransposed};

      enum TrackingDeviceState {Setup, Ready, Tracking};   

      virtual bool OpenConnection() = 0;

      virtual bool CloseConnection() = 0; 

      virtual bool StartTracking() = 0;

      virtual bool StopTracking();

      virtual TrackingTool* GetTool(unsigned int toolNumber) const = 0;

      virtual mitk::TrackingTool* GetToolByName(std::string name) const;

      virtual unsigned int GetToolCount() const = 0;

      virtual void SetRotationMode(RotationMode r);

      itkGetConstMacro(RotationMode,RotationMode);

      TrackingDeviceState GetState() const;

    TrackingDeviceType GetType() const;
    void SetType(TrackingDeviceType type);

    std::string GetTrackingDeviceName();

    TrackingDeviceData GetData() const;
    void SetData(TrackingDeviceData data);

    virtual bool IsDeviceInstalled();

    virtual bool AutoDetectToolsAvailable();

    virtual bool AddSingleToolIsAvailable();

    virtual mitk::NavigationToolStorage::Pointer AutoDetectTools();

    private:
      TrackingDeviceState m_State; 
    protected:

      void SetState(TrackingDeviceState state);


      TrackingDevice();
      ~TrackingDevice() override;

    TrackingDeviceData m_Data; 

      bool m_StopTracking;       
      std::mutex m_StopTrackingMutex; 
      std::mutex m_TrackingFinishedMutex; 
      mutable std::mutex m_StateMutex; 
      RotationMode m_RotationMode; 
    };
} // namespace mitk

#endif /* MITKTRACKINGDEVICE_H_HEADER_INCLUDED_C1C2FCD2 */