Thermal Camera SDK 11.3.0
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
ProcessInterface.h
Go to the documentation of this file.
1// Copyright (c) 2008-2026 Optris GmbH & Co. KG
2
10
11#pragma once
12
13#include <vector>
14
16
17
18namespace optris
19{
20
54{
55public:
57 ProcessInterface() = default;
58
63
68
70 virtual ~ProcessInterface() = default;
71
72
73 // Device
79 virtual PifDeviceType getDeviceType() const noexcept = 0;
80
90 virtual std::vector<PifDeviceType> getSupportedDeviceTypes() const noexcept = 0;
91
101 virtual int getActualDeviceCount() const noexcept = 0;
102
108 virtual int getConfigurableDeviceCount() const noexcept = 0;
109
115 virtual bool isActualConnected() const noexcept = 0;
116
117
127 virtual unsigned long getDeviceSerialNumber(int deviceIndex) const = 0;
128
138 virtual unsigned short getDeviceFirmwareRevision(int deviceIndex) const = 0;
139
140
148 virtual void setConfig(const PifConfig& config) = 0;
149
155 virtual PifConfig getConfig() const noexcept = 0;
156
157
158 // Analog inputs
164 virtual int getActualAiCount() const noexcept = 0;
165
171 virtual int getConfigurableAiCount() const noexcept = 0;
172
178 virtual int getAiCountPerDevice() const noexcept = 0;
179
180
191 virtual void setAiConfig(const PifAiConfig& config) = 0;
192
203 virtual PifAiConfig getAiConfig(int deviceIndex, int pinIndex) const = 0;
204
205
206 // Digital inputs
212 virtual int getActualDiCount() const noexcept = 0;
213
219 virtual int getConfigurableDiCount() const noexcept = 0;
220
226 virtual int getDiCountPerDevice() const noexcept = 0;
227
228
236 virtual void setDiConfig(const PifDiConfig& config) = 0;
237
248 virtual PifDiConfig getDiConfig(int deviceIndex, int pinIndex) = 0;
249
250
251 // Analog outputs
257 virtual int getActualAoCount() const noexcept = 0;
258
264 virtual int getConfigurableAoCount() const noexcept = 0;
265
271 virtual int getAoCountPerDevice() const noexcept = 0;
272
278 virtual PifAoOutputMode getDefaultAoOutputMode() const noexcept = 0;
279
280
288 virtual void setAoConfig(const PifAoConfig& config) = 0;
289
300 virtual PifAoConfig getAoConfig(int deviceIndex, int pinIndex) = 0;
301
302
314 virtual void setAoValue(int deviceIndex, int pinIndex, float value) = 0;
315
316
317 // Digital outputs
323 virtual int getActualDoCount() const noexcept = 0;
324
330 virtual int getConfigurableDoCount() const noexcept = 0;
331
337 virtual int getDoCountPerDevice() const noexcept = 0;
338
339
347 virtual void setDoConfig(const PifDoConfig& config) = 0;
348
359 virtual PifDoConfig getDoConfig(int deviceIndex, int pinIndex) = 0;
360
361
371 virtual void setDoValue(int deviceIndex, int pinIndex, bool value) = 0;
372
373
374 // Fail safe
380 virtual bool hasFs() const noexcept = 0;
381
389 virtual void setFsConfig(const PifFsConfig& config) = 0;
390
399};
400
401} // namespace optris
Contains a class encapsulating the configuration for the process interface.
virtual int getConfigurableDoCount() const noexcept=0
Returns the count of all digital output channels on configurable PIFs.
ProcessInterface(ProcessInterface &&)=delete
No move constructor.
virtual int getConfigurableDiCount() const noexcept=0
Returns the count of all digital input channels on configurable PIFs.
virtual PifAiConfig getAiConfig(int deviceIndex, int pinIndex) const =0
Returns the current configuration of the specified analog input channel.
virtual PifDeviceType getDeviceType() const noexcept=0
Returns the PIF device type.
virtual int getActualDoCount() const noexcept=0
Returns the count of all digital output channels on actually connected PIFs.
virtual int getActualDeviceCount() const noexcept=0
Returns the count of actually connected PIFs.
virtual unsigned short getDeviceFirmwareRevision(int deviceIndex) const =0
Returns the firmware revision of the PIF with the given device index.
virtual PifAoConfig getAoConfig(int deviceIndex, int pinIndex)=0
Returns the current configuration of the specified analog output channel.
virtual PifFsConfig getFsConfig()=0
Returns the current fail safe channel configuration.
virtual unsigned long getDeviceSerialNumber(int deviceIndex) const =0
Returns the serial number of the PIF with the given device index.
virtual ~ProcessInterface()=default
Destructor.
virtual void setFsConfig(const PifFsConfig &config)=0
Sets the configuration for the fail safe channel.
virtual bool hasFs() const noexcept=0
Returns wether the PIF has a fail safe channel.
ProcessInterface & operator=(const ProcessInterface &)=delete
No copy assignment.
virtual PifConfig getConfig() const noexcept=0
Returns the current configuration of the entire process interface.
virtual void setAoConfig(const PifAoConfig &config)=0
Sets the configuration for a single analog output channel.
virtual PifAoOutputMode getDefaultAoOutputMode() const noexcept=0
Returns the default analog output mode of the PIF.
virtual void setAoValue(int deviceIndex, int pinIndex, float value)=0
Sets the output value of the specified analog output channel.
virtual int getActualAoCount() const noexcept=0
Returns the count of all analog output channels on actually connected PIFs.
ProcessInterface & operator=(ProcessInterface &&)=delete
No move assignment.
virtual void setDoConfig(const PifDoConfig &config)=0
Sets the configuration for a single digital output channel.
virtual std::vector< PifDeviceType > getSupportedDeviceTypes() const noexcept=0
Returns the list of PIF device types this camera model accepts in setConfig().
virtual int getActualAiCount() const noexcept=0
Returns the count of all analog input channels on actually connected PIFs.
virtual int getAiCountPerDevice() const noexcept=0
Returns the count of all analog input channels on a single PIF.
ProcessInterface()=default
Constructor.
virtual int getAoCountPerDevice() const noexcept=0
Returns the count of all analog output channels on a single PIF.
virtual bool isActualConnected() const noexcept=0
Returns whether a PIF is actually connected.
virtual void setDiConfig(const PifDiConfig &config)=0
Sets the configuration for a single digital input channel.
virtual void setConfig(const PifConfig &config)=0
Sets the given configuration for the entire process interface.
virtual int getConfigurableAiCount() const noexcept=0
Returns the count of all analog input channels on configurable PIFs.
virtual int getConfigurableDeviceCount() const noexcept=0
Returns the count of configurable PIFs.
virtual int getActualDiCount() const noexcept=0
Returns the count of all digital input channels on actually connected PIFs.
ProcessInterface(const ProcessInterface &)=delete
No copy constructor.
virtual void setAiConfig(const PifAiConfig &config)=0
Sets the configuration for a single analog input channel.
virtual int getConfigurableAoCount() const noexcept=0
Returns the count of all analog output channels on configurable PIFs.
virtual PifDiConfig getDiConfig(int deviceIndex, int pinIndex)=0
Returns the current configuration of the specified digital input channel.
virtual void setDoValue(int deviceIndex, int pinIndex, bool value)=0
Sets the output value of the specified digital output channel.
virtual PifDoConfig getDoConfig(int deviceIndex, int pinIndex)=0
Returns the current configuration of the specified digital output channel.
virtual int getDiCountPerDevice() const noexcept=0
Returns the count of all digital input channels on a single PIF.
virtual int getDoCountPerDevice() const noexcept=0
Returns the count of all digital output channels on a single PIF.
Main SDK namespace.
Definition AlarmChannel.h:21
PifDeviceType
Represents the supported PIF device types.
Definition PifProperties.h:26
PifAoOutputMode
Represents the available output modes for PIF analog output channels.
Definition PifProperties.h:90
Encapsulates the configuration for a PIF analog input channel.
Definition PifChannelConfigs.h:33
Encapsulates the configuration for a PIF analog output channel.
Definition PifChannelConfigs.h:188
Holds the configuration of the processing interface.
Definition PifConfig.h:29
Encapsulates the configuration for a PIF digital input channel.
Definition PifChannelConfigs.h:144
Encapsulates the configuration for a PIF digital output channel.
Definition PifChannelConfigs.h:353
Encapsulates the configuration for a PIF fail safe channel.
Definition PifChannelConfigs.h:446