Thermal Camera SDK 10.1.1
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
ProcessInterface.h
Go to the documentation of this file.
1// Copyright (c) 2008-2025 Optris GmbH & Co. KG
2
10
11#pragma once
12
14
15
16namespace optris
17{
18
52{
53public:
55 ProcessInterface() = default;
56
61
66
68 virtual ~ProcessInterface() = default;
69
70
71 // Device
77 virtual PifDeviceType getDeviceType() const noexcept = 0;
78
88 virtual int getActualDeviceCount() const noexcept = 0;
89
95 virtual int getConfigurableDeviceCount() const noexcept = 0;
96
102 virtual bool isActualConnected() const noexcept = 0;
103
104
114 virtual unsigned long getDeviceSerialNumber(int deviceIndex) const = 0;
115
125 virtual unsigned short getDeviceFirmwareRevision(int deviceIndex) const = 0;
126
127
135 virtual void setConfig(const PifConfig& config) = 0;
136
142 virtual PifConfig getConfig() const noexcept = 0;
143
144
145 // Analog inputs
151 virtual int getActualAiCount() const noexcept = 0;
152
158 virtual int getConfigurableAiCount() const noexcept = 0;
159
165 virtual int getAiCountPerDevice() const noexcept = 0;
166
167
175 virtual void setAiConfig(const PifAiConfig& config) = 0;
176
187 virtual PifAiConfig getAiConfig(int deviceIndex, int pinIndex) const = 0;
188
189
190 // Digital inputs
196 virtual int getActualDiCount() const noexcept = 0;
197
203 virtual int getConfigurableDiCount() const noexcept = 0;
204
210 virtual int getDiCountPerDevice() const noexcept = 0;
211
212
220 virtual void setDiConfig(const PifDiConfig& config) = 0;
221
232 virtual PifDiConfig getDiConfig(int deviceIndex, int pinIndex) = 0;
233
234
235 // Analog outputs
241 virtual int getActualAoCount() const noexcept = 0;
242
248 virtual int getConfigurableAoCount() const noexcept = 0;
249
255 virtual int getAoCountPerDevice() const noexcept = 0;
256
262 virtual PifAoOutputMode getDefaultAoOutputMode() const noexcept = 0;
263
264
272 virtual void setAoConfig(const PifAoConfig& config) = 0;
273
284 virtual PifAoConfig getAoConfig(int deviceIndex, int pinIndex) = 0;
285
286
298 virtual void setAoValue(int deviceIndex, int pinIndex, float value) = 0;
299
300
301 // Digital outputs
307 virtual int getActualDoCount() const noexcept = 0;
308
314 virtual int getConfigurableDoCount() const noexcept = 0;
315
321 virtual int getDoCountPerDevice() const noexcept = 0;
322
323
331 virtual void setDoConfig(const PifDoConfig& config) = 0;
332
343 virtual PifDoConfig getDoConfig(int deviceIndex, int pinIndex) = 0;
344
345
355 virtual void setDoValue(int deviceIndex, int pinIndex, bool value) = 0;
356
357
358 // Fail safe
364 virtual bool hasFs() const noexcept = 0;
365
373 virtual void setFsConfig(const PifFsConfig& config) = 0;
374
383};
384
385} // namespace optris
Contains a class that encapsulates the the configuration for the process interface.
Encapsulates the configuration for a PIF analog input channel.
Definition PifChannelConfigs.h:31
Encapsulates the configuration for a PIF analog output channel.
Definition PifChannelConfigs.h:199
Holds the configuration of the processing interface.
Definition PifConfig.h:29
Encapsulates the configuration for a PIF digital input channel.
Definition PifChannelConfigs.h:148
Encapsulates the configuration for a PIF digital output channel.
Definition PifChannelConfigs.h:354
Encapsulates the configuration for a PIF fail safe channel.
Definition PifChannelConfigs.h:443
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 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 DeviceInfo.h:24
PifDeviceType
Represents the supported PIF device types.
Definition PifProperties.h:25
PifAoOutputMode
Represents the available output modes for PIF analog output channels.
Definition PifProperties.h:88