AlarmChannelStatus.h

Go to the documentation of this file.

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

 
#pragma once
 
#include <cstdint>
#include <ostream>
#include <string>
 
#include "otcsdk/Api.h"
#include "otcsdk/alarms/AlarmProperties.h"
 
 
namespace optris 
{

class AlarmChannelStatus
{
public:
  OTC_SDK_API AlarmChannelStatus() noexcept;
 

  std::int32_t getId() const noexcept;

  const std::string& getName() const noexcept;

  AlarmState getState() const noexcept;

  bool isActive() const noexcept;

  float getValue() const noexcept;

  AlarmRangeRelation getAlarmRangeRelation() const noexcept;
 

  OTC_SDK_API void update(std::int32_t       channelId, 
                          const std::string& name, 
                          AlarmState         state, 
                          AlarmRangeRelation alarmRangeRelation,
                          float              value) noexcept;
 
 
private:
  std::int32_t _id;
  std::string _name;
  AlarmState _state;
  AlarmRangeRelation _alarmRangeRelation;
  float _value;
};
 
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const AlarmChannelStatus& status);
 
 
// Inline implementations
inline std::int32_t AlarmChannelStatus::getId() const noexcept
{
  return _id;
}
 
inline const std::string& AlarmChannelStatus::getName() const noexcept
{
  return _name;
}
 
inline AlarmState AlarmChannelStatus::getState() const noexcept
{
  return _state;
}
 
inline AlarmRangeRelation AlarmChannelStatus::getAlarmRangeRelation() const noexcept
{
  return _alarmRangeRelation;
}
 
inline float AlarmChannelStatus::getValue() const noexcept
{
  return _value;
}
 
inline bool AlarmChannelStatus::isActive() const noexcept
{
  return _state == AlarmState::Active;
}
 
} // namespace optris