optris::PifDoConfig Class Reference

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

#include <PifChannelConfigs.h>

Collaboration diagram for optris::PifDoConfig:

Public Member Functions
OTC_SDK_API	PifDoConfig () noexcept
	Constructor.

Static Public Member Functions
static OTC_SDK_API PifDoConfig	createOff (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifDoMode::Off.
static OTC_SDK_API PifDoConfig	createFlagStatus (int deviceIndex, int pinIndex, bool lowIfOpen) noexcept
	Creates a configuration for the mode PifDoMode::FlagStatus.
static OTC_SDK_API PifDoConfig	createFrameSync (int deviceIndex, int pinIndex) noexcept
	Create a configuration for the mode PifDoMode::FrameSync.
static OTC_SDK_API PifDoConfig	createExternalCommunication (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifDoMode::ExternalCommunication.
static OTC_SDK_API PifDoConfig	createFailSafe (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifDoMode::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.
PifDoMode	mode
	Mode to be applied to the channel.
bool	outputLowActive
	Indicates if the output is low active.

Detailed Description

Encapsulates the configuration for a PIF digital 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 PifDoConfig optris::PifDoConfig::createExternalCommunication ( int deviceIndex, int pinIndex )

staticnoexcept

Creates a configuration for the mode PifDoMode::ExternalCommunication.

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

Parameters

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

Returns

configuration for the mode PifDoMode::ExternalCommunication.

createFailSafe()

static OTC_SDK_API PifDoConfig optris::PifDoConfig::createFailSafe ( int deviceIndex, int pinIndex )

staticnoexcept

Creates a configuration for the mode PifDoMode::FailSafe.

Refer to the Fail Safe chapter for more details.

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.

Returns

configuration for the mode PifDoMode::FailSafe.

createFlagStatus()

static OTC_SDK_API PifDoConfig optris::PifDoConfig::createFlagStatus ( int deviceIndex, int pinIndex, bool lowIfOpen )

staticnoexcept

Creates a configuration for the mode PifDoMode::FlagStatus.

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]	lowIfOpen	if true, a low signal will be output, if the flag is open.

Returns

configuration for the mode PifDoMode::FlagStatus.

createFrameSync()

static OTC_SDK_API PifDoConfig optris::PifDoConfig::createFrameSync ( int deviceIndex, int pinIndex )

staticnoexcept

Create a configuration for the mode PifDoMode::FrameSync.

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.

Returns

configuration for the mode PifDoMode::FrameSync.

createOff()

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

staticnoexcept

Creates a configuration for the mode PifDoMode::Off.

Parameters

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

Returns

configuration for the mode PifDoMode::Off.

---

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

• PifChannelConfigs.h