optris::PifDiConfig Struct Reference

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

#include <PifChannelConfigs.h>

Collaboration diagram for optris::PifDiConfig:

Static Public Member Functions
static OTC_SDK_API PifDiConfig	createOff (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifDiMode::Off.
static OTC_SDK_API PifDiConfig	createFlagControl (int deviceIndex, int pinIndex, bool openIfLow) noexcept
	Create a configuration for the mode PifDiMode::FlagControl.

Public Attributes
PifIndex	index = {0, 0}
	Identifies the channel by the indices of its pin and the PIF device on which it is located.
PifDiMode	mode = PifDiMode::Off
	Mode to be applied to the channel.
bool	triggerLowActive = true
	Indicates whether the trigger will be pulled if the input signal is low.

Detailed Description

Encapsulates the configuration for a PIF digital input 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

createFlagControl()

static OTC_SDK_API PifDiConfig optris::PifDiConfig::createFlagControl ( int deviceIndex, int pinIndex, bool openIfLow )

staticnoexcept

Create a configuration for the mode PifDiMode::FlagControl.

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]	openIfLow	if true, the shutter flag will be opend, if the input signal is low.

Returns

configuration for the mode PifDiMode::FlagControl.

createOff()

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

staticnoexcept

Creates a configuration for the mode PifDiMode::Off.

Parameters

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

Returns

configuration for the mode PifDiMode::Off.

---

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

• PifChannelConfigs.h