PifChannelConfigs.h

Go to the documentation of this file.

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

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

class PifAiConfig
{
public:
  OTC_SDK_API PifAiConfig() noexcept;
 

  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;
 

  int deviceIndex;
  int pinIndex;

  PifAiMode mode;

  Slope slope;

  float triggerThreshold;
  bool  triggerLowActive;

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

class PifDiConfig
{
public:
  OTC_SDK_API PifDiConfig() noexcept;
 

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

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

  int deviceIndex;
  int pinIndex;
 

  PifDiMode mode;

  bool triggerLowActive;
};
 

class PifAoConfig
{
public:
  OTC_SDK_API PifAoConfig() noexcept;
 

  OTC_SDK_API static PifAoConfig createOff(int deviceIndex, int pinIndex) 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, int fieldIndex, float gain, float offset) noexcept;

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

  int deviceIndex;
  int pinIndex;
 

  PifAoMode  mode;
  PifAoOutputMode outputMode;

  Slope slope;

  int fieldIndex;

  float outputActive;
  float outputIntermediate;
  float outputInactive;
};
 

class PifDoConfig
{
public:
  OTC_SDK_API PifDoConfig() noexcept;
 

  OTC_SDK_API static PifDoConfig createOff(int deviceIndex, int pinIndex) 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;
 

  int deviceIndex;
  int pinIndex;
 

  PifDoMode mode;

  bool outputLowActive;
};
 

class PifFsConfig
{
public:
  OTC_SDK_API PifFsConfig() noexcept;
 

  OTC_SDK_API static PifFsConfig createOff() noexcept;

  OTC_SDK_API static PifFsConfig createOn() noexcept;
 

  PifFsMode mode;
};
 
 
// 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