Interface defining the API for interacting with process interfaces (PIFs). More...

#include <ProcessInterface.h>

Collaboration diagram for optris::ProcessInterface:

Public Member Functions
	ProcessInterface ()=default
	Constructor.

	ProcessInterface (const ProcessInterface &)=delete
	No copy constructor.

ProcessInterface &	operator= (const ProcessInterface &)=delete
	No copy assignment.

	ProcessInterface (ProcessInterface &&)=delete
	No move constructor.

ProcessInterface &	operator= (ProcessInterface &&)=delete
	No move assignment.

virtual	~ProcessInterface ()=default
	Destructor.

virtual PifDeviceType	getDeviceType () const noexcept=0
	Returns the PIF device type.

virtual std::vector< PifDeviceType >	getSupportedDeviceTypes () const noexcept=0
	Returns the list of PIF device types this camera model accepts in setConfig().

virtual int	getActualDeviceCount () const noexcept=0
	Returns the count of actually connected PIFs.

virtual int	getConfigurableDeviceCount () const noexcept=0
	Returns the count of configurable PIFs.

virtual bool	isActualConnected () const noexcept=0
	Returns whether a PIF is actually connected.

virtual unsigned long	getDeviceSerialNumber (int deviceIndex) const =0
	Returns the serial number of the PIF with the given device index.

virtual unsigned short	getDeviceFirmwareRevision (int deviceIndex) const =0
	Returns the firmware revision of the PIF with the given device index.

virtual void	setConfig (const PifConfig &config)=0
	Sets the given configuration for the entire process interface.

virtual PifConfig	getConfig () const noexcept=0
	Returns the current configuration of the entire process interface.

virtual int	getActualAiCount () const noexcept=0
	Returns the count of all analog input channels on actually connected PIFs.

virtual int	getConfigurableAiCount () const noexcept=0
	Returns the count of all analog input channels on configurable PIFs.

virtual int	getAiCountPerDevice () const noexcept=0
	Returns the count of all analog input channels on a single PIF.

virtual void	setAiConfig (const PifAiConfig &config)=0
	Sets the configuration for a single analog input channel.

virtual PifAiConfig	getAiConfig (int deviceIndex, int pinIndex) const =0
	Returns the current configuration of the specified analog input channel.

virtual int	getActualDiCount () const noexcept=0
	Returns the count of all digital input channels on actually connected PIFs.

virtual int	getConfigurableDiCount () const noexcept=0
	Returns the count of all digital input channels on configurable PIFs.

virtual int	getDiCountPerDevice () const noexcept=0
	Returns the count of all digital input channels on a single PIF.

virtual void	setDiConfig (const PifDiConfig &config)=0
	Sets the configuration for a single digital input channel.

virtual PifDiConfig	getDiConfig (int deviceIndex, int pinIndex)=0
	Returns the current configuration of the specified digital input channel.

virtual int	getActualAoCount () const noexcept=0
	Returns the count of all analog output channels on actually connected PIFs.

virtual int	getConfigurableAoCount () const noexcept=0
	Returns the count of all analog output channels on configurable PIFs.

virtual int	getAoCountPerDevice () const noexcept=0
	Returns the count of all analog output channels on a single PIF.

virtual PifAoOutputMode	getDefaultAoOutputMode () const noexcept=0
	Returns the default analog output mode of the PIF.

virtual void	setAoConfig (const PifAoConfig &config)=0
	Sets the configuration for a single analog output channel.

virtual PifAoConfig	getAoConfig (int deviceIndex, int pinIndex)=0
	Returns the current configuration of the specified analog output channel.

virtual void	setAoValue (int deviceIndex, int pinIndex, float value)=0
	Sets the output value of the specified analog output channel.

virtual int	getActualDoCount () const noexcept=0
	Returns the count of all digital output channels on actually connected PIFs.

virtual int	getConfigurableDoCount () const noexcept=0
	Returns the count of all digital output channels on configurable PIFs.

virtual int	getDoCountPerDevice () const noexcept=0
	Returns the count of all digital output channels on a single PIF.

virtual void	setDoConfig (const PifDoConfig &config)=0
	Sets the configuration for a single digital output channel.

virtual PifDoConfig	getDoConfig (int deviceIndex, int pinIndex)=0
	Returns the current configuration of the specified digital output channel.

virtual void	setDoValue (int deviceIndex, int pinIndex, bool value)=0
	Sets the output value of the specified digital output channel.

virtual bool	hasFs () const noexcept=0
	Returns wether the PIF has a fail safe channel.

virtual void	setFsConfig (const PifFsConfig &config)=0
	Sets the configuration for the fail safe channel.

virtual PifFsConfig	getFsConfig ()=0
	Returns the current fail safe channel configuration.

Detailed Description

Interface defining the API for interacting with process interfaces (PIFs).

Each PIF can have up to five different channel type. The API uses the following abbreviations to mark resources specific to a channel type:

Ai - analog inputs
Di - digital inputs
Ao - analog outputs
Do - digital outputs
Fs - fail safe

In case of stackable PIFs the number of configurable PIFs can deviate from the number of actually connected PIFs. To reflect this the API features different count methods for PIF devices and PIF channels:

Devices

getActualDeviceCount() returns the number of actually connected devices.
getConfigurableDeviceCount() returns the number configurable devices.

Note: On non-stackable PIFs these methods yield the same values.

Channels (XX denotes the channel type)

getActualXXCount() returns the count of all XX channels on actually connected devices.
getConfigurableXXCount() returns the count of all XX channels on configurable devices.
getXXCountPerDevice() returns the count of XX channels per individual device.

Note: The actual PIF device count can never exceed the configurable device count.

For more details and an overview of the process interface capabilities please refer to the Process Interface (PIF) chapter.

Member Function Documentation

◆ getActualAiCount()

virtual int optris::ProcessInterface::getActualAiCount ( ) const

pure virtualnoexcept

Returns the count of all analog input channels on actually connected PIFs.

Returns: count of all analog input channels on actually connected PIFs.

◆ getActualAoCount()

virtual int optris::ProcessInterface::getActualAoCount ( ) const

pure virtualnoexcept

Returns the count of all analog output channels on actually connected PIFs.

Returns: count of all analog output channels on actually connected PIFs.

◆ getActualDeviceCount()

virtual int optris::ProcessInterface::getActualDeviceCount ( ) const

pure virtualnoexcept

Returns the count of actually connected PIFs.

The method only returns count of connected PIFs whose type equals the one returned by getDeviceType().

Attention: This count can never exceed the configurable device count returned by getConfigurableDeviceCount().

Returns: count of actually connected PIFs.

◆ getActualDiCount()

virtual int optris::ProcessInterface::getActualDiCount ( ) const

pure virtualnoexcept

Returns the count of all digital input channels on actually connected PIFs.

Returns: count of all digital input channels on actually connected PIFs.

◆ getActualDoCount()

virtual int optris::ProcessInterface::getActualDoCount ( ) const

pure virtualnoexcept

Returns the count of all digital output channels on actually connected PIFs.

Returns: count of all digital output channels on actually connected PIFs.

◆ getAiConfig()

virtual PifAiConfig optris::ProcessInterface::getAiConfig	(	int	deviceIndex,
		int	pinIndex ) const

pure virtual

Returns the current configuration of the specified analog input channel.

Parameters

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

Returns: current configuration of the specified analog input channel.

Exceptions

SDKException if the given indices are out of range.

◆ getAiCountPerDevice()

virtual int optris::ProcessInterface::getAiCountPerDevice ( ) const

pure virtualnoexcept

Returns the count of all analog input channels on a single PIF.

Returns: count of all analog input channels on a single PIF.

◆ getAoConfig()

virtual PifAoConfig optris::ProcessInterface::getAoConfig	(	int	deviceIndex,
		int	pinIndex )

pure virtual

Returns the current configuration of the specified analog output channel.

Parameters

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

Returns: current configuration of the specified analog output channel.

Exceptions

SDKException if the given indices are out of range.

◆ getAoCountPerDevice()

virtual int optris::ProcessInterface::getAoCountPerDevice ( ) const

pure virtualnoexcept

Returns the count of all analog output channels on a single PIF.

Returns: count of all analog output channels on a single PIF.

◆ getConfig()

virtual PifConfig optris::ProcessInterface::getConfig ( ) const

pure virtualnoexcept

Returns the current configuration of the entire process interface.

Returns: the current configuration of the entire process interface.

◆ getConfigurableAiCount()

virtual int optris::ProcessInterface::getConfigurableAiCount ( ) const

pure virtualnoexcept

Returns the count of all analog input channels on configurable PIFs.

Returns: count of all analog input channels on configurable PIFs.

◆ getConfigurableAoCount()

virtual int optris::ProcessInterface::getConfigurableAoCount ( ) const

pure virtualnoexcept

Returns the count of all analog output channels on configurable PIFs.

Returns: count of all analog output channels on configurable PIFs.

◆ getConfigurableDeviceCount()

virtual int optris::ProcessInterface::getConfigurableDeviceCount ( ) const

pure virtualnoexcept

Returns the count of configurable PIFs.

Returns: count of configurable PIFs.

◆ getConfigurableDiCount()

virtual int optris::ProcessInterface::getConfigurableDiCount ( ) const

pure virtualnoexcept

Returns the count of all digital input channels on configurable PIFs.

Returns: count of all digital input channels on configurable PIFs.

◆ getConfigurableDoCount()

virtual int optris::ProcessInterface::getConfigurableDoCount ( ) const

pure virtualnoexcept

Returns the count of all digital output channels on configurable PIFs.

Returns: count of all digital output channels on configurable PIFs.

◆ getDefaultAoOutputMode()

virtual PifAoOutputMode optris::ProcessInterface::getDefaultAoOutputMode ( ) const

pure virtualnoexcept

Returns the default analog output mode of the PIF.

Returns: default analog output mode of the PIF.

◆ getDeviceFirmwareRevision()

virtual unsigned short optris::ProcessInterface::getDeviceFirmwareRevision ( int deviceIndex ) const

pure virtual

Returns the firmware revision of the PIF with the given device index.

Parameters

[in] deviceIndex identifying the PIF device.

Returns: firmware revision of the PIF with the given device index.

Exceptions

SDKException if the device index is out of range.

◆ getDeviceSerialNumber()

virtual unsigned long optris::ProcessInterface::getDeviceSerialNumber ( int deviceIndex ) const

pure virtual

Returns the serial number of the PIF with the given device index.

Parameters

[in] deviceIndex identifying the PIF device.

Returns: serial number of the PIF with the given device index.

Exceptions

SDKException if the device index is out of range.

◆ getDeviceType()

virtual PifDeviceType optris::ProcessInterface::getDeviceType ( ) const

pure virtualnoexcept

Returns the PIF device type.

Returns: PIF device type.

◆ getDiConfig()

virtual PifDiConfig optris::ProcessInterface::getDiConfig	(	int	deviceIndex,
		int	pinIndex )

pure virtual

Returns the current configuration of the specified digital input channel.

Parameters

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

Returns: current configuration of the specified digital input channel.

Exceptions

SDKException if the given indices are out of range.

◆ getDiCountPerDevice()

virtual int optris::ProcessInterface::getDiCountPerDevice ( ) const

pure virtualnoexcept

Returns the count of all digital input channels on a single PIF.

Returns: count of all digital input channels on a single PIF.

◆ getDoConfig()

virtual PifDoConfig optris::ProcessInterface::getDoConfig	(	int	deviceIndex,
		int	pinIndex )

pure virtual

Returns the current configuration of the specified digital output channel.

Parameters

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

Returns: current configuration of the specified digital output channel.

Exceptions

SDKException if the given indices are out of range.

◆ getDoCountPerDevice()

virtual int optris::ProcessInterface::getDoCountPerDevice ( ) const

pure virtualnoexcept

Returns the count of all digital output channels on a single PIF.

Returns: count of all digital output channels on a single PIF.

◆ getFsConfig()

virtual PifFsConfig optris::ProcessInterface::getFsConfig ( )

pure virtual

Returns the current fail safe channel configuration.

Returns: current fail safe channel configuration.

Exceptions

SDKException if no fail safe channel is available.

◆ getSupportedDeviceTypes()

virtual std::vector< PifDeviceType > optris::ProcessInterface::getSupportedDeviceTypes ( ) const

pure virtualnoexcept

Returns the list of PIF device types this camera model accepts in setConfig().

Cameras are categorized into three groups (autonomous, PI1, non-autonomous), each accepting a different subset of PifDeviceType values. This method reports the subset for the connected camera so clients can build a UI that only offers valid choices.

Returns: supported PIF device types for this camera.

◆ hasFs()

virtual bool optris::ProcessInterface::hasFs ( ) const

pure virtualnoexcept

Returns wether the PIF has a fail safe channel.

Returns: true if the PIF has a fail safe channel. False otherwise.

◆ isActualConnected()

virtual bool optris::ProcessInterface::isActualConnected ( ) const

pure virtualnoexcept

Returns whether a PIF is actually connected.

Returns: false if the actual device count is 0. True otherwise.

◆ setAiConfig()

virtual void optris::ProcessInterface::setAiConfig ( const PifAiConfig & config )

pure virtual

Sets the configuration for a single analog input channel.

If an analog input channel that generates an uncommitted value is switch to a different mode, dependent alarm channel turn orphaned and are subsequently removed.

Parameters

[in] config to set.

Exceptions

SDKExceptions if the provided configuration could not be applied.

◆ setAoConfig()

virtual void optris::ProcessInterface::setAoConfig ( const PifAoConfig & config )

pure virtual

Sets the configuration for a single analog output channel.

Parameters

[in] config to set.

Exceptions

SDKExceptions if the provided configuration could not be applied.

◆ setAoValue()

virtual void optris::ProcessInterface::setAoValue	(	int	deviceIndex,
		int	pinIndex,
		float	value )

pure virtual

Sets the output value of the specified analog output channel.

The provided value is automatically clipped to the set output mode limits.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	value	to output.

Exceptions

SDKException if the indices are out of range or if the channel is not set to PifAoMode::ExternalCommunication.

◆ setConfig()

virtual void optris::ProcessInterface::setConfig ( const PifConfig & config )

pure virtual

Sets the given configuration for the entire process interface.

Parameters

[in] config to set.

Exceptions

SDKException if the provided configuration could not be applied.

◆ setDiConfig()

virtual void optris::ProcessInterface::setDiConfig ( const PifDiConfig & config )

pure virtual

Sets the configuration for a single digital input channel.

Parameters

[in] config to set.

Exceptions

SDKExceptions if the provided configuration could not be applied.

◆ setDoConfig()

virtual void optris::ProcessInterface::setDoConfig ( const PifDoConfig & config )

pure virtual

Sets the configuration for a single digital output channel.

Parameters

[in] config to set.

Exceptions

SDKExceptions if the provided configuration could not be applied.

◆ setDoValue()

virtual void optris::ProcessInterface::setDoValue	(	int	deviceIndex,
		int	pinIndex,
		bool	value )

pure virtual

Sets the output value of the specified digital output channel.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	value	to output.

Exceptions

SDKException if the indices are out of range or if the channel is not set to PifDoMode::ExternalCommunication.

◆ setFsConfig()

virtual void optris::ProcessInterface::setFsConfig ( const PifFsConfig & config )

pure virtual

Sets the configuration for the fail safe channel.

Parameters

[in] config to set.

Exceptions

SDKException if no fail safe channel is available.

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

ProcessInterface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getActualAiCount()

◆ getActualAoCount()

◆ getActualDeviceCount()

◆ getActualDiCount()

◆ getActualDoCount()

◆ getAiConfig()

◆ getAiCountPerDevice()

◆ getAoConfig()

◆ getAoCountPerDevice()

◆ getConfig()

◆ getConfigurableAiCount()

◆ getConfigurableAoCount()

◆ getConfigurableDeviceCount()

◆ getConfigurableDiCount()

◆ getConfigurableDoCount()

◆ getDefaultAoOutputMode()

◆ getDeviceFirmwareRevision()

◆ getDeviceSerialNumber()

◆ getDeviceType()

◆ getDiConfig()

◆ getDiCountPerDevice()

◆ getDoConfig()

◆ getDoCountPerDevice()

◆ getFsConfig()

◆ getSupportedDeviceTypes()

◆ hasFs()

◆ isActualConnected()

◆ setAiConfig()

◆ setAoConfig()

◆ setAoValue()

◆ setConfig()

◆ setDiConfig()

◆ setDoConfig()

◆ setDoValue()

◆ setFsConfig()