Main SDK namespace. More...

Classes
class	ConstFrameIterator
	Iterates over the frame in a row major fashion and grants read access. More...

class	ConstImageIterator
	Iterates in a row major fashion over the image and grants read access to the pixels. More...

class	ConstMeasurementFieldIterator
	Iterates over a measurement field in a row major fashion and grants read access. More...

class	DeviceInfo
	Holds important information about a device. More...

class	DeviceNetworkConfig
	Encapsulates the on device network configuration. More...

class	EnumerationClient
	Defines the interface for classes that want to be updated about the detection of available devices. More...

class	EnumerationDetector
	Common interface for classes detecting available devices. More...

class	EnumerationManager
	Detects and monitors available devices. More...

class	Frame
	Represents a data frame received from a device. More...

class	FrameMetadata
	Encapsulates the metadata of frames provided by the devices. More...

class	FramerateCounter
	Measures frame rates. More...

class	Image
	Encapsulates false color images with 8-bit color depth. More...

class	ImageBuilder
	Creates false color images from thermal frames. More...

class	ImageInfo
	Encapsulates all relevant information about a false color image. More...

class	ImageIterator
	Iterates in a row major fashion over the image and grants read and write access to the pixels. More...

class	IpAddress
	Encapsulates an IP v4 address. More...

class	IRImager
	Interface defining the API for interacting with Optris thermal cameras. More...

class	IRImagerClient
	Base class for clients observing an IRImager. More...

class	IRImagerConfig
	Holds the SDK settings found in the configuration file. More...

class	IRImagerConfigReader
	Reads SDK configuration XML files. More...

class	IRImagerCreator
	Defines the interface for classes that instantiate IRImager implementations. More...

class	IRImagerFactory
	Factory instantiating IRImager implementations. More...

class	MacAddress
	Encapsulates a media access control address (MAC address). More...

class	MeasurementField
	Rectangular measurement field with individual radiation parameters. More...

class	MeasurementFieldConfig
	Encapsulates the configuration of a measurement field. More...

class	OperationMode
	Defines the interface for classes realizing operation modes. More...

class	PifAiConfig
	Encapsulates the configuration for a PIF analog input channel. More...

class	PifAoConfig
	Encapsulates the configuration for a PIF analog output channel. More...

class	PifConfig
	Holds the configuration of the processing interface. More...

class	PifDiConfig
	Encapsulates the configuration for a PIF digital input channel. More...

class	PifDoConfig
	Encapsulates the configuration for a PIF digital output channel. More...

class	PifFsConfig
	Encapsulates the configuration for a PIF fail safe channel. More...

class	Pixel
	Represents a pixel with three color channels and 8 bits of color depth. More...

class	Port
	Encapsulates a network port number. More...

class	ProcessInterface
	Interface defining the API for interacting with process interfaces (PIFs). More...

class	RadiationParameters
	Holds the radiation parameters for a frame or a measurement field. More...

class	Sdk
	Static class granting access to SDK wide configuration and utility functions. More...

class	SDKException
	Exception raised by the SDK. More...

class	Slope
	Encapsulates the parameters of a linear transformation. More...

struct	SnapshotEvent
	Encapsulates data about a snapshot event. More...

class	TemperatureConverter
	Converts temperatures in °C to and from their internal SDK representation. More...

struct	TemperatureRegion
	Characterizes a rectangular region by the indexes of the upper left and the lower right corners along with an associated temperature. More...

class	ThermalFrame
	Encapsulates thermal frame data received from a device. More...

class	VersionInfo
	Encapsulates version and build information about the SDK. More...

Enumerations
enum class	DeviceType { Unknown , PI1 , PI160 , PI2x0 , PI160orPI2x0 , PI4x0 , PI4x0I , PI640 , PI640I , PI1M , Xi80 , Xi160 , Xi320 , Xi320MT , Xi400 , Xi410 , Xi410MT , Xi440 , Xi640 , Xi1M }
	Represents the different types of Optris thermal cameras.

enum class	FlagState { Open , Closed , Opening , Closing , Error , Initializing }
	Represents the different states of the shutter flag. More...

enum class	ColorFormat { RGB , BGR }
	Represents the different available color formats. More...

enum class	WidthAlignment { OneByte = 1 , TwoBytes = 2 , FourBytes = 4 , EightBytes = 8 }
	Represents the different available width alignments. More...

enum class	RadiationParameterSource { Sdk , Pif }
	Represents the different sources of radiation parameters. More...

enum class	SnapshotTrigger { DigitalInput , AnalogInput , Software }
	Represents the different triggers of an event. More...

enum class	SnapshotType { Snapshot , SnapshotOnEdge }
	Represents the different event types. More...

enum class	TemperaturePrecision { Unknown = 0 , Standard = 1 , High = 2 }
	Represents the available temperature precisions. More...

enum class	FieldShape { Rectangle }
	Represents the different available shapes of fields. More...

enum class	FieldMode { Minimum , Maximum , Mean }
	Represents the different field modes that define what data point is calculated. More...

enum class	ColoringPalette { AlarmBlue , AlarmBlueHi , GrayBW , GrayWB , AlarmGreen , Iron , IronHi , Medical , Rainbow , RainbowHi , AlarmRed }
	Represents the available coloring palettes. More...

enum class	PaletteScalingMethod { Manual , MinMax , Sigma1 , Sigma3 }
	Represents the false color conversion strategies. More...

enum class	PifDeviceType { Automatic , None , Standard , IndustrialMV , IndustrialMA , Internal , Stackable , TemperatureProbe , Proprietary }
	Represents the supported PIF device types. More...

enum class	PifAiMode { Off , FlagControl , Emissivity , AmbientTemperature , UncommittedValue }
	Represents the available modes for PIF analog input channels. More...

enum class	PifDiMode { Off , FlagControl }
	Represents the available modes for PIF digital input channels. More...

enum class	PifAoMode { Off , FlagStatus , FrameSync , FailSafe , ExternalCommunication , MeasurementField , InternalTemperature }
	Represents the available modes for PIF analog output channels. More...

enum class	PifDoMode { Off , FlagStatus , FrameSync , FailSafe , ExternalCommunication }
	Represents the available modes for PIF digital output channels. More...

enum class	PifFsMode { Off , On }
	Represents the available modes for PIF fail safe channels. More...

enum class	PifAoOutputMode { _0_20mA , _4_20mA , _0_10V }
	Represents the available output modes for PIF analog output channels. More...

enum class	Verbosity { Off = 1 , Error = 2 , Warning = 3 , Info = 4 , Debug = 5 }
	Represents the different logging verbosity levels. More...

enum class	CalibrationFileSource { Device , Filesystem , Internet , Empty }
	Represents the different sources from which the calibration files can be acquired. More...

Functions
OTC_SDK_API bool	isPI (DeviceType type) noexcept
	Returns whether the given device is PI.

OTC_SDK_API bool	isXI (DeviceType type) noexcept
	Returns whether the given device is a Xi.

OTC_SDK_API bool	is1MDevice (DeviceType type) noexcept
	Returns whether the given device is of the 1M variety.

OTC_SDK_API bool	isMTDevice (DeviceType type) noexcept
	Returns whether the given device is an MT device.

OTC_SDK_API bool	isDeviceAnsweringAllCommands (DeviceType type) noexcept
	Returns whether the given device will answer on all commands, also on commands with no answer needed (such as set commands).

OTC_SDK_API bool	isAutonomousDevice (DeviceType type) noexcept
	Returns whether the given device supports the autonomous mode.

OTC_SDK_API bool	isEthernetDevice (DeviceType type) noexcept
	Returns whether the given device supports Ethernet.

OTC_SDK_API std::string	toString (DeviceType deviceType) noexcept
	Returns a string representation of the given device type.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, DeviceType deviceType) noexcept
	Output stream operator for device types.

OTC_SDK_API std::string	toString (FlagState flagState) noexcept
	Returns a string representation of the given flag state.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FlagState state) noexcept
	Ouput stream operator for flag states.

std::ostream &	operator<< (std::ostream &out, const Pixel &pixel) noexcept
	Output stream operator for pixels.

OTC_SDK_API std::string	toString (RadiationParameterSource source) noexcept
	Returns a string representation of the given radiation parameter source.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const RadiationParameters &radiation) noexcept
	Ouput stream operator for radiation parameters.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, RadiationParameterSource source) noexcept
	Ouput stream operator for radiation parameter sources.

std::ostream &	operator<< (std::ostream &out, const Slope &slope) noexcept
	Output stream operator for Slope.

OTC_SDK_API std::string	toString (TemperaturePrecision precision) noexcept
	Returns a string representation of the given temperature precision.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, TemperaturePrecision precision) noexcept
	Ouput stream operator for temperature precisions.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const IpAddress &address)
	Output stream operator for IP addresses.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const MacAddress &mac) noexcept
	Output stream operator for MAC addresses.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const Port &port) noexcept
	Output stream operator for port numbers.

OTC_SDK_API std::string	toString (FieldShape shape) noexcept
	Returns a string representation of the given field shape.

OTC_SDK_API std::string	toString (FieldMode fieldMode) noexcept
	Returns a string representation of the given field mode.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FieldShape shape) noexcept
	Ouput stream operator for field shapes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FieldMode fieldMode) noexcept
	Ouput stream operator for field mode.

std::ostream &	operator<< (std::ostream &out, const MeasurementFieldConfig &config) noexcept
	Ouput stream operator for measurement field configurations.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const IRImagerConfig &config)
	Output stream operator for the IRImagerConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifAiConfig &config) noexcept
	Output stream operator for PifAiConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifDiConfig &config) noexcept
	Output stream operator for PifDiConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifAoConfig &config) noexcept
	Output stream operator for PifAoConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifDoConfig &config) noexcept
	Output stream operator for PifDoConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifFsConfig &config) noexcept
	Output stream operator for PifFsConfig.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const PifConfig &config) noexcept
	Output stream operator for the PifConfig.

OTC_SDK_API float	lowerLimit (PifAoOutputMode outputMode) noexcept
	Returns the lower limit of the specified PIF analog output mode as a number value.

OTC_SDK_API float	upperLimit (PifAoOutputMode outputMode) noexcept
	Returns the upper limit of the specified PIF analog output mode as a number value.

OTC_SDK_API float	clampValue (float value, PifAoOutputMode outputMode) noexcept
	Clamps the given value to the limits of the specified PIF analog output mode.

OTC_SDK_API std::string	toString (PifDeviceType type) noexcept
	Returns a string representation of the given PIF device type.

OTC_SDK_API std::string	toString (PifAiMode analogInputMode) noexcept
	Returns a string representation of the given PIF analog input mode.

OTC_SDK_API std::string	toString (PifDiMode digitalInputMode) noexcept
	Returns a string representation of the given PIF digital input mode.

OTC_SDK_API std::string	toString (PifAoMode analogOutputMode) noexcept
	Returns a string representation of the given PIF analog output mode.

OTC_SDK_API std::string	toString (PifDoMode digitalOutputMode) noexcept
	Returns a string representation of the given PIF digital output mode.

OTC_SDK_API std::string	toString (PifFsMode failSafeMode) noexcept
	Returns a string representation of the given PIF fail safe mode.

OTC_SDK_API std::string	toString (PifAoOutputMode outputMode) noexcept
	Returns a string representation of the given PIF analog output mode.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifDeviceType deviceType) noexcept
	Output stream operator for PIF device types.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAiMode analogInputMode) noexcept
	Output stream operator for PIF analog input modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifDiMode digitalInputMode) noexcept
	Output stream operator for PIF digital input modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAoMode analogOutputMode) noexcept
	Output stream operator for PIF analog output modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifDoMode digitalOutputMode) noexcept
	Output stream operator for PIF digital output modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifFsMode failSafeMode) noexcept
	Output stream operator for PIF fail safe modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAoOutputMode outputMode) noexcept
	Output stream operator for PIF analog output mode.

Variables
static constexpr float	INVALID_TEMPERATURE = -100.F
	All temperatures in °C equal or lower are invalid.

static constexpr unsigned short	INVALID_VALUE = 0
	All internal temperature values equal to this are invalid.

Detailed Description

Main SDK namespace.

Enumeration Type Documentation

◆ CalibrationFileSource

enum class optris::CalibrationFileSource

strong

Represents the different sources from which the calibration files can be acquired.

Enumerator
Device	The calibration files are fetched from the on-board memory of the device. Not supported by all devices.
Filesystem	The calibration files are copied from a local filesystem directory.
Internet	The calibration files are downloaded from Optris servers. Requires internet access.
Empty	No calibration source wanted.

◆ ColorFormat

enum class optris::ColorFormat

strong

Represents the different available color formats.

The format defines the storage sequence of the pixel color values. Therefore, the color value of the first letter will come first in the image pixel value array.

Some systems refer to the significance of the color values as color format. Here the color value of the first letter is the most significant byte. On big-endian machines this byte comes first. On little-endian machines it will come last.

False color image with Iron color palette: Left correct color format, right wrong color format.

Enumerator
RGB	Pixel colors values are stored in the sequence: (red, green, blue).
BGR	Pixel colors values are stored in the sequence: (blue, green, red).

◆ ColoringPalette

enum class optris::ColoringPalette

strong

Represents the available coloring palettes.

Enumerator
AlarmBlue
AlarmBlueHi
GrayBW
GrayWB
AlarmGreen
Iron
IronHi
Medical
Rainbow
RainbowHi
AlarmRed

◆ FieldMode

enum class optris::FieldMode

strong

Represents the different field modes that define what data point is calculated.

Enumerator
Minimum	Minimum temperature in °C.
Maximum	Maximum temperature in °C.
Mean	Mean temperature in °C.

◆ FieldShape

enum class optris::FieldShape

strong

Represents the different available shapes of fields.

Enumerator
Rectangle	Rectangular field.

◆ FlagState

enum class optris::FlagState

strong

Represents the different states of the shutter flag.

A flag cycle is defined by the transition through the following states:

Open - Closing - Closed - Opening - Open

During the automated startup calibration after a successful device connection the flag state will be Initializing indicating the thermal frame data is not yet reliable.

Enumerator
Open	Flag is open.
Closed	Flag is closed.
Opening	Flag is opening.
Closing	Flag is closing.
Error	Flag is in an error state.
Initializing	Flag state is beeing initialized/calibrated.

◆ PaletteScalingMethod

enum class optris::PaletteScalingMethod

strong

Represents the false color conversion strategies.

Enumerator
Manual	User-defined upper and lower limit (fixed values).
MinMax	Dynamic determination of minimum and maximum temperature as upper and lower limit.
Sigma1	Dynamic determination of upper and lower limit from standard deviation of temperature image.
Sigma3	Same as Sigma1, but with factor 3.

◆ PifAiMode

enum class optris::PifAiMode

strong

Represents the available modes for PIF analog input channels.

Enumerator
Off	Off.
FlagControl	The shutter flag is controlled by the input voltage.
Emissivity	Emissivity for the thermal frame is derived from the input voltage.
AmbientTemperature	Ambient temperature for the thermal frame is derived from the input voltage.
UncommittedValue	The input voltage value is transformed and provided to IRImagerClients via a callback.

◆ PifAoMode

enum class optris::PifAoMode

strong

Represents the available modes for PIF analog output channels.

Enumerator
Off	Off.
FlagStatus	The status of the shutter flag is output.
FrameSync	Every time a new frame is capture a pulse is output.
FailSafe	A heart beat signal is provided that indicates whether the camera and SDK are working correctly.
ExternalCommunication	The output value can be controlled by clients of the SDK.
MeasurementField	The set data point of a measurement field is output.
InternalTemperature	The internal camera temperature is output.

◆ PifAoOutputMode

enum class optris::PifAoOutputMode

strong

Represents the available output modes for PIF analog output channels.

Enumerator
_0_20mA	0 mA - 20 mA
_4_20mA	4 mA - 20 mA
_0_10V	0 V - 10 V

◆ PifDeviceType

enum class optris::PifDeviceType

strong

Represents the supported PIF device types.

Enumerator
Automatic	Use the PIF type reported by the camera firmware.
None	No PIF.
Standard	Standard PIF.
IndustrialMV	Industrial PIF with voltage based analog outputs.
IndustrialMA	Industrial PIF with current based analog outputs.
Internal	Internal PIF.
Stackable	Stackable PIF.
TemperatureProbe	Instead of a PIF an external temperature probe is used.
Proprietary	The pins of the PIF connector on the camera are used directly.

◆ PifDiMode

enum class optris::PifDiMode

strong

Represents the available modes for PIF digital input channels.

Enumerator
Off	Off.
FlagControl	The flag is controlled by the input signal.

◆ PifDoMode

enum class optris::PifDoMode

strong

Represents the available modes for PIF digital output channels.

Enumerator
Off	Off.
FlagStatus	The status of the shutter flag is output.
FrameSync	Every time a new frame is capture a high pulse is output.
FailSafe	A heart beat signal is provided that indicates whether the camera and SDK are working correctly.
ExternalCommunication	The output value can be controlled by clients of the SDK.

◆ PifFsMode

enum class optris::PifFsMode

strong

Represents the available modes for PIF fail safe channels.

Enumerator
Off	Off.
On	On.

◆ RadiationParameterSource

enum class optris::RadiationParameterSource

strong

Represents the different sources of radiation parameters.

Enumerator
Sdk	The radiation parameter are/can be set via the SDK.
Pif	The radiation parameter is set by the processing interface (PIF).

◆ SnapshotTrigger

enum class optris::SnapshotTrigger

strong

Represents the different triggers of an event.

Enumerator
DigitalInput	Triggered by digital input.
AnalogInput	Triggered by analog input.
Software	Triggered by software.

◆ SnapshotType

enum class optris::SnapshotType

strong

Represents the different event types.

Enumerator
Snapshot	Event source is snapshot.
SnapshotOnEdge	Event source is snapshot on edge.

◆ TemperaturePrecision

enum class optris::TemperaturePrecision

strong

Represents the available temperature precisions.

Enumerator
Unknown	Unknown precision.
Standard	Standard precision.
High	High precision.

◆ Verbosity

enum class optris::Verbosity

strong

Represents the different logging verbosity levels.

Enumerator
Off	Off.
Error	Error.
Warning	Warning.
Info	Info.
Debug	Debug.

◆ WidthAlignment

enum class optris::WidthAlignment

strong

Represents the different available width alignments.

Depending on the chosen alignment additional bytes will be added to the end of each row in an image so that its size in bytes adheres to that alignment. This enables some frame works like OpenGL to read the image data in bigger chunks than one byte at a time which can result in significant performance benefits.

Example false color image with faulty width alignment.

Enumerator
OneByte	The row size is aligned to one byte.
TwoBytes	The row size is aligned to two bytes.
FourBytes	The row size is aligned to four bytes.
EightBytes	The row size is aligned to eight bytes.

Function Documentation

◆ clampValue()

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.

Parameters

[in]	value	to clamp.
[in]	outputMode	to which the provided value should be clamped.

Returns: the given value to the limits of the specified PIF analog output mode.

◆ is1MDevice()

OTC_SDK_API bool optris::is1MDevice ( DeviceType type )

noexcept

Returns whether the given device is of the 1M variety.

Parameters

[in] type imager device type to check.

Returns: true if the given device is of the 1M variety. False otherwise.

◆ isAutonomousDevice()

OTC_SDK_API bool optris::isAutonomousDevice ( DeviceType type )

noexcept

Returns whether the given device supports the autonomous mode.

Parameters

[in] type imager device type to check.

Returns: true if the given device supports the autonomous mode. False otherwise.

◆ isDeviceAnsweringAllCommands()

OTC_SDK_API bool optris::isDeviceAnsweringAllCommands ( DeviceType type )

noexcept

Returns whether the given device will answer on all commands, also on commands with no answer needed (such as set commands).

Parameters

[in] type imager device type to check.

Returns: true if the given device answers on all commands. False otherwise.

◆ isEthernetDevice()

OTC_SDK_API bool optris::isEthernetDevice ( DeviceType type )

noexcept

Returns whether the given device supports Ethernet.

Parameters

[in] type imager device type to check.

Returns: true if the given device supports Ethernet. False otherwise.

◆ isMTDevice()

OTC_SDK_API bool optris::isMTDevice ( DeviceType type )

noexcept

Returns whether the given device is an MT device.

Parameters

[in] type imager device type to check.

Returns: true if the given device is of the MT variety. False otherwise.

◆ isPI()

OTC_SDK_API bool optris::isPI ( DeviceType type )

noexcept

Returns whether the given device is PI.

Parameters

[in] type imager device type to check.

Returns: true if the given device is a PI. False otherwise.

◆ isXI()

OTC_SDK_API bool optris::isXI ( DeviceType type )

noexcept

Returns whether the given device is a Xi.

Parameters

[in] type imager device type to check.

Returns: true if the given device is a Xi. False otherwise.

◆ lowerLimit()

OTC_SDK_API float optris::lowerLimit ( PifAoOutputMode outputMode )

noexcept

Returns the lower limit of the specified PIF analog output mode as a number value.

Parameters

[in] outputMode for which the lower limit is desired.

Returns: lower limit of the specified PIF analog output mode as a number value.

◆ operator<<() [1/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const IpAddress &	address )

Output stream operator for IP addresses.

Parameters

[in]	out	stream to write the address to.
[in]	address	to output.

Returns: used output stream.

◆ operator<<() [2/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const IRImagerConfig &	config )

Output stream operator for the IRImagerConfig.

Parameters

[out]	out	stream to output to.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [3/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const MacAddress &	mac )

noexcept

Output stream operator for MAC addresses.

Parameters

[in]	out	stream to write the MAC address to.
[in]	mac	to output.

Returns: used output stream.

◆ operator<<() [4/27]

std::ostream & optris::operator<<	(	std::ostream &	out,
		const MeasurementFieldConfig &	config )

noexcept

Ouput stream operator for measurement field configurations.

Parameters

[in]	out	stream to ouput to.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [5/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const PifAiConfig &	config )

noexcept

Output stream operator for PifAiConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [6/27]

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

noexcept

Output stream operator for PifAoConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [7/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const PifConfig &	config )

noexcept

Output stream operator for the PifConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [8/27]

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

noexcept

Output stream operator for PifDiConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [9/27]

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

noexcept

Output stream operator for PifDoConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [10/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const PifFsConfig &	config )

noexcept

Output stream operator for PifFsConfig.

Parameters

[in]	out	stream to use.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [11/27]

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Pixel &	pixel )

inlinenoexcept

Output stream operator for pixels.

Parameters

[in]	out	stream to output to.
[in]	pixel	to output.

Returns: used output operator.

◆ operator<<() [12/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const Port &	port )

noexcept

Output stream operator for port numbers.

Parameters

[in]	out	stream to write the port number to.
[in]	port	to output.

Returns: used output stream.

◆ operator<<() [13/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const RadiationParameters &	radiation )

noexcept

Ouput stream operator for radiation parameters.

Parameters

[in]	out	stream to ouput to.
[in]	radiation	parameters to output.

Returns: used output stream.

◆ operator<<() [14/27]

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Slope &	slope )

inlinenoexcept

Output stream operator for Slope.

Parameters

[in]	out	stream to use.
[in]	slope	to output.

Returns: used output stream.

◆ operator<<() [15/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		DeviceType	deviceType )

noexcept

Output stream operator for device types.

Parameters

[in]	out	stream to use.
[in]	deviceType	to output.

Returns: used output stream.

◆ operator<<() [16/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FieldMode	fieldMode )

noexcept

Ouput stream operator for field mode.

Parameters

[in]	out	stream to ouput to.
[in]	fieldMode	to output.

Returns: used output stream.

◆ operator<<() [17/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FieldShape	shape )

noexcept

Ouput stream operator for field shapes.

Parameters

[in]	out	stream to ouput to.
[in]	shape	to output.

Returns: used output stream.

◆ operator<<() [18/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FlagState	state )

noexcept

Ouput stream operator for flag states.

Parameters

[in]	out	stream to ouput to.
[in]	state	to output.

Returns: used output stream.

◆ operator<<() [19/27]

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

noexcept

Output stream operator for PIF analog input modes.

Parameters

[in]	out	stream to use.
[in]	analogInputMode	to output.

Returns: used output stream.

◆ operator<<() [20/27]

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

noexcept

Output stream operator for PIF analog output modes.

Parameters

[in]	out	stream to use.
[in]	analogOutputMode	to output.

Returns: used output stream.

◆ operator<<() [21/27]

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

noexcept

Output stream operator for PIF analog output mode.

Parameters

[in]	out	stream to use.
[in]	outputMode	to output.

Returns: used output stream.

◆ operator<<() [22/27]

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

noexcept

Output stream operator for PIF device types.

Parameters

[in]	out	stream to use.
[in]	deviceType	to output.

Returns: used output stream.

◆ operator<<() [23/27]

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

noexcept

Output stream operator for PIF digital input modes.

Parameters

[in]	out	stream to use.
[in]	digitalInputMode	to output.

Returns: used output stream.

◆ operator<<() [24/27]

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

noexcept

Output stream operator for PIF digital output modes.

Parameters

[in]	out	stream to use.
[in]	digitalOutputMode	to output.

Returns: used output stream.

◆ operator<<() [25/27]

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

noexcept

Output stream operator for PIF fail safe modes.

Parameters

[in]	out	stream to use.
[in]	failSafeMode	to output.

Returns: used output stream.

◆ operator<<() [26/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		RadiationParameterSource	source )

noexcept

Ouput stream operator for radiation parameter sources.

Parameters

[in]	out	stream to ouput to.
[in]	source	to output.

Returns: used output stream.

◆ operator<<() [27/27]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		TemperaturePrecision	precision )

noexcept

Ouput stream operator for temperature precisions.

Parameters

[in]	out	stream to ouput to.
[in]	precision	to output.

Returns: used output stream.

◆ toString() [1/13]

OTC_SDK_API std::string optris::toString ( DeviceType deviceType )

noexcept

Returns a string representation of the given device type.

Note: Use deviceTypeToString() in Python instead.

Parameters

[in] deviceType for which a string representation is desired.

Returns: string respresentation of the given device type.

◆ toString() [2/13]

OTC_SDK_API std::string optris::toString ( FieldMode fieldMode )

noexcept

Returns a string representation of the given field mode.

Note: Use fieldModeToString() in Python instead.

Parameters

[in] fieldMode for which a string representation is desired.

Returns: string representation of the given field mode.

◆ toString() [3/13]

OTC_SDK_API std::string optris::toString ( FieldShape shape )

noexcept

Returns a string representation of the given field shape.

Note: Use fieldShapeToString() in Python instead.

Parameters

[in] shape for which a string representation is desired.

Returns: string representation of the given field shape.

◆ toString() [4/13]

OTC_SDK_API std::string optris::toString ( FlagState flagState )

noexcept

Returns a string representation of the given flag state.

Note: Use flagStateToString() in Python instead.

Parameters

[in] flagState for which a string representation is desired.

Returns: string representation of the given flag state.

◆ toString() [5/13]

OTC_SDK_API std::string optris::toString ( PifAiMode analogInputMode )

noexcept

Returns a string representation of the given PIF analog input mode.

Note: Use pifAiModeToString() in Python instead.

Parameters

[in] analogInputMode for which a string representation is desired.

Returns: string respresentation of the given PIF analog input mode.

◆ toString() [6/13]

OTC_SDK_API std::string optris::toString ( PifAoMode analogOutputMode )

noexcept

Returns a string representation of the given PIF analog output mode.

Note: Use pifAoModeToString() in Python instead.

Parameters

[in] analogOutputMode for which a string representation is desired.

Returns: string respresentation of the given PIF analog output mode.

◆ toString() [7/13]

OTC_SDK_API std::string optris::toString ( PifAoOutputMode outputMode )

noexcept

Returns a string representation of the given PIF analog output mode.

Note: Use pifAoOutputModeToString() in Python instead.

Parameters

[in] outputMode for which a string representation is desired.

Returns: string respresentation of the given PIF analog output mode.

◆ toString() [8/13]

OTC_SDK_API std::string optris::toString ( PifDeviceType type )

noexcept

Returns a string representation of the given PIF device type.

Note: Use pifDeviceTypeToString() in Python instead.

Parameters

[in] type for which a string representation is desired.

Returns: string respresentation of the given PIF device type.

◆ toString() [9/13]

OTC_SDK_API std::string optris::toString ( PifDiMode digitalInputMode )

noexcept

Returns a string representation of the given PIF digital input mode.

Note: Use pifDiModeToString() in Python instead.

Parameters

[in] digitalInputMode for which a string representation is desired.

Returns: string respresentation of the given PIF digital input mode.

◆ toString() [10/13]

OTC_SDK_API std::string optris::toString ( PifDoMode digitalOutputMode )

noexcept

Returns a string representation of the given PIF digital output mode.

Note: Use pifDoModeToString() in Python instead.

Parameters

[in] digitalOutputMode for which a string representation is desired.

Returns: string respresentation of the given PIF digital output mode.

◆ toString() [11/13]

OTC_SDK_API std::string optris::toString ( PifFsMode failSafeMode )

noexcept

Returns a string representation of the given PIF fail safe mode.

Note: Use pifFsModeToString() in Python instead.

Parameters

[in] failSafeMode for which a string representation is desired.

Returns: string respresentation of the given PIF fail safe mode.

◆ toString() [12/13]

OTC_SDK_API std::string optris::toString ( RadiationParameterSource source )

noexcept

Returns a string representation of the given radiation parameter source.

Note: Use radiationParameterSourceToString() in Python instead.

Parameters

[in] source for which a string representation is desired.

Returns: string representation of the given radiation parameter source.

◆ toString() [13/13]

OTC_SDK_API std::string optris::toString ( TemperaturePrecision precision )

noexcept

Returns a string representation of the given temperature precision.

Note: Use temperaturePrecisionToString() in Python instead.

Parameters

[in] precision for which a string representation is desired.

Returns: string respresentation of the given temperature precision.

◆ upperLimit()

OTC_SDK_API float optris::upperLimit ( PifAoOutputMode outputMode )

noexcept

Returns the upper limit of the specified PIF analog output mode as a number value.

Parameters

[in] outputMode for which the upper limit is desired.

Returns: upper limit of the specified PIF analog output mode as a number value.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ CalibrationFileSource

◆ ColorFormat

◆ ColoringPalette

◆ FieldMode

◆ FieldShape

◆ FlagState

◆ PaletteScalingMethod

◆ PifAiMode

◆ PifAoMode

◆ PifAoOutputMode

◆ PifDeviceType

◆ PifDiMode

◆ PifDoMode

◆ PifFsMode

◆ RadiationParameterSource

◆ SnapshotTrigger

◆ SnapshotType

◆ TemperaturePrecision

◆ Verbosity

◆ WidthAlignment

Function Documentation

◆ clampValue()

◆ is1MDevice()

◆ isAutonomousDevice()

◆ isDeviceAnsweringAllCommands()

◆ isEthernetDevice()

◆ isMTDevice()

◆ isPI()

◆ isXI()

◆ lowerLimit()

◆ operator<<() [1/27]

◆ operator<<() [2/27]

◆ operator<<() [3/27]

◆ operator<<() [4/27]

◆ operator<<() [5/27]

◆ operator<<() [6/27]

◆ operator<<() [7/27]

◆ operator<<() [8/27]

◆ operator<<() [9/27]

◆ operator<<() [10/27]

◆ operator<<() [11/27]

◆ operator<<() [12/27]

◆ operator<<() [13/27]

◆ operator<<() [14/27]

◆ operator<<() [15/27]

◆ operator<<() [16/27]

◆ operator<<() [17/27]

◆ operator<<() [18/27]

◆ operator<<() [19/27]

◆ operator<<() [20/27]

◆ operator<<() [21/27]

◆ operator<<() [22/27]

◆ operator<<() [23/27]

◆ operator<<() [24/27]

◆ operator<<() [25/27]

◆ operator<<() [26/27]

◆ operator<<() [27/27]

◆ toString() [1/13]

◆ toString() [2/13]

◆ toString() [3/13]

◆ toString() [4/13]

◆ toString() [5/13]

◆ toString() [6/13]

◆ toString() [7/13]

◆ toString() [8/13]

◆ toString() [9/13]

◆ toString() [10/13]

◆ toString() [11/13]

◆ toString() [12/13]

◆ toString() [13/13]

◆ upperLimit()