BranchDescription.h

Go to the documentation of this file.

#ifndef DataFormats_Provenance_BranchDescription_h
#define DataFormats_Provenance_BranchDescription_h

/*----------------------------------------------------------------------

BranchDescription: The full description of a Branch.
This description also applies to every product instance on the branch.

----------------------------------------------------------------------*/
#include "DataFormats/Provenance/interface/BranchID.h"
#include "DataFormats/Provenance/interface/BranchType.h"
#include "DataFormats/Provenance/interface/ParameterSetID.h"
#include "DataFormats/Provenance/interface/ProductID.h"
#include "DataFormats/Provenance/interface/ProvenanceFwd.h"
#include "FWCore/Utilities/interface/TypeID.h"
#include "FWCore/Reflection/interface/TypeWithDict.h"

#include <iosfwd>
#include <map>
#include <set>
#include <string>

/*
  BranchDescription

  definitions:
  The event-independent description of an EDProduct.

*/

namespace edm {
  class BranchDescription {
  public:
    static int const invalidSplitLevel = -1;
    static int const invalidBasketSize = 0;
    enum MatchMode { Strict = 0, Permissive };

    BranchDescription();

    BranchDescription(BranchType const& branchType,
                      std::string const& moduleLabel,
                      std::string const& processName,
                      std::string const& className,
                      std::string const& friendlyClassName,
                      std::string const& productInstanceName,
                      std::string const& moduleName,
                      ParameterSetID const& parameterSetID,
                      TypeWithDict const& theTypeWithDict,
                      bool produced = true,
                      bool availableOnlyAtEndTransition = false,
                      std::set<std::string> const& aliases = std::set<std::string>());

    BranchDescription(BranchDescription const& aliasForBranch,
                      std::string const& moduleLabelAlias,
                      std::string const& productInstanceAlias);

    ~BranchDescription() {}

    void init() {
      initBranchName();
      initFromDictionary();
    }

    void initBranchName();

    void initFromDictionary();

    void write(std::ostream& os) const;

    void merge(BranchDescription const& other);

    std::string const& moduleLabel() const { return moduleLabel_; }
    std::string const& processName() const { return processName_; }
    BranchID const& branchID() const { return branchID_; }
    BranchID const& aliasForBranchID() const { return aliasForBranchID_; }
    bool isAlias() const { return aliasForBranchID_.isValid() && produced(); }
    BranchID const& originalBranchID() const { return aliasForBranchID_.isValid() ? aliasForBranchID_ : branchID_; }
    std::string const& fullClassName() const { return fullClassName_; }
    std::string const& className() const { return fullClassName(); }
    std::string const& friendlyClassName() const { return friendlyClassName_; }
    std::string const& productInstanceName() const { return productInstanceName_; }
    bool produced() const { return transient_.produced_; }
    void setProduced(bool isProduced) { transient_.produced_ = isProduced; }
    bool isTransform() const { return transient_.isTransform_; }
    void setIsTransform(bool isTransform) { transient_.isTransform_ = isTransform; }
    bool present() const { return !transient_.dropped_; }
    bool dropped() const { return transient_.dropped_; }
    void setDropped(bool isDropped) { transient_.dropped_ = isDropped; }
    //returns true if unscheduled (produced()==true) or using delayed reader (produced()==false)
    bool onDemand() const { return transient_.onDemand_; }
    void setOnDemand(bool isOnDemand) { transient_.onDemand_ = isOnDemand; }
    bool availableOnlyAtEndTransition() const { return transient_.availableOnlyAtEndTransition_; }
    bool transient() const { return transient_.transient_; }
    void setTransient(bool isTransient) { transient_.transient_ = isTransient; }
    TypeWithDict const& wrappedType() const { return transient_.wrappedType_; }
    void setWrappedType(TypeWithDict const& type) { transient_.wrappedType_ = type; }
    TypeWithDict const& unwrappedType() const { return transient_.unwrappedType_; }
    void setUnwrappedType(TypeWithDict const& type) { transient_.unwrappedType_ = type; }
    TypeID wrappedTypeID() const { return TypeID(transient_.wrappedType_.typeInfo()); }
    TypeID unwrappedTypeID() const { return TypeID(transient_.unwrappedType_.typeInfo()); }
    int splitLevel() const { return transient_.splitLevel_; }
    void setSplitLevel(int level) { transient_.splitLevel_ = level; }
    int basketSize() const { return transient_.basketSize_; }
    void setBasketSize(int size) { transient_.basketSize_ = size; }

    bool isSwitchAlias() const { return not transient_.switchAliasModuleLabel_.empty(); }
    std::string const& switchAliasModuleLabel() const { return transient_.switchAliasModuleLabel_; }
    void setSwitchAliasModuleLabel(std::string label) { transient_.switchAliasModuleLabel_ = std::move(label); }
    BranchID const& switchAliasForBranchID() const { return transient_.switchAliasForBranchID_; }
    void setSwitchAliasForBranch(BranchDescription const& aliasForBranch);

    bool isAnyAlias() const { return isAlias() or isSwitchAlias(); }

    bool isProvenanceSetOnRead() const noexcept { return transient_.isProvenanceSetOnRead_; }
    void setIsProvenanceSetOnRead(bool value = true) noexcept { transient_.isProvenanceSetOnRead_ = value; }

    ParameterSetID const& parameterSetID() const { return transient_.parameterSetID_; }
    std::string const& moduleName() const { return transient_.moduleName_; }

    std::set<std::string> const& branchAliases() const { return branchAliases_; }
    void insertBranchAlias(std::string const& alias) { branchAliases_.insert(alias); }
    std::string const& branchName() const { return transient_.branchName_; }
    void clearBranchName() { transient_.branchName_.clear(); }
    BranchType const& branchType() const { return branchType_; }
    std::string const& wrappedName() const { return transient_.wrappedName_; }
    void setWrappedName(std::string const& name) { transient_.wrappedName_ = name; }

    bool isMergeable() const { return transient_.isMergeable_; }
    void setIsMergeable(bool v) { transient_.isMergeable_ = v; }

    void updateFriendlyClassName();

    void initializeTransients() { transient_.reset(); }

    struct Transients {
      Transients();

      void reset();

      // The parameter set id of the producer.
      // This is set if and only if produced_ is true.
      ParameterSetID parameterSetID_;

      // The module name of the producer.
      // This is set if and only if produced_ is true.
      std::string moduleName_;

      // The branch name, which is currently derivable from the other attributes.
      std::string branchName_;

      // The wrapped class name, which is currently derivable from the other attributes.
      std::string wrappedName_;

      // For SwitchProducer alias, the label of the aliased-for label; otherwise empty
      std::string switchAliasModuleLabel_;

      // Need a separate (transient) BranchID for switch, because
      // otherwise originalBranchID() gives wrong answer when reading
      // from a file (leading to wrong ProductProvenance to be retrieved)
      BranchID switchAliasForBranchID_;

      // A TypeWithDict object for the wrapped object
      // This is set if and only if the dropped_ is false
      TypeWithDict wrappedType_;

      // A TypeWithDict object for the unwrapped object
      // This is set if and only if the dropped_ is false
      TypeWithDict unwrappedType_;

      // The split level of the branch, as marked
      // in the data dictionary.
      int splitLevel_;

      // The basket size of the branch, as marked
      // in the data dictionary.
      int basketSize_;

      // Was this branch produced in this process rather than in a previous process
      bool produced_;

      // Was this branch produced in this current process and by unscheduled production
      // This item is set only in the framework, not by FWLite.
      bool onDemand_;

      // Was this branch produced in this current process via the transform ability
      bool isTransform_;

      // Has the branch been dropped from the product tree in this file
      // (or if this is a merged product registry, in the first file).
      // This item is set only in the framework, not by FWLite.
      bool dropped_;

      // Is the class of the branch marked as transient
      // in the data dictionary
      bool transient_;

      // if Run or Lumi based, can only get at end transition
      bool availableOnlyAtEndTransition_;

      // True if the product definition has a mergeProduct function
      // and the branchType is Run or Lumi
      bool isMergeable_;

      // True if provenance is set on call from input on read
      bool isProvenanceSetOnRead_ = false;
    };

  private:
    void throwIfInvalid_() const;

    // What tree is the branch in?
    BranchType branchType_;

    // A human friendly string that uniquely identifies the EDProducer
    // and becomes part of the identity of a product that it produces
    std::string moduleLabel_;

    // the physical process that this program was part of (e.g. production)
    std::string processName_;

    // An ID uniquely identifying the branch
    BranchID branchID_;

    // the full name of the type of product this is
    std::string fullClassName_;

    // a readable name of the type of product this is
    std::string friendlyClassName_;

    // a user-supplied name to distinguish multiple products of the same type
    // that are produced by the same producer
    std::string productInstanceName_;

    // The branch ROOT alias(es), which are settable by the user.
    std::set<std::string> branchAliases_;

    // If this branch *is* an EDAlias, this field is the BranchID
    // of the branch for which this branch is an alias.
    // If this branch is not an EDAlias, the normal case, this field is 0.
    BranchID aliasForBranchID_;

    Transients transient_;
  };

  inline std::ostream& operator<<(std::ostream& os, BranchDescription const& p) {
    p.write(os);
    return os;
  }

  bool operator<(BranchDescription const& a, BranchDescription const& b);

  bool operator==(BranchDescription const& a, BranchDescription const& b);

  bool combinable(BranchDescription const& a, BranchDescription const& b);

  std::string match(BranchDescription const& a, BranchDescription const& b, std::string const& fileName);
}  // namespace edm
#endif