niftkIGIDataSourceManager.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 niftkIGIDataSourceManager_h
#define niftkIGIDataSourceManager_h

#include "niftkIGIDataSourcesManagerExports.h"
#include <niftkIGIDataSourceFactoryServiceI.h>
#include <niftkIGIDataSourceI.h>
#include <niftkIGIDataType.h>

#include <usServiceReference.h>
#include <usModuleContext.h>

#include <mitkDataStorage.h>
#include <mitkCommon.h>
#include <itkVersion.h>
#include <itkObject.h>
#include <itkObjectFactoryBase.h>
#include <igtlTimeStamp.h>

#include <QMap>
#include <QTimer>
#include <QList>
#include <QString>
#include <QObject>
#include <QMutex>

namespace niftk
{

class NIFTKIGIDATASOURCESMANAGER_EXPORT IGIDataSourceManager : public QObject
{

  Q_OBJECT

public:

  static const int    DEFAULT_FRAME_RATE;
  static const char*  DEFAULT_RECORDINGDESTINATION_ENVIRONMENTVARIABLE;

  IGIDataSourceManager(mitk::DataStorage::Pointer dataStorage, QObject* parent);
  virtual ~IGIDataSourceManager();

  bool IsPlayingBack() const;

  bool IsPlayingBackAutomatically() const;

  bool IsUpdateTimerOn() const;

  void SetIsPlayingBackAutomatically(bool isPlayingBackAutomatically);

  void StopUpdateTimer();

  void StartUpdateTimer();

  static QString GetDefaultPath();

  QString GetDirectoryName();

  void SetDirectoryPrefix(const QString& directoryPrefix);

  void SetFramesPerSecond(const int& framesPerSecond);

  int GetFramesPerSecond() const;

  void WriteDescriptorFile(QString absolutePath);

  QList<QString> GetAllFactoryNames() const;

  bool NeedsStartupGui(QString name);

  void AddSource(QString name, QMap<QString, QVariant>& properties);

  void RemoveSource(int rowIndex);

  void RemoveAllSources();

  void StartRecording(QString absolutePath);

  void StopRecording();

  void FreezeAllDataSources(bool isFrozen);

  void FreezeDataSource(unsigned int i, bool isFrozen);

  bool IsFrozen(unsigned int i) const;

  void StartPlayback(const QString& directoryPrefix,
                     const QString& descriptorPath,
                     IGIDataType::IGITimeType& startTime,
                     IGIDataType::IGITimeType& endTime,
                     int& sliderMax,
                     int& sliderSingleStep,
                     int& sliderPageStep,
                     int& sliderValue
                     );

  void StopPlayback();

  int ComputePlaybackTimeSliderValue(QString textEditField) const;

  IGIDataType::IGITimeType ComputeTimeFromSlider(int sliderValue) const;

  void SetPlaybackTime(const IGIDataType::IGITimeType& time);

  void SetIsGrabbingScreen(QString directoryName, bool isGrabbing);

  niftk::IGIDataSourceFactoryServiceI* GetFactory(QString name);

  niftk::IGIDataSourceFactoryServiceI* GetFactory(int rowNumber);

  niftk::IGIDataSourceI::Pointer GetSource(int rowNumber);

  void GlobalReInit();

signals:

  void UpdateFinishedDataSources(niftk::IGIDataType::IGITimeType, QList< QList<IGIDataItemInfo> >);

  void UpdateFinishedRendering();

  void PlaybackTimerAdvanced(int sliderValue);

  void TimerUpdated(QString rawTimeStamp, QString humanReadableTimeStamp);

  void BroadcastStatusString(QString);

protected:

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

private slots:

  void OnUpdateGui();

private:

  void RetrieveAllDataSourceFactories();

  QMap<QString, QString> ParseDataSourceDescriptor(const QString& filepath);

  void AdvancePlaybackTimer();

  void SetIsPlayingBack(bool isPlayingBack);

  void GrabScreen();

  mitk::DataStorage::Pointer                                       m_DataStorage;
  us::ModuleContext*                                               m_ModuleContext;
  std::vector<us::ServiceReference<IGIDataSourceFactoryServiceI> > m_Refs;
  QList<niftk::IGIDataSourceI::Pointer>                            m_Sources;
  QMap<QString, niftk::IGIDataSourceFactoryServiceI*>              m_NameToFactoriesMap;
  QMap<QString, niftk::IGIDataSourceFactoryServiceI*>              m_LegacyNameToFactoriesMap;
  QMutex                                                           m_Lock;
  QTimer                                                          *m_GuiUpdateTimer;
  int                                                              m_FrameRate;
  QString                                                          m_DirectoryPrefix;
  QString                                                          m_PlaybackPrefix;
  igtl::TimeStamp::Pointer                                         m_TimeStampGenerator;
  bool                                                             m_IsPlayingBack;
  bool                                                             m_IsPlayingBackAutomatically;
  niftk::IGIDataType::IGITimeType                                  m_CurrentTime;

  int                                                              m_PlaybackSliderValue;
  int                                                              m_PlaybackSliderMaxValue;

  // Slider position is relative to this base value.
  // Slider can only represent int values, but we need all 64 bit.
  niftk::IGIDataType::IGITimeType                                  m_PlaybackSliderBase;
  niftk::IGIDataType::IGITimeType                                  m_PlaybackSliderFactor;

  bool                                                             m_IsGrabbingScreen;
  QString                                                          m_ScreenGrabDir;

}; // end class;

} // end namespace

#endif