FrameMetadata.h

Go to the documentation of this file.

// Copyright (c) 2008-2025 Optris GmbH & Co. KG

 
#pragma once
 
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
#include "otcsdk/common/FlagState.h"
#include "otcsdk/common/RadiationParameters.h"
 
 
namespace optris 
{
// Forward declaration
struct FrameMetadata2;
 

class FrameMetadata
{
public:
  OTC_SDK_API FrameMetadata() noexcept;
 
  
  static FrameMetadata fromRawMetadata(FrameMetadata2* raw, 
                                       bool            initializing, 
                                       int             pifActualDeviceCount,
                                       int             pifConfigurableDeviceCount);
 

  int getSize() const noexcept;

  void setSize(int size) noexcept;
 

  bool isFrameDataReliable() const noexcept;
 

  unsigned int getCounter() const noexcept;

  unsigned int getCounterHardware() const noexcept;

  void setCounters(unsigned int counter, unsigned int counterHardware) noexcept;
 

  long long getTimestamp() const noexcept;

  long long getTimestampMedia() const noexcept;

  void setTimestamps(long long timestamp, long long timestampMedia) noexcept;
 

  FlagState getFlagState() const noexcept;

  void setFlagState(FlagState flagState) noexcept;
 

  float getTemperatureFlag() const noexcept;

  float getTemperatureBox() const noexcept;

  float getTemperatureChip() const noexcept;

  void setProbeTemperatures(float flag, float box, float chip) noexcept;

  RadiationParameterSource getEmissivitySource() const noexcept;

  RadiationParameterSource getTransmissivitySource() const noexcept;

  RadiationParameterSource getAmbientTemperatureSource() const noexcept;

  RadiationParameters getRadiationParameters() const noexcept;

  void setRadiationParameterSources(RadiationParameterSource emissivitySource,
                                    RadiationParameterSource ambientTemperatureSource) noexcept;

  OTC_SDK_API float getPifAiValue(int deviceIndex, int pinIndex) const;

  OTC_SDK_API bool getPifDiValue(int deviceIndex, int pinIndex) const;

  int getPifActualDeviceCount() const noexcept;

  int getPifConfigurableDeviceCount() const noexcept;

  int getPifAiCountPerDevice() const noexcept;

  int getPifDiCountPerDevice() const noexcept;

  OTC_SDK_API void setPifCounts(int actualDeviceCount,
                                int configurableDeviceCount, 
                                int aiCountPerDevice, 
                                int diCountPerDevice) noexcept;

  OTC_SDK_API void setPifAiValue(int deviceIndex, int pinIndex, float value);

  OTC_SDK_API void setPifDiValue(int deviceIndex, int pinIndex, bool value);
 

  OTC_SDK_API FrameMetadata clone() const noexcept;
 
 
private:
  unsigned short _size;
  
  unsigned int _counter;
  unsigned int _counterHardware;

  long long _timestamp;
  long long _timestampMedia;

  FlagState _flagState;

  float _temperatureFlag;
  float _temperatureBox;
  float _temperatureChip;

  RadiationParameters _radiation;
  RadiationParameterSource _emissivitySource;
  RadiationParameterSource _ambientTemperatureSource;

  int _pifActualDeviceCount;
  int _pifConfigurableDeviceCount;

  int _pifAiCountPerDevice;
  std::vector<float> _pifAiValues;

  int _pifDiCountPerDevice;
  std::vector<bool> _pifDiValues;
};
 
 
// Inline implementations
inline int FrameMetadata::getSize() const noexcept
{
  return _size;
}
 
inline void FrameMetadata::setSize(int size) noexcept
{
  _size = size;
}
 
inline bool FrameMetadata::isFrameDataReliable() const noexcept
{
  return (_flagState != FlagState::Initializing);
}
 
inline unsigned int FrameMetadata::getCounter() const noexcept
{
  return _counter;
}
 
inline unsigned int FrameMetadata::getCounterHardware() const noexcept
{
  return _counterHardware;
}
 
inline void FrameMetadata::setCounters(unsigned int counter, unsigned int counterHardware) noexcept
{
  _counter         = counter;
  _counterHardware = counterHardware;
}
 
inline long long FrameMetadata::getTimestamp() const noexcept
{
  return _timestamp;
}
 
inline long long FrameMetadata::getTimestampMedia() const noexcept
{
  return _timestampMedia;
}
 
inline void FrameMetadata::setTimestamps(long long timestamp, long long timestampMedia) noexcept
{
  _timestamp      = timestamp;
  _timestampMedia = timestampMedia;
}
 
inline FlagState FrameMetadata::getFlagState() const noexcept
{
  return _flagState;
}
 
inline void FrameMetadata::setFlagState(FlagState flagState) noexcept
{
  _flagState = flagState;
}
 
inline float FrameMetadata::getTemperatureFlag() const noexcept
{
  return _temperatureFlag;
}
 
inline float FrameMetadata::getTemperatureBox() const noexcept
{
  return _temperatureBox;
}
 
inline float FrameMetadata::getTemperatureChip() const noexcept
{
  return _temperatureChip;
}
 
inline void FrameMetadata::setProbeTemperatures(float flag, float box, float chip) noexcept
{
  _temperatureFlag = flag;
  _temperatureBox  = box;
  _temperatureChip = chip;
}
 
inline RadiationParameters FrameMetadata::getRadiationParameters() const noexcept
{
  return _radiation;
}
 
inline RadiationParameterSource FrameMetadata::getEmissivitySource() const noexcept
{
  return _emissivitySource;
}
 
inline RadiationParameterSource FrameMetadata::getTransmissivitySource() const noexcept
{
  return RadiationParameterSource::Sdk;
}
 
inline RadiationParameterSource FrameMetadata::getAmbientTemperatureSource() const noexcept
{
  return _ambientTemperatureSource;
}
 
inline void FrameMetadata::setRadiationParameterSources(RadiationParameterSource emissivitySource,
                                                        RadiationParameterSource ambientTemperatureSource) noexcept
{
  _emissivitySource         = emissivitySource;
  _ambientTemperatureSource = ambientTemperatureSource;
}                                                
 
inline int FrameMetadata::getPifActualDeviceCount() const noexcept
{
  return _pifActualDeviceCount;
}
 
inline int FrameMetadata::getPifConfigurableDeviceCount() const noexcept
{
  return _pifConfigurableDeviceCount;
}
 
inline int FrameMetadata::getPifAiCountPerDevice() const noexcept
{
  return _pifAiCountPerDevice;
}
 
inline int FrameMetadata::getPifDiCountPerDevice() const noexcept
{
  return _pifDiCountPerDevice;
}
 
inline FrameMetadata FrameMetadata::clone() const noexcept
{
  return FrameMetadata{*this};
}
 
} // namespace optris