optris::PifAoConfig Class Reference

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

#include <PifChannelConfigs.h>

Collaboration diagram for optris::PifAoConfig:

Public Member Functions
OTC_SDK_API	PifAoConfig () noexcept
	Constructor.

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	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, int fieldIndex, 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
int	deviceIndex
	Identifies the channel by specifying the PIF device on which its pins are located.
int	pinIndex
	Identifies the channel by locating its pins on the specified PIF device.
PifAoMode	mode
	Mode to be applied to the channel.
PifAoOutputMode	outputMode
	Output mode to be applied to the channel.
Slope	slope
	Defines how data points are converted into output values.
int	fieldIndex
	Identifies the measurement field by its index.
float	outputActive
	Output value for an active event/state.
float	outputIntermediate
	Output value for an intermediate event/state.
float	outputInactive
	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

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, int fieldIndex, 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]	fieldIndex	identifying the measurement field. It start at 0 and increments with every measurement field that is added. The method IRImager::addMeasurementField() will return the index of the added field.
[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 class was generated from the following file:

• PifChannelConfigs.h