AlarmChannelConfig.h

Go to the documentation of this file.

// Copyright (c) 2008-2026 Optris GmbH & Co. KG

 
#pragma once
 
#include <ostream>
#include <string>
#include <vector>
 
#include "otcsdk/Api.h"
#include "otcsdk/alarms/AlarmProperties.h"
#include "otcsdk/common/Range.h"
#include "otcsdk/fields/FieldProperties.h"
#include "otcsdk/fields/MeasurementField.h"
#include "otcsdk/pif/PifProperties.h"
 
 
namespace optris 
{

struct AlarmChannelConfig
{
  std::string name;

  AlarmInput input = AlarmInput::InternalTemperature;

  int fieldIndex = 0;
  FieldStat fieldStat = FieldStat::Mean;

  PifIndex uncommittedValuePifIndex = {0, 0};

  bool enabled = true;

  bool preAlarmEnabled = false;  
  RangeF preAlarmRange = {20.F, 40.F};
  RangeF alarmRange = {25.F, 40.F};

  bool partOfComposite = false;

  std::vector<PifIndex> pifAoIndices;
  std::vector<PifIndex> pifDoIndices;
 

  OTC_SDK_API static AlarmChannelConfig createInternalTemperature(const std::string& name, float minTemperature, float maxTemperature) noexcept;

  OTC_SDK_API static AlarmChannelConfig createChipTemperature(const std::string& name, float minTemperature, float maxTemperature) noexcept;

  OTC_SDK_API static AlarmChannelConfig createMeasurementField(const std::string&                   name,
                                                               const MeasurementField::ConstShared& field, 
                                                               FieldStat                            fieldStat, 
                                                               float                                minTemperature, 
                                                               float                                maxTemperature) noexcept;

  OTC_SDK_API static AlarmChannelConfig createUncommittedValue(const std::string& name,
                                                               int                pifDeviceIndex, 
                                                               int                pifPinIndex, 
                                                               float              minValue, 
                                                               float              maxValue) noexcept;
 

  OTC_SDK_API static void validate(AlarmChannelConfig& config);
};
 
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const AlarmChannelConfig& config) noexcept;
 
}  // namespace optris