niftkIGIDataSourceI.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 niftkIGIDataSourceI_h
#define niftkIGIDataSourceI_h

#include "niftkIGIDataSourcesExports.h"
#include <niftkIGIDataType.h>

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

#include <QMap>
#include <QString>
#include <QVariant>

namespace niftk
{

typedef QMap<QString, QVariant> IGIDataSourceProperties;

struct NIFTKIGIDATASOURCES_EXPORT IGIDataItemInfo
{
  IGIDataItemInfo()
  {
    m_Name = "Unknown";
    m_IsLate = false;
    m_LagInMilliseconds = 0;
    m_FramesPerSecond = 0;
  }

  QString      m_Name;
  bool         m_IsLate;
  unsigned int m_LagInMilliseconds;
  float        m_FramesPerSecond;
};


class NIFTKIGIDATASOURCES_EXPORT IGIDataSourceI : public itk::Object
{

public:

  mitkClassMacroItkParent(IGIDataSourceI, itk::Object)

  
  virtual QString GetName() const = 0;

  virtual QString GetFactoryName() const = 0;

  virtual QString GetStatus() const = 0;

  virtual QString GetDescription() const = 0;

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

  virtual void StopPlayback() = 0;

  virtual void PlaybackData(niftk::IGIDataType::IGITimeType requestedTimeStamp) = 0;

  virtual void SetRecordingLocation(const QString& pathName) = 0;

  virtual QString GetRecordingLocation() const = 0;

  virtual void SetPlaybackSourceName(const QString& sourceName) = 0;
  virtual QString GetPlaybackSourceName() const = 0;

  virtual void StartRecording() = 0;

  virtual void StopRecording() = 0;

  virtual void SetShouldUpdate(bool shouldUpdate) = 0;

  virtual bool GetShouldUpdate() const = 0;

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

  virtual bool ProbeRecordedData(niftk::IGIDataType::IGITimeType* firstTimeStampInStore,
                                 niftk::IGIDataType::IGITimeType* lastTimeStampInStore) = 0;

  virtual void SetProperties(const IGIDataSourceProperties& properties) = 0;

  virtual IGIDataSourceProperties GetProperties() const = 0;

protected:

  IGIDataSourceI();
  virtual ~IGIDataSourceI();

private:

  IGIDataSourceI(const IGIDataSourceI&); // deliberately not implemented
  IGIDataSourceI& operator=(const IGIDataSourceI&); // deliberately not implemented
};

} // end namespace

#endif