niftkIGIDataType.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 niftkIGIDataType_h
#define niftkIGIDataType_h

#include "niftkIGIDataSourcesExports.h"
#include <niftkSystemTimeServiceI.h>
#include <mitkCommon.h>
#include <itkVersion.h>
#include <itkObject.h>
#include <itkObjectFactoryBase.h>

namespace niftk
{

class NIFTKIGIDATASOURCES_EXPORT IGIDataType : public itk::Object
{
public:

  typedef SystemTimeServiceI::TimeType IGITimeType;
  typedef unsigned long int IGIIndexType;

  mitkClassMacroItkParent(IGIDataType, itk::Object)
  itkNewMacro(IGIDataType)

  IGITimeType GetTimeStampInNanoSeconds() const;
  void SetTimeStampInNanoSeconds(const IGITimeType& time);

  itkSetMacro(Duration, IGITimeType);
  itkGetMacro(Duration, IGITimeType);

  itkSetMacro(FrameId, IGIIndexType);
  itkGetMacro(FrameId, IGIIndexType);

  itkSetMacro(IsSaved, bool);
  itkGetMacro(IsSaved, bool);

  itkSetMacro(ShouldBeSaved, bool);
  itkGetMacro(ShouldBeSaved, bool);

  itkSetMacro(FileName, std::string);
  itkGetMacro(FileName, std::string);

  virtual void* GetData() const { return NULL; }

protected:

  IGIDataType(); // Purposefully hidden.
  virtual ~IGIDataType(); // Purposefully hidden.

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

private:

  IGITimeType  m_TimeStamp;
  IGITimeType  m_Duration;
  IGIIndexType m_FrameId;
  bool         m_IsSaved;
  bool         m_ShouldBeSaved;
  std::string  m_FileName;
};

} // end namespace

#endif