PifProperties.h File Reference

Contains enums defining various properties of process interfaces. More...

#include <ostream>
#include <string>
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	optris::PifIndex
	Holds the indices that identify the physical pin on a PIF device for a PIF channel. More...

Namespaces
namespace	optris
	Main SDK namespace.

Enumerations
enum class	optris::PifDeviceType {   optris::Automatic , optris::None , optris::Standard , optris::IndustrialMV ,   optris::IndustrialMA , optris::Internal , optris::Stackable , optris::TemperatureProbe ,   optris::Proprietary }
	Represents the supported PIF device types. More...
enum class	optris::PifAiMode {   optris::Off , optris::FlagControl , optris::Emissivity , optris::AmbientTemperature ,   optris::UncommittedValue }
	Represents the available modes for PIF analog input channels. More...
enum class	optris::PifDiMode { optris::Off , optris::FlagControl }
	Represents the available modes for PIF digital input channels. More...
enum class	optris::PifAoMode {   optris::Off , optris::FlagStatus , optris::FrameSync , optris::FailSafe ,   optris::ExternalCommunication , optris::MeasurementField , optris::InternalTemperature , optris::Alarm }
	Represents the available modes for PIF analog output channels. More...
enum class	optris::PifDoMode {   optris::Off , optris::FlagStatus , optris::FrameSync , optris::FailSafe ,   optris::ExternalCommunication , optris::Alarm }
	Represents the available modes for PIF digital output channels. More...
enum class	optris::PifFsMode { optris::Off , optris::On }
	Represents the available modes for PIF fail safe channels. More...
enum class	optris::PifAoOutputMode { optris::_0_20mA , optris::_4_20mA , optris::_0_10V }
	Represents the available output modes for PIF analog output channels. More...

Functions
OTC_SDK_API float	optris::lowerLimit (PifAoOutputMode outputMode) noexcept
	Returns the lower limit of the specified PIF analog output mode as a number value.
OTC_SDK_API float	optris::upperLimit (PifAoOutputMode outputMode) noexcept
	Returns the upper limit of the specified PIF analog output mode as a number value.
OTC_SDK_API float	optris::clampValue (float value, PifAoOutputMode outputMode) noexcept
	Clamps the given value to the limits of the specified PIF analog output mode.
bool	optris::operator== (const PifIndex &lhs, const PifIndex &rhs) noexcept
	Equality operator for PIF indices.
bool	optris::operator!= (const PifIndex &lhs, const PifIndex &rhs) noexcept
	Inequality operator for PIF indices.
OTC_SDK_API std::string	optris::toString (const PifIndex &index) noexcept
	Returns a string representation of the given PIF index.
OTC_SDK_API std::string	optris::toString (PifDeviceType type) noexcept
	Returns a string representation of the given PIF device type.
OTC_SDK_API std::string	optris::toString (PifAiMode analogInputMode) noexcept
	Returns a string representation of the given PIF analog input mode.
OTC_SDK_API std::string	optris::toString (PifDiMode digitalInputMode) noexcept
	Returns a string representation of the given PIF digital input mode.
OTC_SDK_API std::string	optris::toString (PifAoMode analogOutputMode) noexcept
	Returns a string representation of the given PIF analog output mode.
OTC_SDK_API std::string	optris::toString (PifDoMode digitalOutputMode) noexcept
	Returns a string representation of the given PIF digital output mode.
OTC_SDK_API std::string	optris::toString (PifFsMode failSafeMode) noexcept
	Returns a string representation of the given PIF fail safe mode.
OTC_SDK_API std::string	optris::toString (PifAoOutputMode outputMode) noexcept
	Returns a string representation of the given PIF analog output mode.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifDeviceType deviceType) noexcept
	Output stream operator for PIF device types.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifAiMode analogInputMode) noexcept
	Output stream operator for PIF analog input modes.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifDiMode digitalInputMode) noexcept
	Output stream operator for PIF digital input modes.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifAoMode analogOutputMode) noexcept
	Output stream operator for PIF analog output modes.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifDoMode digitalOutputMode) noexcept
	Output stream operator for PIF digital output modes.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifFsMode failSafeMode) noexcept
	Output stream operator for PIF fail safe modes.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifAoOutputMode outputMode) noexcept
	Output stream operator for PIF analog output mode.
OTC_SDK_API std::ostream &	optris::operator<< (std::ostream &out, PifIndex index) noexcept
	Output stream operator for PIF indices.

Detailed Description

Contains enums defining various properties of process interfaces.

Author

Optris GmbH & Co. KG

Date

2025-06-13