niftkNiftyLinkDataSourceService.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 niftkNiftyLinkDataSourceService_h
#define niftkNiftyLinkDataSourceService_h

#include "niftkNiftyLinkDataType.h"
#include <niftkIGIDataSource.h>
#include <niftkIGIDataSourceLocker.h>
#include <niftkIGIWaitForSavedDataSourceBuffer.h>
#include <niftkIGICleanableDataSourceI.h>
#include <niftkIGIDataSourceBackgroundDeleteThread.h>
#include <niftkIGIBufferedSaveableDataSourceI.h>
#include <niftkIGISaveableDataSourceI.h>
#include <niftkIGIDataSourceBackgroundSaveThread.h>
#include <NiftyLinkMessageContainer.h>

#include <igtlTrackingDataMessage.h>
#include <igtlImageMessage.h>
#include <igtlStringMessage.h>
#include <igtlTimeStamp.h>

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

namespace niftk
{

class NiftyLinkDataSourceService
    : public QObject
    , public IGIDataSource
    , public IGISaveableDataSourceI
    , public IGIBufferedSaveableDataSourceI
    , public IGICleanableDataSourceI
{

  Q_OBJECT

public:

  mitkClassMacroItkParent(NiftyLinkDataSourceService, IGIDataSource)

  
  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 SaveBuffer() 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:

  NiftyLinkDataSourceService(QString name,
                             QString factoryName,
                             const IGIDataSourceProperties& properties,
                             mitk::DataStorage::Pointer dataStorage
                             );
  virtual ~NiftyLinkDataSourceService();

  void MessageReceived(niftk::NiftyLinkMessageContainer::Pointer message);

private:
  NiftyLinkDataSourceService(const NiftyLinkDataSourceService&); // deliberately not implemented
  NiftyLinkDataSourceService& operator=(const NiftyLinkDataSourceService&); // deliberately not implemented

  std::vector<IGIDataItemInfo> ReceiveTrackingData(QString bufferName,
                                                   niftk::IGIDataType::IGITimeType timeRequested,
                                                   niftk::IGIDataType::IGITimeType actualTime,
                                                   igtl::TrackingDataMessage*);
  void SaveTrackingData(niftk::NiftyLinkDataType::Pointer, igtl::TrackingDataMessage*);
  void LoadTrackingData(const niftk::IGIDataType::IGITimeType& actualTime, QStringList& listOfFileNames);

  std::vector<IGIDataItemInfo> ReceiveImage(QString bufferName,
                                            niftk::IGIDataType::IGITimeType timeRequested,
                                            niftk::IGIDataType::IGITimeType actualTime,
                                            igtl::ImageMessage*);
  void SaveImage(niftk::NiftyLinkDataType::Pointer, igtl::ImageMessage*);
  void LoadImage(const niftk::IGIDataType::IGITimeType& actualTime, QStringList& listOfFileNames);

  std::vector<IGIDataItemInfo> ReceiveString(igtl::StringMessage*);

  void AddAll(const std::vector<IGIDataItemInfo>& a, std::vector<IGIDataItemInfo>& b);
  QString GetDirectoryNamePart(const QString& fullPathName, int indexFromEnd);

  QMutex                                                              m_Lock;
  niftk::IGIDataType::IGIIndexType                                    m_FrameId;
  niftk::IGIDataSourceBackgroundDeleteThread*                         m_BackgroundDeleteThread;
  niftk::IGIDataSourceBackgroundSaveThread*                           m_BackgroundSaveThread;
  int                                                                 m_Lag;

  // In contrast say to the OpenCV source, we store multiple playback indexes, key is device name.
  QMap<QString, std::set<niftk::IGIDataType::IGITimeType> >           m_PlaybackIndex;
  QMap<QString, QHash<niftk::IGIDataType::IGITimeType, QStringList> > m_PlaybackFiles;

  // In contrast say to the OpenCV source, we store multiple buffers, key is device name.
  QMap<QString, niftk::IGIWaitForSavedDataSourceBuffer::Pointer>      m_Buffers;

  // Make sure this is only used from the MessageReceived thread.
  igtl::TimeStamp::Pointer                                            m_MessageCreatedTimeStamp;

}; // end class

} // end namespace

#endif