ESProductHost.h

Go to the documentation of this file.

#ifndef FWCore_Framework_ESProductHost_h
#define FWCore_Framework_ESProductHost_h
// -*- C++ -*-
//
// Package:     Framework
// Class:      ESProductHost
//
//
// Author:      W. David Dagenhart
// Created:     28 August 2018
//

#include <cstddef>
#include <type_traits>
#include <vector>

namespace edm {

  // The parameter pack RecordTypes should contain all the
  // record types which you want to use when calling the
  // function "ifRecordChanges" as the first template parameter
  // to that function (the RecordType). The list of types in
  // RecordTypes is used only to size the vector of cacheIDs_ and
  // to establish an order of the types in RecordTypes. The
  // order is only used to establish a one to one correspondence
  // between cacheIDs_ and the types. The particular order
  // selected does not mattter, just that some order exists
  // so we know which cacheID corresponds to which type.

  template <typename Product, typename... RecordTypes>
  class ESProductHost final : public Product {
  public:
    template <typename... Args>
    ESProductHost(Args&&... args) : Product(std::forward<Args>(args)...), cacheIDs_(numberOfRecordTypes(), 0) {}

    // Execute FUNC if the cacheIdentifier in the EventSetup RecordType
    // has changed since the last time we called FUNC for
    // this EventSetup product.

    template <typename RecordType, typename ContainingRecordType, typename FUNC>
    void ifRecordChanges(ContainingRecordType const& containingRecord, FUNC func) {
      RecordType const& record = containingRecord.template getRecord<RecordType>();
      unsigned long long cacheIdentifier = record.cacheIdentifier();
      std::size_t iRecord = index<RecordType>();
      if (cacheIdentifier != cacheIDs_[iRecord]) {
        cacheIDs_[iRecord] = cacheIdentifier;
        func(record);
      }
    }

    // The rest of the functions are not intended for public use.
    // The only reason they are not private is that test code
    // uses them.

    // Return the number of record types for which we want to check
    // if the cache identifier changed.

    constexpr static std::size_t numberOfRecordTypes() { return sizeof...(RecordTypes); }

    // Return the index of a record type in the types in the parameter pack RecordTypes.
    // The first type in the template parameters after the Product type
    // will have an index of 0, the next 1, and so on.
    // (There must be at least one type after Product if you want to call the
    // "ifRecordChanges" function).

    template <typename U>
    constexpr static std::size_t index() {
      static_assert(numberOfRecordTypes() > 0, "no record types in ESProductHost");
      return indexLoop<0, U, RecordTypes...>();
    }

    template <std::size_t I, typename U, typename TST, typename... M>
    constexpr static std::size_t indexLoop() {
      if constexpr (std::is_same_v<U, TST>) {
        return I;
      } else {
        static_assert(I + 1 < numberOfRecordTypes(), "unknown record type passed to ESProductHost::index");
        return indexLoop<I + 1, U, M...>();
      }
    }

  private:
    // Data member, this holds the cache identifiers from the record which
    // are used to determine whether the EventSetup cache for that record has
    // been updated since this Product was lasted updated.

    std::vector<unsigned long long> cacheIDs_;
  };
}  // namespace edm
#endif