StatusAggregator.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 "ApplicationModule.h"
#include "ModuleGroup.h"
#include "StatusAccessor.h"
#include "StatusWithMessage.h"
#include "VoidAccessor.h"
 
#include <list>
#include <string>
#include <vector>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  struct StatusAggregator : ApplicationModule {
    enum class PriorityMode {
      fwok,          
      fwko,          
      fw_warn_mixed, 
      ofwk           
    };
 
    StatusAggregator(ModuleGroup* owner, const std::string& outputName, const std::string& description,
        PriorityMode mode = PriorityMode::fwok, std::unordered_set<std::string> tagsToAggregate = {},
        const std::unordered_set<std::string>& outputTags = {},
        std::string warnMixedMessage = "warning - StatusAggregator inputs have mixed values");
 
    StatusAggregator(StatusAggregator&& other) = default;
    StatusAggregator() = default;
    StatusAggregator& operator=(StatusAggregator&& other) = default;
 
    void mainLoop() override;
 
    DataValidity getDataValidity() const override;
 
    void setWarnMixedMessage(std::string message);
 
   protected:
    void populateStatusInput();
 
    constexpr static auto tagAggregatedStatus = "_ChimeraTK_StatusAggregator_aggregatedStatus";
 
    constexpr static auto tagInternalVars = "_ChimeraTK_StatusAggregator_internalVars";
 
    StatusWithMessage _output;
 
    std::vector<StatusWithMessageInput> _inputs;
 
    PriorityMode _mode{PriorityMode::fwok};
 
    std::unordered_set<std::string> _tagsToAggregate;
 
    int getPriority(StatusOutput::Status status) const;
 
    VoidInput _debug{this, "/Debug/statusAggregators", "Print debug info for all status aggregators once."};
 
    std::string _warnMixedMessage;
  };
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK