Frame.h

Go to the documentation of this file.

// Copyright (c) 2025 Optris GmbH Co. KG

 
#pragma once
 
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
#include "otcsdk/common/FrameIterator.h"
 
 
namespace optris
{

class Frame
{
  // Special iterator access.
  friend class ConstFrameIterator;
 
 
public:
  OTC_SDK_API Frame() noexcept;

  OTC_SDK_API Frame(const Frame&) = default;
  OTC_SDK_API Frame& operator=(const Frame&) = default;

  OTC_SDK_API Frame(Frame&&) = default;
  OTC_SDK_API Frame& operator=(Frame&&) = default;

  OTC_SDK_API virtual ~Frame() noexcept = default;
 

  OTC_SDK_API unsigned short getValue(int index) const noexcept(false);

  OTC_SDK_API unsigned short getValue(int x, int y) const noexcept(false);
 

  OTC_SDK_API ConstFrameIterator getConstIterator() const noexcept;
 

  OTC_SDK_API int getWidth() const noexcept;

  OTC_SDK_API int getHeight() const noexcept;

  OTC_SDK_API int getSize() const noexcept;

  OTC_SDK_API bool isEmpty() const noexcept;
 

  OTC_SDK_API void clear();

  OTC_SDK_API void resize(int width, int height);
 

  OTC_SDK_API Frame clone() const noexcept;

  OTC_SDK_API void setData(const unsigned short* source);

  OTC_SDK_API void setFromRawData(const void* source);

  OTC_SDK_API void copyDataTo(unsigned short* destination, int size) const noexcept;

  OTC_SDK_API const unsigned short* getData() const noexcept;
 
 
protected:
  std::vector<unsigned short> _values;
 
 
private:
  int _width;
  int _height;
};
 
 
// Inline implementation
inline ConstFrameIterator Frame::getConstIterator() const noexcept
{
  return ConstFrameIterator{*this};
}
 
inline int Frame::getWidth() const noexcept
{
  return _width;
}
 
inline int Frame::getHeight() const noexcept
{
  return _height;
}
 
inline int Frame::getSize() const noexcept
{
  return static_cast<int>(_values.size());
}
 
inline bool Frame::isEmpty() const noexcept
{
  return _values.empty();
}
 
inline Frame Frame::clone() const noexcept
{
  return Frame{*this};
}
 
inline const unsigned short* Frame::getData() const noexcept
{
  return _values.data();
}
 
} // namespace optris