UncommittedValueStatus.h

Go to the documentation of this file.

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

 
#pragma once
 
#include <ostream>
#include <string>
 
#include "otcsdk/Api.h"
#include "otcsdk/pif/PifProperties.h"
 
 
namespace optris 
{

class UncommittedValueStatus
{
public:
  OTC_SDK_API UncommittedValueStatus() noexcept;
 

  const PifIndex& getPifIndex() const noexcept;

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

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

  float getValue() const noexcept;
 

  OTC_SDK_API void update(const PifIndex&    pifIndex, 
                          const std::string& name, 
                          const std::string& unit, 
                          float              value) noexcept;
 
 
private:
  PifIndex _index;

  std::string _name;

  std::string _unit;
  
  float _value;
};
 
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const UncommittedValueStatus& status);
 
 
// Inline implementations
inline const PifIndex& UncommittedValueStatus::getPifIndex() const noexcept
{
  return _index;
}
 
inline const std::string& UncommittedValueStatus::getName() const noexcept
{
  return _name;
}
 
inline const std::string& UncommittedValueStatus::getUnit() const noexcept
{
  return _unit;
}
 
inline float UncommittedValueStatus::getValue() const noexcept
{
  return _value;
}
 
}  // namespace optris