art::SummedValue< T > Class Template Reference

#include "SummedValue.h"

Public Member Functions
template<typename H >
std::enable_if_t< detail::is_handle_v< H > >	update (H const &h)
template<typename H >
std::enable_if_t< detail::is_handle_v< H > >	update (H const &h, T const &t)
void	clear ()
bool	isValid () const
T const &	value () const
RangeSet const &	rangeOfValidity () const

Private Member Functions
template<typename H >
void	update_impl (H const &h, T const &t)

Private Attributes
T	value_ {}
RangeSet	rangeOfValidity_ {RangeSet::invalid()}

Detailed Description

template<typename T>
class art::SummedValue< T >

Definition at line 58 of file SummedValue.h.

Member Function Documentation

template<typename T >

void art::SummedValue< T >::clear ( )

inline

Definition at line 157 of file SummedValue.h.

References tmp.

  {
    SummedValue<T> tmp{};
    std::swap(*this, tmp);
  }

template<typename T >

bool art::SummedValue< T >::isValid ( ) const

inline

Definition at line 165 of file SummedValue.h.

References art::RangeSet::is_valid(), and art::SummedValue< T >::rangeOfValidity_.

  {
    return rangeOfValidity_.is_valid();
  }

template<typename T >

RangeSet const & art::SummedValue< T >::rangeOfValidity

(

)

const

Definition at line 179 of file SummedValue.h.

References art::SummedValue< T >::rangeOfValidity_.

Referenced by art::disjoint_ranges(), art::overlapping_ranges(), and art::same_ranges().

  {
    return rangeOfValidity_;
  }

template<typename T >

template<typename H >

std::enable_if_t< detail::is_handle_v< H > > art::SummedValue< T >::update

(

H const &

h

)

Definition at line 134 of file SummedValue.h.

References art::detail::throw_if_invalid(), and art::SummedValue< T >::update_impl().

  {
    std::string const& errMsg{"Attempt to update " +
                              cet::demangle_symbol(typeid(*this).name()) +
                              " from an invalid handle."};
    detail::throw_if_invalid(errMsg, h);
    update_impl(h, *h);
  }

template<typename T>

template<typename H >

std::enable_if_t< detail::is_handle_v< H > > art::SummedValue< T >::update	(	H const &	h,
		T const &	t
	)

Definition at line 146 of file SummedValue.h.

References art::detail::throw_if_invalid(), and art::SummedValue< T >::update_impl().

  {
    std::string const& errMsg{"Attempt to update " +
                              cet::demangle_symbol(typeid(*this).name()) +
                              " from an invalid handle.\n"};
    detail::throw_if_invalid(errMsg, h);
    update_impl(h, t);
  }

template<typename T>

template<typename H >

void art::SummedValue< T >::update_impl ( H const &  h, T const &  t  )

inlineprivate

Definition at line 84 of file SummedValue.h.

Referenced by art::SummedValue< T >::update().

    {
      // Precondition: handle must be valid
      assert(h.isValid());

      auto const& newRS = h.provenance()->rangeOfValidity();
      if (!rangeOfValidity_.is_valid() && newRS.is_valid()) {
        rangeOfValidity_ = newRS;
        value_ = t;
      } else if (art::disjoint_ranges(rangeOfValidity_, newRS)) {
        if (rangeOfValidity_.run() != newRS.run()) {
          throw Exception{errors::ProductCannotBeAggregated,
                          "SummedValue<T>::update"}
            << "\nThe following ranges corresponding to the type:\n"
            << "   '" << cet::demangle_symbol(typeid(T).name()) << "'"
            << "\nhave different run numbers (" << rangeOfValidity_.run()
            << " vs. " << newRS.run() << ") and cannot be aggregated.\n"
            << "Please contact artists@fnal.gov.\n";
        }
        detail::CanBeAggregated<T>::aggregate(value_, t);
        rangeOfValidity_.merge(h.provenance()->rangeOfValidity());
      } else if (art::same_ranges(rangeOfValidity_, newRS)) {
        // The ranges are the same, so the behavior is a NOP.
        // However, we will probably never get here because of the
        // seenIDs set, which prevents duplicate aggregation.  If the
        // stakeholders decide that products with the same ranges
        // should be checked for equality, then the seenIDs set needs
        // to go away, and an extra condition will be added here.
      } else if (art::overlapping_ranges(rangeOfValidity_, newRS)) {
        throw Exception{errors::ProductCannotBeAggregated,
                        "SummedValue<T>::update"}
          << "\nThe following ranges corresponding to the type:\n"
          << "   '" << cet::demangle_symbol(typeid(T).name()) << "'"
          << "\ncannot be aggregated\n"
          << rangeOfValidity_ << " and\n"
          << newRS << "\nPlease contact artists@fnal.gov.\n";
      }
      // NOP when both RangeSets are invalid
    }

template<typename T >

T const & art::SummedValue< T >::value ( ) const

inline

Definition at line 172 of file SummedValue.h.

References art::SummedValue< T >::value_.

  {
    return value_;
  }

Member Data Documentation

template<typename T>

RangeSet art::SummedValue< T >::rangeOfValidity_ {RangeSet::invalid()}

private

Definition at line 125 of file SummedValue.h.

Referenced by art::SummedValue< T >::isValid(), art::SummedValue< T >::rangeOfValidity(), and art::SummedValue< sumdata::POTSummary >::update_impl().

template<typename T>

T art::SummedValue< T >::value_ {}

private

Definition at line 124 of file SummedValue.h.

Referenced by art::SummedValue< sumdata::POTSummary >::update_impl(), and art::SummedValue< T >::value().

---

The documentation for this class was generated from the following file:

• art/Framework/Principal/SummedValue.h