Holds the configuration of an alarm channel. More...

#include <AlarmChannelConfig.h>

Collaboration diagram for optris::AlarmChannelConfig:

Static Public Member Functions
static OTC_SDK_API AlarmChannelConfig	createInternalTemperature (const std::string &name, float minTemperature, float maxTemperature) noexcept
	Creates a configuration for an alarm channel monitoring the internal temperature.

static OTC_SDK_API AlarmChannelConfig	createChipTemperature (const std::string &name, float minTemperature, float maxTemperature) noexcept
	Creates a configuration for an alarm channel monitoring the sensor chip temperature.

static OTC_SDK_API AlarmChannelConfig	createMeasurementField (const std::string &name, const MeasurementField::ConstShared &field, FieldStat fieldStat, float minTemperature, float maxTemperature) noexcept
	Creates a configuration for an alarm channel monitoring a measurement field temperature.

static OTC_SDK_API AlarmChannelConfig	createUncommittedValue (const std::string &name, int pifDeviceIndex, int pifPinIndex, float minValue, float maxValue) noexcept
	Creates a configuration for an alarm channel monitoring an uncommitted value provided by a PIF analog input channel.

static OTC_SDK_API void	validate (AlarmChannelConfig &config)
	Validates the configuration of an alarm channel.

Public Attributes
std::string	name
	Name of the alarm channel.

AlarmInput	input = AlarmInput::InternalTemperature
	Specifies the input that is observed by the alarm channel.

int	fieldIndex = 0
	Identifies the measurement field by its index that should be used as input.

FieldStat	fieldStat = FieldStat::Mean
	Identifies the statistic of the measurement field that should be used as input.

PifIndex	uncommittedValuePifIndex = {0, 0}
	Identifies the PIF analog input channel that provides the uncommitted value that should be used as input.

bool	enabled = true
	Indicates whether the entire alarm channel is enabled or disabled.

bool	preAlarmEnabled = false
	Specifies whether the pre-alarm should be checked.

RangeF	preAlarmRange = {20.F, 40.F}
	A pre-alarm will be active, if the input is not in [preAlarmRange.min, preAlarmRange.max].

RangeF	alarmRange = {25.F, 40.F}
	The alarm will be active, if the input is not in [alarmRange.min, alarmRange.max].

bool	partOfComposite = false
	Indicates whether the alarm channel is part of the composite alarm.

std::vector< PifIndex >	pifAoIndices
	Identifies the PIF analog output channels to which the alarm status should be sent.

std::vector< PifIndex >	pifDoIndices
	Identifies the PIF digital output channels to which the alarm status should be sent.

Detailed Description

Holds the configuration of an alarm channel.

Member Function Documentation

◆ createChipTemperature()

static OTC_SDK_API AlarmChannelConfig optris::AlarmChannelConfig::createChipTemperature	(	const std::string &	name,
		float	minTemperature,
		float	maxTemperature )

staticnoexcept

Creates a configuration for an alarm channel monitoring the sensor chip temperature.

The alarm will be active if the sensor chip temperature is not in [minTemperature, maxTemperature].

Specify the pre-, composite alarm and PIF output settings manually after creating the configuration.

Parameters

[in]	name	of the alarm channel.
[in]	minTemperature	minimum temperature in degree Celsius.
[in]	maxTemperature	maximum temperature in degree Celsius.

Returns: alarm channel configuration.

◆ createInternalTemperature()

static OTC_SDK_API AlarmChannelConfig optris::AlarmChannelConfig::createInternalTemperature	(	const std::string &	name,
		float	minTemperature,
		float	maxTemperature )

staticnoexcept

Creates a configuration for an alarm channel monitoring the internal temperature.

The alarm will be active if the internal temperature is not in [minTemperature, maxTemperature].

Specify the pre-, composite alarm and PIF output settings manually after creating the configuration.

Parameters

[in]	name	of the alarm channel.
[in]	minTemperature	minimum temperature in degree Celsius.
[in]	maxTemperature	maximum temperature in degree Celsius.

Returns: alarm channel configuration.

◆ createMeasurementField()

static OTC_SDK_API AlarmChannelConfig optris::AlarmChannelConfig::createMeasurementField	(	const std::string &	name,
		const MeasurementField::ConstShared &	field,
		FieldStat	fieldStat,
		float	minTemperature,
		float	maxTemperature )

staticnoexcept

Creates a configuration for an alarm channel monitoring a measurement field temperature.

The alarm will be active if the measurement field temperature is not in [minTemperature, maxTemperature].

Specify the pre-, composite alarm and PIF output settings manually after creating the configuration.

Parameters

[in]	name	of the alarm channel.
[in]	field	measurement field to monitor. If nullptr is passed, the field index will be set to 0.
[in]	fieldStat	field statistic to monitor.
[in]	minTemperature	minimum temperature in degree Celsius.
[in]	maxTemperature	maximum temperature in degree Celsius.

Returns: alarm channel configuration.

◆ createUncommittedValue()

static OTC_SDK_API AlarmChannelConfig optris::AlarmChannelConfig::createUncommittedValue	(	const std::string &	name,
		int	pifDeviceIndex,
		int	pifPinIndex,
		float	minValue,
		float	maxValue )

staticnoexcept

Creates a configuration for an alarm channel monitoring an uncommitted value provided by a PIF analog input channel.

The alarm will be active if the uncommitted value is in [minValue, maxValue].

Specify the pre-, composite alarm and PIF output settings manually after creating the configuration.

Parameters

[in]	name	of the alarm channel.
[in]	pifDeviceIndex	index of the PIF device identifying the PIF channel.
[in]	pifPinIndex	index of the PIF pin identifying the PIF channel.
[in]	minValue	minimum alarm value.
[in]	maxValue	maximum alarm value.

Returns: alarm channel configuration.

◆ validate()

static OTC_SDK_API void optris::AlarmChannelConfig::validate ( AlarmChannelConfig & config )

static

Validates the configuration of an alarm channel.

Parameters

[in,out] config alarm channel configuration to validate.

Exceptions

SDKException if the configuration is invalid.

Member Data Documentation

◆ alarmRange

RangeF optris::AlarmChannelConfig::alarmRange = {25.F, 40.F}

The alarm will be active, if the input is not in [alarmRange.min, alarmRange.max].

An active alarm overrides a pre-alarm.

Depending on the chosen input the unit of the alarm range limits will differ:

Internal, chip, and measurement field temperature alarms: degree Celsius.
Uncommitted value alarms: unit depends on the specific PIF channel configuration.

◆ partOfComposite

bool optris::AlarmChannelConfig::partOfComposite = false

Indicates whether the alarm channel is part of the composite alarm.

The composite alarm is triggered when at least one of the alarms in the composite is active.

◆ pifAoIndices

std::vector<PifIndex> optris::AlarmChannelConfig::pifAoIndices

Identifies the PIF analog output channels to which the alarm status should be sent.

This will only have an effect if the specified PIF channel is set to PifAoMode::Alarm.

◆ pifDoIndices

std::vector<PifIndex> optris::AlarmChannelConfig::pifDoIndices

Identifies the PIF digital output channels to which the alarm status should be sent.

This will only have an effect if the specified PIF channel is set to PifDoMode::Alarm.

◆ preAlarmRange

RangeF optris::AlarmChannelConfig::preAlarmRange = {20.F, 40.F}

A pre-alarm will be active, if the input is not in [preAlarmRange.min, preAlarmRange.max].

Depending on the chosen input the unit of the pre-alarm range limits will differ:

Internal, chip, and measurement field temperature pre-alarms: degree Celsius.
Uncommitted value pre-alarms: unit depends on the specific PIF channel configuration.

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

AlarmChannelConfig.h

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ createChipTemperature()

◆ createInternalTemperature()

◆ createMeasurementField()

◆ createUncommittedValue()

◆ validate()

Member Data Documentation

◆ alarmRange

◆ partOfComposite

◆ pifAoIndices

◆ pifDoIndices

◆ preAlarmRange