PifChannelConfigs.h

Go to the documentation of this file.

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

 
#pragma once
 
#include <ostream>
#include <string>
 
#include "otcsdk/Api.h"
#include "otcsdk/common/Slope.h"
#include "otcsdk/pif/PifProperties.h"
#include "otcsdk/fields/FieldProperties.h"
#include "otcsdk/fields/MeasurementField.h"
 
 
namespace optris
{

struct PifAiConfig
{
  PifIndex index = {0, 0};
  

  PifAiMode mode = PifAiMode::Off;

  Slope slope = {1.F, 0.F};

  float triggerThreshold = 0.F;
  bool  triggerLowActive = true;

  std::string uncommittedValueName;
  std::string uncommittedValueUnit;
 

  OTC_SDK_API static PifAiConfig createOff(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifAiConfig createAmbientTemperature(int deviceIndex, int pinIndex, float gain, float offset) noexcept;

  OTC_SDK_API static PifAiConfig createEmissivity(int deviceIndex, int pinIndex, float gain, float offset) noexcept;

  OTC_SDK_API static PifAiConfig createFlagControl(int deviceIndex, int pinIndex, float threshold, bool openIfLow) noexcept;

  OTC_SDK_API static PifAiConfig createUncommittedValue(int deviceIndex, int pinIndex, const std::string& name, const std::string& unit, float gain, float offset) noexcept;
};
 

struct PifDiConfig
{
  PifIndex index = {0, 0};
 

  PifDiMode mode = PifDiMode::Off;

  bool triggerLowActive = true;
 

  OTC_SDK_API static PifDiConfig createOff(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifDiConfig createFlagControl(int deviceIndex, int pinIndex, bool openIfLow) noexcept;
};
 

struct PifAoConfig
{
  PifIndex index = {0, 0};
 

  PifAoMode mode = PifAoMode::Off;
  PifAoOutputMode outputMode = PifAoOutputMode::_0_10V;

  Slope slope = {1.F, 0.F};

  int fieldIndex = 0;
  FieldStat fieldStat = FieldStat::Mean;

  float outputActive = 10.0F;
  float outputIntermediate = 10.0F;
  float outputInactive = 0.0F;
 

  OTC_SDK_API static PifAoConfig createOff(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifAoConfig createAlarm(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float active, float clear) noexcept;

  OTC_SDK_API static PifAoConfig createExternalCommunication(int deviceIndex, int pinIndex, PifAoOutputMode outputMode) noexcept;

  OTC_SDK_API static PifAoConfig createFlagStatus(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float open, float moving, float closed) noexcept;

  OTC_SDK_API static PifAoConfig createFrameSync(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float pulse) noexcept;

  OTC_SDK_API static PifAoConfig createInternalTemperature(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float gain, float offset) noexcept;

  OTC_SDK_API static PifAoConfig createMeasurementField(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, const MeasurementField::ConstShared& field, FieldStat fieldStat, float gain, float offset) noexcept;

  OTC_SDK_API static PifAoConfig createFailSafe(int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float pulse) noexcept;
};
 

struct PifDoConfig
{
  PifIndex index = {0, 0};
 

  PifDoMode mode = PifDoMode::Off;

  bool outputLowActive = true;
 

  OTC_SDK_API static PifDoConfig createOff(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifDoConfig createAlarm(int deviceIndex, int pinIndex, bool lowIfActive) noexcept;

  OTC_SDK_API static PifDoConfig createFlagStatus(int deviceIndex, int pinIndex, bool lowIfOpen) noexcept;

  OTC_SDK_API static PifDoConfig createFrameSync(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifDoConfig createExternalCommunication(int deviceIndex, int pinIndex) noexcept;

  OTC_SDK_API static PifDoConfig createFailSafe(int deviceIndex, int pinIndex) noexcept;
};
 

struct PifFsConfig
{
  PifFsMode mode = PifFsMode::Off;
 

  OTC_SDK_API static PifFsConfig createOff() noexcept;

  OTC_SDK_API static PifFsConfig createOn() noexcept;
};
 
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const PifAiConfig& config) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, const PifDiConfig& config) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, const PifAoConfig& config) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, const PifDoConfig& config) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, const PifFsConfig& config) noexcept;
 
} // namespace optris