PifProperties.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/Exceptions.h"
 
 
namespace optris
{
 
// Device
enum class PifDeviceType
{
  Automatic,         
  None,              
  Standard,          
  IndustrialMV,      
  IndustrialMA,      
  Internal,          
  Stackable,         
  TemperatureProbe,  
  Proprietary,       
};
 
 
// Modes
enum class PifAiMode
{
  Off,                 
  FlagControl,         
  Emissivity,          
  AmbientTemperature,  
  UncommittedValue,    
};

enum class PifDiMode
{
  Off,          
  FlagControl,  
};

enum class PifAoMode
{
  Off,                    
  FlagStatus,             
  FrameSync,              
  FailSafe,               
  ExternalCommunication,  
  MeasurementField,       
  InternalTemperature,    
  Alarm,                  
};

enum class PifDoMode
{
  Off,                    
  FlagStatus,             
  FrameSync,              
  FailSafe,               
  ExternalCommunication,  
  Alarm,                  
};

enum class PifFsMode
{
  Off,  
  On,   
};

enum class PifAoOutputMode
{
  _0_20mA,  
  _4_20mA,  
  _0_10V,   
};

struct PifIndex
{
  int device = 0;
  int pin    = 0;
 

  OTC_SDK_API static void validate(const PifIndex& index);
};
 
 
// Utility functions
OTC_SDK_API float lowerLimit(PifAoOutputMode outputMode) noexcept;

OTC_SDK_API float upperLimit(PifAoOutputMode outputMode) noexcept;

OTC_SDK_API float clampValue(float value, PifAoOutputMode outputMode) noexcept;

inline bool operator==(const PifIndex& lhs, const PifIndex& rhs) noexcept
{
  return lhs.device == rhs.device && lhs.pin == rhs.pin;
}

inline bool operator!=(const PifIndex& lhs, const PifIndex& rhs) noexcept
{
  return lhs.device != rhs.device || lhs.pin != rhs.pin;
}

OTC_SDK_API std::string toString(const PifIndex& index) noexcept;

OTC_SDK_API std::string toString(PifDeviceType type) noexcept;

OTC_SDK_API std::string toString(PifAiMode analogInputMode) noexcept;

OTC_SDK_API std::string toString(PifDiMode digitalInputMode) noexcept;

OTC_SDK_API std::string toString(PifAoMode analogOutputMode) noexcept;

OTC_SDK_API std::string toString(PifDoMode digitalOutputMode) noexcept;

OTC_SDK_API std::string toString(PifFsMode failSafeMode) noexcept;

OTC_SDK_API std::string toString(PifAoOutputMode outputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDeviceType deviceType) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAiMode analogInputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDiMode digitalInputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAoMode analogOutputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifDoMode digitalOutputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifFsMode failSafeMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifAoOutputMode outputMode) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, PifIndex index) noexcept;
 
} // namespace optris