Thermal Camera SDK 11.4.10
SDK for Optris Thermal Cameras
Loading...
Searching...
No Matches
AlarmProperties.h
Go to the documentation of this file.
1// Copyright (c) 2008-2026 Optris GmbH & Co. KG
2
11#pragma once
12
13#include <string>
14#include <ostream>
15
16#include "otcsdk/Api.h"
17
18
19namespace optris
20{
21
30
32enum class AlarmState
33{
34 Unknown,
35 Disabled,
36 Orphaned,
37 Clear,
38 PreActive,
39 Active,
40};
41
44{
45 Unknown,
47 InRange,
49};
50
51
52// Utility functions
62OTC_SDK_API std::string toString(AlarmInput alarmInput) noexcept;
63
73OTC_SDK_API std::string toString(AlarmState alarmState) noexcept;
74
84OTC_SDK_API std::string toString(AlarmRangeRelation alarmRangeRelation) noexcept;
85
94OTC_SDK_API std::ostream& operator<<(std::ostream& out, AlarmInput alarmInput) noexcept;
95
104OTC_SDK_API std::ostream& operator<<(std::ostream& out, AlarmState alarmState) noexcept;
105
114OTC_SDK_API std::ostream& operator<<(std::ostream& out, AlarmRangeRelation alarmRangeRelation) noexcept;
115
116} // namespace optris
Contains defines controlling the Windows DLL export and import of symbols.
Measurement field or region of interest (ROI) within the thermal frame.
Definition MeasurementField.h:24
Main SDK namespace.
Definition AlarmChannel.h:21
OTC_SDK_API std::ostream & operator<<(std::ostream &out, const AlarmChannelConfig &config) noexcept
Output stream operator for alarm channel configurations.
AlarmInput
Represents the different inputs that an alarm channel monitors.
Definition AlarmProperties.h:24
@ UncommittedValue
Monitors an uncommitted value generated by a PIF analog input channel.
@ InternalTemperature
Monitors the internal temperature of the device.
@ ChipTemperature
Monitors the temperature of the sensor chip.
OTC_SDK_API std::string toString(AlarmInput alarmInput) noexcept
Returns a string representation of the given alarm input.
AlarmRangeRelation
Represents the relation of an alarm input value to an alarm range.
Definition AlarmProperties.h:44
@ BelowRange
The alarm input value is below the alarm range (less than its minimum).
@ InRange
The alarm input value is in the alarm range.
@ AboveRange
The alarm input value is above the alarm range (greater than its maximum).
AlarmState
Represents the different states an alarm channel can be in.
Definition AlarmProperties.h:33
@ PreActive
A preliminary alarm is active.
@ Active
Alarm is active.
@ Unknown
Alarm channel state is unknown because no input has yet been received.
@ Orphaned
Alarm channel is orphaned because its input was removed.
@ Disabled
Alarm channel is disabled.
@ Clear
Alarm is clear.