niftkIGIDataSourceBuffer.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 niftkIGIDataSourceBuffer_h
#define niftkIGIDataSourceBuffer_h

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

#include <mitkCommon.h>

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

#include <set>
#include <QString>

namespace niftk
{

class NIFTKIGIDATASOURCES_EXPORT IGIDataSourceBuffer : public itk::Object
{
public:

  struct TimeStampComparator
  {
    bool operator()(const niftk::IGIDataType::Pointer& a, const niftk::IGIDataType::Pointer& b);
  };

  typedef std::set<niftk::IGIDataType::Pointer, TimeStampComparator> BufferType;

  mitkClassMacroItkParent(IGIDataSourceBuffer, itk::Object)
  mitkNewMacro1Param(IGIDataSourceBuffer, BufferType::size_type)

  QString GetName() const;
  void SetName(QString name);

  bool Contains(const niftk::IGIDataType::IGITimeType& time) const;

  void AddToBuffer(niftk::IGIDataType::Pointer item);

  void DestroyBuffer();

  virtual void CleanBuffer();

  void SetLagInMilliseconds(unsigned int milliseconds);

  unsigned int GetLagInMilliseconds() const;

  BufferType::size_type GetBufferSize() const;

  niftk::IGIDataType::IGITimeType GetFirstTimeStamp() const;

  niftk::IGIDataType::IGITimeType GetLastTimeStamp() const;

  float GetFrameRate() const;

  niftk::IGIDataType::Pointer GetItem(const niftk::IGIDataType::IGITimeType& time) const;

protected:

  IGIDataSourceBuffer(BufferType::size_type minSize); // Purposefully hidden.
  virtual ~IGIDataSourceBuffer(); // Purposefully hidden.

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

  itk::FastMutexLock::Pointer     m_Mutex;
  BufferType                      m_Buffer;
  BufferType::iterator            m_BufferIterator;
  BufferType::size_type           m_MinimumSize;
  QString                         m_Name;

private:

  void UpdateFrameRate();

  float                           m_FrameRate;
  niftk::IGIDataType::IGITimeType m_Lag; // stored in nanoseconds.

};

} // end namespace

#endif