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

#include <PifChannelConfigs.h>

Collaboration diagram for optris::PifAoConfig:

Static Public Member Functions
static OTC_SDK_API PifAoConfig	createOff (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifAoMode::Off.

static OTC_SDK_API PifAoConfig	createAlarm (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float active, float clear) noexcept
	Creates a configuration for the mode PifAoMode::Alarm.

static OTC_SDK_API PifAoConfig	createExternalCommunication (int deviceIndex, int pinIndex, PifAoOutputMode outputMode) noexcept
	Creates a configuration for the mode PifAoMode::ExternalCommunication.

static OTC_SDK_API PifAoConfig	createFlagStatus (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float open, float moving, float closed) noexcept
	Creates a configuration for the mode PifAoMode::FlagStatus.

static OTC_SDK_API PifAoConfig	createFrameSync (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float pulse) noexcept
	Creates a configuration for the mode PifAoMode::FrameSync.

static OTC_SDK_API PifAoConfig	createInternalTemperature (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float gain, float offset) noexcept
	Creates a configuration for the mode PifAoMode::InternalTemperature.

static OTC_SDK_API PifAoConfig	createMeasurementField (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, const MeasurementField::ConstShared &field, FieldStat fieldStat, float gain, float offset) noexcept
	Creates a configuration for the mode PifAoMode::MeasurementField.

static OTC_SDK_API PifAoConfig	createFailSafe (int deviceIndex, int pinIndex, PifAoOutputMode outputMode, float pulse) noexcept
	Creates a configuration for the mode PifAoMode::FailSafe.

Public Attributes
PifIndex	index = {0, 0}
	Identifies the channel by the indices of its pin and the PIF device on which it is located.

PifAoMode	mode = PifAoMode::Off
	Mode to be applied to the channel.

PifAoOutputMode	outputMode = PifAoOutputMode::_0_10V
	Output mode to be applied to the channel.

Slope	slope = {1.F, 0.F}
	Defines how data points are converted into output values.

int	fieldIndex = 0
	Identifies the measurement field by its index.

FieldStat	fieldStat = FieldStat::Mean
	Determines which field statistic should be output.

float	outputActive = 10.0F
	Output value for an active event/state.

float	outputIntermediate = 10.0F
	Output value for an intermediate event/state.

float	outputInactive = 0.0F
	Output value for an inactive event/state.

Detailed Description

Encapsulates the configuration for a PIF analog output channel.

For a detailed overview of all available modes and parameters please refer to the corresponding section in the documentation of the configuration file.

Member Function Documentation

◆ createAlarm()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createAlarm	(	int	deviceIndex,
		int	pinIndex,
		PifAoOutputMode	outputMode,
		float	active,
		float	clear
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::Alarm.

The values for active and clear are automatically clipped to the specified output mode limits.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	active	value to output if the alarm is active.
[in]	clear	value to output if the alarm is clear.

Returns: configuration for the mode PifAoMode::Alarm.

◆ createExternalCommunication()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createExternalCommunication	(	int	deviceIndex,
		int	pinIndex,
		PifAoOutputMode	outputMode
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::ExternalCommunication.

When set to external communication the output value of the channel can be set with ProcessInterface::setAoValue().

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.

Returns: configuration for the mode PifAoMode::ExternalCommunication.

◆ createFailSafe()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createFailSafe	(	int	deviceIndex,
		int	pinIndex,
		PifAoOutputMode	outputMode,
		float	pulse
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::FailSafe.

Refer to the Fail Safe chapter for more details.

The value for pulse will automatically be clipped to the specified output mode limits.

Attention: This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	pulse	height of the output heart beat signal.

Returns: configuration for the mode PifAoMode::FailSafe.

◆ createFlagStatus()

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

staticnoexcept

Creates a configuration for the mode PifAoMode::FlagStatus.

The values for open, moving and closed are automatically clipped to the specified output mode limits.

Attention: This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	open	value to output if the shutter flag is open.
[in]	moving	value to output if the shutter flag is moving.
[in]	closed	value to output if the shutter flag is closed.

Returns: configuration for the mode PifAoMode::FlagStatus.

◆ createFrameSync()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createFrameSync	(	int	deviceIndex,
		int	pinIndex,
		PifAoOutputMode	outputMode,
		float	pulse
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::FrameSync.

The value for pulse will automatically be clipped to the specified output mode limits.

Attention: This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	pulse	height of the generated pulse indicating an newly captured frame.

Returns: configuration for the mode PifAoMode::FrameSync.

◆ createInternalTemperature()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createInternalTemperature	(	int	deviceIndex,
		int	pinIndex,
		PifAoOutputMode	outputMode,
		float	gain,
		float	offset
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::InternalTemperature.

The internal temperature t_internal is converted into an output value X_out as follows:

X_out = gain * t_internal + offset

Attention: This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	gain	for converting the internal temperature into an output value.
[in]	offset	for converting the internal temperature into an output value.

Returns: configuration for the mode PifAoMode::InternalTemperature.

◆ createMeasurementField()

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

staticnoexcept

Creates a configuration for the mode PifAoMode::MeasurementField.

The data point of the measurement field that will be output is given by the value of the MeasurementFieldConfig::mode and can be accessed through MeasurementField::getDataPoint(). Its value x_field is converted into an output value X_out as follows:

X_out = gain * x_field + offset

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	outputMode	to apply.
[in]	field	shared pointer to the measurement field. If nullptr is passed, the field index will be set to 0.
[in]	fieldStat	determining which field statistic should be output.
[in]	gain	for converting the measurement field data point into an output value.
[in]	offset	for converting the measurement field data point into an output value.

Returns: configuration for the mode PifAoMode::MeasurementField.

◆ createOff()

static OTC_SDK_API PifAoConfig optris::PifAoConfig::createOff	(	int	deviceIndex,
		int	pinIndex
	)

staticnoexcept

Creates a configuration for the mode PifAoMode::Off.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.

Returns: configuration for the mode PifAoMode::Off.

The documentation for this struct was generated from the following file:

PifChannelConfigs.h

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ createAlarm()

◆ createExternalCommunication()

◆ createFailSafe()

◆ createFlagStatus()

◆ createFrameSync()

◆ createInternalTemperature()

◆ createMeasurementField()

◆ createOff()