DataConsistencyGroup.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 "TransferElementAbstractor.h"
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  namespace DataConsistencyGroupDetail {
    class MatcherBase;
  }
 
  class DataConsistencyGroup {
   public:
    enum class MatchingMode {
      none,  
      exact, 
      historized
    };
    constexpr static unsigned defaultHistLen = 2;
 
    explicit DataConsistencyGroup(MatchingMode mode = MatchingMode::exact);
    ~DataConsistencyGroup();
    DataConsistencyGroup(const DataConsistencyGroup& other) = delete;
    DataConsistencyGroup(DataConsistencyGroup&& other) noexcept;
    DataConsistencyGroup& operator=(DataConsistencyGroup&& other) noexcept;
 
    [[deprecated("use list constructor with MatchingMode instead")]]
    DataConsistencyGroup(std::initializer_list<TransferElementAbstractor> list);
    [[deprecated("use list constructor with MatchingMode instead")]]
    DataConsistencyGroup(std::initializer_list<boost::shared_ptr<TransferElement>> list);
    DataConsistencyGroup(std::initializer_list<std::reference_wrapper<TransferElementAbstractor>> list,
        MatchingMode mode, unsigned histLen = defaultHistLen);
 
    template<typename ITERATOR>
    DataConsistencyGroup(
        ITERATOR first, ITERATOR last, MatchingMode mode = MatchingMode::exact, unsigned int histLen = defaultHistLen);
 
    [[deprecated("use add function with histLen instead")]]
    void add(const TransferElementAbstractor& element);
    [[deprecated("use add function with histLen instead")]]
    void add(boost::shared_ptr<TransferElement> element);
    void add(TransferElementAbstractor& acc, unsigned histLen = defaultHistLen);
 
    bool update(const TransferElementID& transferElementID);
 
    [[deprecated("set MatchingMode in constructor instead")]]
    void setMatchingMode(MatchingMode newMode);
 
    [[nodiscard]] MatchingMode getMatchingMode() const { return _mode; };
 
    [[nodiscard]] const std::map<TransferElementID, TransferElementAbstractor>& getElements() const;
    [[nodiscard]] const DataConsistencyGroupDetail::MatcherBase& getMatcher();
 
    [[nodiscard]] bool isConsistent() const;
 
   private:
    void initMatcher();
    static void checkAccess(const TransferElementAbstractor& element);
 
    MatchingMode _mode{MatchingMode::exact};
 
    std::unique_ptr<DataConsistencyGroupDetail::MatcherBase> _impl;
  };
 
  /********************************************************************************************************************/
 
  template<typename ITERATOR>
  DataConsistencyGroup::DataConsistencyGroup(ITERATOR first, ITERATOR last, MatchingMode mode, unsigned int histLen)
  : _mode(mode) {
    initMatcher();
    for(auto it = first; it != last; ++it) {
      add(*it, histLen);
    }
  }
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK