MultiImageView.h

#pragma once
 
#include <cstdint>
#include <memory>
 
#include <iolink/FlagSet.h>
#include <iolink/IOLinkAPI.h>
#include <iolink/metadata/MetadataNode.h>
#include <iolink/view/ImageView.h>
#include <iolink/view/View.h>
 
namespace iolink
{
 
enum class MultiImageCapability
{
  // Flags
  READ = 0x1,  
  WRITE = 0x2, 
 
  // Combinations
  READ_WRITE = 0x3, 
};
 
extern template class IOLINK_API_IMPORT FlagSet<MultiImageCapability>;
 
using MultiImageCapabilitySet = FlagSet<MultiImageCapability>;
 
// Define bitwise operators for MultiImageCapability
IOLINK_DEFINE_ENUM_BITWISE_OPERATORS(MultiImageCapability)
 
 
class IOLINK_API MultiImageView : public View
{
public:
  virtual ~MultiImageView() = default;
 
  virtual MultiImageCapabilitySet capabilities() const = 0;
 
  inline bool support(MultiImageCapabilitySet flags) { return this->capabilities().has(flags); }
 
  std::string toString() const;
 
  // ==== //
  // READ //
  // ==== //
 
  virtual size_t frameCount() const;
 
  virtual std::shared_ptr<ImageView> frame(size_t index);
 
  virtual std::shared_ptr<const MetadataNode> metadata() const;
 
  // ===== //
  // WRITE //
  // ===== //
 
  virtual void addFrame(std::shared_ptr<ImageView> newFrame);
 
  virtual void setFrame(size_t index, std::shared_ptr<ImageView> frame);
 
  virtual void removeFrame(size_t index);
 
  virtual void setMetadata(std::shared_ptr<MetadataNode> metadata);
};
 
} // namespace iolink