niftkMITKTrackerDataSourceService.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/
#ifndef niftkMITKTrackerDataSourceService_h
#define niftkMITKTrackerDataSourceService_h

#include <niftkIGIDataSource.h>
#include <niftkIGIDataSourceLocker.h>
#include <niftkIGIDataSourceBuffer.h>
#include <niftkIGILocalDataSourceI.h>
#include <niftkIGIDataSourceGrabbingThread.h>
#include <niftkIGICleanableDataSourceI.h>
#include <niftkIGIDataSourceBackgroundDeleteThread.h>
#include <niftkIGIBufferedSaveableDataSourceI.h>

#include <niftkNDITracker.h>

#include <QObject>
#include <QSet>
#include <QMutex>
#include <QString>

namespace niftk
{

class MITKTrackerDataSourceService
    : public QObject
    , public IGIDataSource
    , public IGILocalDataSourceI
    , public IGICleanableDataSourceI
    , public IGIBufferedSaveableDataSourceI
{

public:

  mitkClassMacroItkParent(MITKTrackerDataSourceService, IGIDataSource)
  mitkNewMacro5Param(MITKTrackerDataSourceService, QString, QString,
                     const IGIDataSourceProperties&, mitk::DataStorage::Pointer, niftk::NDITracker::Pointer)

  virtual void StartPlayback(niftk::IGIDataType::IGITimeType firstTimeStamp,
                             niftk::IGIDataType::IGITimeType lastTimeStamp) override;

  void PlaybackData(niftk::IGIDataType::IGITimeType requestedTimeStamp) override;

  virtual void StopPlayback() override;

  virtual std::vector<IGIDataItemInfo> Update(const niftk::IGIDataType::IGITimeType& time) override;

  virtual void SaveItem(niftk::IGIDataType::Pointer item) override;

  virtual void CleanBuffer() override;

  virtual void GrabData() override;

  bool ProbeRecordedData(niftk::IGIDataType::IGITimeType* firstTimeStampInStore,
                         niftk::IGIDataType::IGITimeType* lastTimeStampInStore) override;

  virtual void SetProperties(const IGIDataSourceProperties& properties) override;

  virtual IGIDataSourceProperties GetProperties() const override;

protected:

  MITKTrackerDataSourceService(QString name,
                               QString factoryName,
                               const IGIDataSourceProperties& properties,
                               mitk::DataStorage::Pointer dataStorage,
                               niftk::NDITracker::Pointer tracker
                              );
  virtual ~MITKTrackerDataSourceService();

private:

  MITKTrackerDataSourceService(const MITKTrackerDataSourceService&); // deliberately not implemented
  MITKTrackerDataSourceService& operator=(const MITKTrackerDataSourceService&); // deliberately not implemented

  QMap<QString, std::set<niftk::IGIDataType::IGITimeType> > GetPlaybackIndex(QString directory);

  static niftk::IGIDataSourceLocker                         s_Lock;
  QMutex                                                    m_Lock;
  int                                                       m_TrackerNumber;
  niftk::IGIDataType::IGIIndexType                          m_FrameId;
  niftk::IGIDataSourceBackgroundDeleteThread*               m_BackgroundDeleteThread;
  niftk::IGIDataSourceGrabbingThread*                       m_DataGrabbingThread;
  int                                                       m_Lag;
  QMap<QString, std::set<niftk::IGIDataType::IGITimeType> > m_PlaybackIndex;

  // The main tracker.
  niftk::NDITracker::Pointer                                m_Tracker;

  // In contrast say to the OpenCV source, we store multiple buffers, keyed by tool name.
  QMap<QString, niftk::IGIDataSourceBuffer::Pointer>        m_Buffers;

}; // end class

} // end namespace

#endif