PlusStreamBufferItem.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
Program: Plus
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __StreamBufferItem_h
#define __StreamBufferItem_h

#include "vtkPlusDataCollectionExport.h"

// IGSIO includes
#include <igsioCommon.h>

// VTK includes
#include <vtkSmartPointer.h>

#include <vector>

class vtkMatrix4x4;
class vtkPlusDevice;
class vtkPlusChannel;
class vtkPlusDataSource;
class vtkPlusDataSource;
class vtkPlusVirtualMixer;

#ifdef _WIN32
  typedef unsigned __int64 BufferItemUidType;
#else
  typedef unsigned long long BufferItemUidType;
#endif

class vtkPlusDataCollectionExport StreamBufferItem
{
public:
  StreamBufferItem();
  virtual ~StreamBufferItem();

  StreamBufferItem(const StreamBufferItem& dataItem);
  StreamBufferItem& operator=(StreamBufferItem const& dataItem);

  double GetTimestamp(double localTimeOffsetSec) { return this->GetFilteredTimestamp(localTimeOffsetSec); }

  double GetFilteredTimestamp(double localTimeOffsetSec) { return this->FilteredTimeStamp + localTimeOffsetSec; }

  void SetFilteredTimestamp(double filteredTimestamp) { this->FilteredTimeStamp = filteredTimestamp; }

  double GetUnfilteredTimestamp(double localTimeOffsetSec) { return this->UnfilteredTimeStamp + localTimeOffsetSec; }

  void SetUnfilteredTimestamp(double unfilteredTimestamp) { this->UnfilteredTimeStamp = unfilteredTimestamp; }

  unsigned long GetIndex() { return this->Index; };
  void SetIndex(unsigned long index) { this->Index = index; };

  BufferItemUidType GetUid() { return this->Uid; };
  void SetUid(BufferItemUidType uid) { this->Uid = uid; };

  void SetFrameField(std::string fieldName, std::string fieldValue, igsioFrameFieldFlags flags = FRAMEFIELD_NONE);

  std::string GetFrameField(const std::string& fieldName) const;
  igsioFieldMapType GetFrameFieldMap() {return this->FrameFields;}
  PlusStatus DeleteFrameField(const char* fieldName);
  PlusStatus DeleteFrameField(const std::string& fieldName);

  PlusStatus DeepCopy(StreamBufferItem* dataItem);

  igsioVideoFrame& GetFrame() { return this->Frame; };

  PlusStatus SetMatrix(vtkMatrix4x4* matrix);
  PlusStatus GetMatrix(vtkMatrix4x4* outputMatrix);

  void SetStatus(ToolStatus status);
  ToolStatus GetStatus() const;

  void SetValidTransformData(bool aValid) { ValidTransformData = aValid; }
  bool HasValidTransformData() const { return ValidTransformData; }
  bool HasValidFieldData() const;
  bool HasValidVideoData() const
  {
    return Frame.IsImageValid();
  }

protected:
  double FilteredTimeStamp;
  double UnfilteredTimeStamp;

  unsigned long Index;

  BufferItemUidType Uid;

  igsioFieldMapType FrameFields;

  bool ValidTransformData;
  igsioVideoFrame Frame;
  vtkSmartPointer<vtkMatrix4x4> Matrix;
  ToolStatus Status;
};

#endif