BranchType.h

Go to the documentation of this file.

#ifndef canvas_Persistency_Provenance_BranchType_h
#define canvas_Persistency_Provenance_BranchType_h

// ======================================================================
//
// BranchType: enumerate/encode/label the three Branch types
//
// ======================================================================

#include <iosfwd>
#include <string>
#include <type_traits>

// ----------------------------------------------------------------------

namespace art {

  // Note: These enum values are used as subscripts for a fixed size
  // array, so they must not change.
  enum BranchType { InEvent, InSubRun, InRun, InResults, NumBranchTypes };

  std::string const& BranchTypeToString(BranchType);
  std::string const& BranchTypeToProductTreeName(BranchType);
  std::string const& BranchTypeToMetaDataTreeName(BranchType);
  std::string const& BranchTypeToAuxiliaryBranchName(BranchType);
  std::string const& productProvenanceBranchName(BranchType);
  std::string const& BranchTypeToMajorIndexName(BranchType);
  std::string const& BranchTypeToMinorIndexName(BranchType);

  inline std::ostream&
  operator<<(std::ostream& os, BranchType const branchType)
  {
    return os << BranchTypeToString(branchType);
  }

  template <typename F>
  void
  for_each_branch_type(F f)
  {
    for (std::underlying_type<BranchType>::type i{InEvent}; i < NumBranchTypes;
         ++i) {
      auto const bt = static_cast<BranchType>(i);
      f(bt);
    }
  }

} // art

// ======================================================================

#endif /* canvas_Persistency_Provenance_BranchType_h */

// Local Variables:
// mode: c++
// End: