niftkIGIDataSource.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 niftkIGIDataSource_h
#define niftkIGIDataSource_h

#include <niftkIGIDataSourcesExports.h>
#include <niftkIGIDataType.h>
#include <niftkSystemTimeServiceRAII.h>
#include <niftkIGIDataSourceI.h>
#include <niftkSystemTimeServiceI.h>

#include <mitkDataStorage.h>
#include <mitkServiceInterface.h>
#include <usServiceRegistration.h>

#include <QDir>
#include <QString>

namespace niftk
{

class NIFTKIGIDATASOURCES_EXPORT IGIDataSource : public niftk::IGIDataSourceI
{
public:

  mitkClassMacroItkParent(IGIDataSource, niftk::IGIDataSourceI)

  
  virtual QString GetName() const override;

  virtual QString GetFactoryName() const override;

  virtual QString GetStatus() const override;

  QString GetDescription() const override;

  virtual bool GetShouldUpdate() const override;

  virtual void SetShouldUpdate(bool shouldUpdate) override;

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

  virtual void StopPlayback() override;

  virtual void StartRecording() override;

  virtual void StopRecording() override;

  virtual void SetRecordingLocation(const QString& pathName) override;

  virtual QString GetRecordingLocation() const override;

  virtual void SetPlaybackSourceName(const QString& sourceName) override;

  virtual QString GetPlaybackSourceName() const override;

  QString GetPlaybackDirectory() const;

  QString GetRecordingDirectory() const;

  itkGetConstMacro(IsRecording, bool);
  itkGetConstMacro(IsPlayingBack, bool);

  itkSetMacro(TimeStampTolerance, niftk::IGIDataType::IGITimeType);
  itkGetConstMacro(TimeStampTolerance, niftk::IGIDataType::IGITimeType);

protected:

  IGIDataSource(const std::string& name,
                const std::string& factoryName,
                mitk::DataStorage::Pointer dataStorage); // Purposefully hidden.
  virtual ~IGIDataSource(); // Purposefully hidden.

  IGIDataSource(const IGIDataSource&); // Purposefully not implemented.
  IGIDataSource& operator=(const IGIDataSource&); // Purposefully not implemented.

  mitk::DataNode::Pointer GetDataNode(const QString& name=QString(), const bool& addToDataStorage=true);

  bool IsLate(const niftk::IGIDataType::IGITimeType& requested,
              const niftk::IGIDataType::IGITimeType& actual
              ) const;

  unsigned int GetLagInMilliseconds(const niftk::IGIDataType::IGITimeType& requested,
                                    const niftk::IGIDataType::IGITimeType& actual
                                   ) const;

  mitk::DataStorage::Pointer GetDataStorage() const;

  niftk::IGIDataType::IGITimeType GetTimeStampInNanoseconds();

  itkSetMacro(IsRecording, bool);
  itkSetMacro(IsPlayingBack, bool);

  void SetStatus(const QString& status);
  void SetDescription(const QString& description);

private:

  niftk::SystemTimeServiceRAII     *m_SystemTimeService;
  mitk::DataStorage::Pointer        m_DataStorage;
  std::set<mitk::DataNode::Pointer> m_DataNodes;
  us::ServiceRegistration<Self>     m_MicroServiceRegistration;
  QString                           m_Name;
  QString                           m_FactoryName;
  QString                           m_Status;
  QString                           m_Description;
  QString                           m_RecordingLocation;
  QString                           m_PlaybackSourceName;
  niftk::IGIDataType::IGITimeType   m_TimeStampTolerance; // nanoseconds.
  bool                              m_ShouldUpdate;
  bool                              m_IsRecording;
  bool                              m_IsPlayingBack;
};

} // end namespace

MITK_DECLARE_SERVICE_INTERFACE(niftk::IGIDataSource, "uk.ac.ucl.cmic.IGIDataSource")

#endif