StatusWithMessage.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include "ScalarAccessor.h"
#include "StatusAccessor.h"
#include "Utilities.h"
#include "VariableGroup.h"
 
#include <ChimeraTK/ControlSystemAdapter/StatusWithMessageReader.h>
#include <ChimeraTK/DataConsistencyGroup.h>
#include <ChimeraTK/ForwardDeclarations.h>
#include <ChimeraTK/RegisterPath.h>
 
#include <utility>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  struct StatusWithMessage : VariableGroup {
    StatusWithMessage(VariableGroup* owner, const std::string& qualifiedStatusVariableName,
        const std::string& description = "", const std::unordered_set<std::string>& tags = {});
 
    StatusWithMessage() = default;
 
    void write(StatusOutput::Status status, std::string message);
    void writeIfDifferent(StatusOutput::Status status, std::string message);
 
    void writeOk();
    void writeOkIfDifferent();
 
    void set(StatusOutput::Status status, std::string message);
 
    void setOk();
 
    constexpr static auto tagStatusHasMessage = "_ChimeraTK_StatusOutput_hasMessage";
 
    // FIXME: This needs additional modification in ControlSystemAdapter if changed
    // https://redmine.msktools.desy.de/issues/12241
    // NOLINTNEXTLINE(readability-identifier-naming)
    StatusOutput _status;
    // NOLINTNEXTLINE(readability-identifier-naming)
    ScalarOutput<std::string> _message;
  };
 
  /********************************************************************************************************************/
 
  struct StatusWithMessageInput : StatusWithMessageReaderBase<StatusWithMessageInput>, public VariableGroup {
    StatusWithMessageInput(VariableGroup* owner, const std::string& qualifiedName, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
 
    void setMessageSource(std::string msgInputName = "");
 
    // TODO: This needs additional modification in ControlSystemAdapter if changed
    // https://redmine.msktools.desy.de/issues/12241
    // NOLINTNEXTLINE(readability-identifier-naming)
    StatusPushInput _status;
    // NOLINTNEXTLINE(readability-identifier-naming)
    ScalarPushInput<std::string> _message; // left uninitialized, if no message source provided
  };
 
  /********************************************************************************************************************/
 
} /* namespace ChimeraTK */