edm::BranchDescription Class Reference

#include <BranchDescription.h>

Classes
struct	Transients

Public Types
enum	MatchMode { Strict = 0, Permissive }

Public Member Functions
BranchID const &	aliasForBranchID () const
bool	availableOnlyAtEndTransition () const
int	basketSize () const
std::set< std::string > const &	branchAliases () const
	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)
BranchID const &	branchID () const
std::string const &	branchName () const
BranchType const &	branchType () const
std::string const &	className () const
void	clearBranchName ()
bool	dropped () const
std::string const &	friendlyClassName () const
std::string const &	fullClassName () const
void	init ()
void	initBranchName ()
void	initFromDictionary ()
void	initializeTransients ()
void	insertBranchAlias (std::string const &alias)
bool	isAlias () const
bool	isAnyAlias () const
bool	isMergeable () const
bool	isProvenanceSetOnRead () const noexcept
bool	isSwitchAlias () const
bool	isTransform () const
void	merge (BranchDescription const &other)
std::string const &	moduleLabel () const
std::string const &	moduleName () const
bool	onDemand () const
BranchID const &	originalBranchID () const
ParameterSetID const &	parameterSetID () const
bool	present () const
std::string const &	processName () const
bool	produced () const
std::string const &	productInstanceName () const
void	setBasketSize (int size)
void	setDropped (bool isDropped)
void	setIsMergeable (bool v)
void	setIsProvenanceSetOnRead (bool value=true) noexcept
void	setIsTransform (bool isTransform)
void	setOnDemand (bool isOnDemand)
void	setProduced (bool isProduced)
void	setSplitLevel (int level)
void	setSwitchAliasForBranch (BranchDescription const &aliasForBranch)
void	setSwitchAliasModuleLabel (std::string label)
void	setTransient (bool isTransient)
void	setUnwrappedType (TypeWithDict const &type)
void	setWrappedName (std::string const &name)
void	setWrappedType (TypeWithDict const &type)
int	splitLevel () const
BranchID const &	switchAliasForBranchID () const
std::string const &	switchAliasModuleLabel () const
bool	transient () const
TypeWithDict const &	unwrappedType () const
TypeID	unwrappedTypeID () const
void	updateFriendlyClassName ()
std::string const &	wrappedName () const
TypeWithDict const &	wrappedType () const
TypeID	wrappedTypeID () const
void	write (std::ostream &os) const
	~BranchDescription ()

Static Public Attributes
static int const	invalidBasketSize = 0
static int const	invalidSplitLevel = -1

Private Member Functions
void	throwIfInvalid_ () const

Private Attributes
BranchID	aliasForBranchID_
std::set< std::string >	branchAliases_
BranchID	branchID_
BranchType	branchType_
std::string	friendlyClassName_
std::string	fullClassName_
std::string	moduleLabel_
std::string	processName_
std::string	productInstanceName_
Transients	transient_

Detailed Description

Definition at line 32 of file BranchDescription.h.

Member Enumeration Documentation

MatchMode

enum edm::BranchDescription::MatchMode

Enumerator
Strict
Permissive

Definition at line 36 of file BranchDescription.h.

{ Strict = 0, Permissive };

Constructor & Destructor Documentation

BranchDescription() [1/3]

edm::BranchDescription::BranchDescription

(

)

Definition at line 38 of file BranchDescription.cc.

      : branchType_(InEvent),
        moduleLabel_(),
        processName_(),
        branchID_(),
        fullClassName_(),
        friendlyClassName_(),
        productInstanceName_(),
        branchAliases_(),
        aliasForBranchID_(),
        transient_() {
    // do not call init here! It will result in an exception throw.
  }

BranchDescription() [2/3]

edm::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>()
	)

Definition at line 52 of file BranchDescription.cc.

References availableOnlyAtEndTransition(), edm::BranchDescription::Transients::availableOnlyAtEndTransition_, init(), moduleName(), edm::BranchDescription::Transients::moduleName_, parameterSetID(), edm::BranchDescription::Transients::parameterSetID_, produced(), setDropped(), setOnDemand(), setProduced(), setUnwrappedType(), and transient_.

      : branchType_(branchType),
        moduleLabel_(moduleLabel),
        processName_(processName),
        branchID_(),
        fullClassName_(className),
        friendlyClassName_(friendlyClassName),
        productInstanceName_(productInstanceName),
        branchAliases_(aliases),
        transient_() {
    setDropped(false);
    setProduced(produced);
    setOnDemand(false);
    transient_.moduleName_ = moduleName;
    transient_.parameterSetID_ = parameterSetID;
    transient_.availableOnlyAtEndTransition_ = availableOnlyAtEndTransition;
    setUnwrappedType(theTypeWithDict);
    init();
  }

BranchDescription() [3/3]

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

Definition at line 83 of file BranchDescription.cc.

References availableOnlyAtEndTransition(), edm::BranchDescription::Transients::availableOnlyAtEndTransition_, init(), moduleName(), edm::BranchDescription::Transients::moduleName_, parameterSetID(), edm::BranchDescription::Transients::parameterSetID_, produced(), setDropped(), setOnDemand(), setProduced(), setUnwrappedType(), transient_, and unwrappedType().

      : branchType_(aliasForBranch.branchType()),
        moduleLabel_(moduleLabelAlias),
        processName_(aliasForBranch.processName()),
        branchID_(),
        fullClassName_(aliasForBranch.className()),
        friendlyClassName_(aliasForBranch.friendlyClassName()),
        productInstanceName_(productInstanceAlias),
        branchAliases_(aliasForBranch.branchAliases()),
        aliasForBranchID_(aliasForBranch.branchID()),
        transient_() {
    setDropped(false);
    setProduced(aliasForBranch.produced());
    setOnDemand(false);  // will be re-set externally to the aliasForBranch.onDemand() after that one has been set
    transient_.availableOnlyAtEndTransition_ = aliasForBranch.availableOnlyAtEndTransition();
    transient_.moduleName_ = aliasForBranch.moduleName();
    transient_.parameterSetID_ = aliasForBranch.parameterSetID();
    setUnwrappedType(aliasForBranch.unwrappedType());
    init();
  }

~BranchDescription()

edm::BranchDescription::~BranchDescription ( )

inline

Definition at line 57 of file BranchDescription.h.

{}

Member Function Documentation

aliasForBranchID()

BranchID const& edm::BranchDescription::aliasForBranchID ( ) const

inline

Definition at line 75 of file BranchDescription.h.

References aliasForBranchID_.

{ return aliasForBranchID_; }

availableOnlyAtEndTransition()

bool edm::BranchDescription::availableOnlyAtEndTransition ( ) const

inline

Definition at line 92 of file BranchDescription.h.

References edm::BranchDescription::Transients::availableOnlyAtEndTransition_, and transient_.

Referenced by BranchDescription(), and setSwitchAliasForBranch().

{ return transient_.availableOnlyAtEndTransition_; }

basketSize()

int edm::BranchDescription::basketSize ( ) const

inline

Definition at line 103 of file BranchDescription.h.

References edm::BranchDescription::Transients::basketSize_, and transient_.

Referenced by initFromDictionary(), and merge().

{ return transient_.basketSize_; }

branchAliases()

std::set<std::string> const& edm::BranchDescription::branchAliases ( ) const

inline

Definition at line 120 of file BranchDescription.h.

References branchAliases_.

Referenced by edm::StableProvenance::branchAliases(), edm::RootOutputFile::setBranchAliases(), and setSwitchAliasForBranch().

{ return branchAliases_; }

branchID()

BranchID const& edm::BranchDescription::branchID ( ) const

inline

Definition at line 74 of file BranchDescription.h.

References branchID_.

Referenced by edm::ProductRegistry::addLabelAlias(), edm::Principal::addProduct_(), edm::Principal::adjustIndexesAfterProductRegistryAddition(), edm::StableProvenance::branchID(), edm::StreamedProduct::branchID(), edm::PoolOutputModule::OutputItem::branchID(), edm::check(), fwlite::DataGetterHelper::getByBranchDescription(), edm::Principal::getExistingProduct(), edm::EventPrincipal::put(), edm::Principal::put_(), edm::EventPrincipal::putOnRead(), edm::RunPrincipal::putOrMerge(), edm::streamer::StreamerInputSource::read(), edm::DaqProvenanceHelper::saveInfo(), edm::ProvenanceCheckerOutputModule::write(), and write().

{ return branchID_; }

branchName()

std::string const& edm::BranchDescription::branchName ( ) const

inline

Definition at line 122 of file BranchDescription.h.

References edm::BranchDescription::Transients::branchName_, and transient_.

Referenced by edm::StableProvenance::branchName(), edm::PoolOutputModule::OutputItem::branchName(), edm::DataManagingProductResolver::checkType(), BareRootProductGetterBase::createNewBuffer(), edm::streamer::dumpInitVerbose(), edm::Principal::getExistingProduct(), edm::root::FWLiteDelayedReader::getTheProduct(), initBranchName(), initFromDictionary(), edm::MergeableInputProductResolver::mergeProduct(), edm::PoolOutputModule::OutputItem::Sorter::operator()(), edm::PutOnReadInputProductResolver::putProduct(), edm::ProducedProductResolver::putProduct(), edm::SwitchProducerProductResolver::putProduct(), edm::DelayedReaderInputProductResolver::retrieveAndMerge_(), edm::RootFile::RootFile(), edm::RootOutputFile::setBranchAliases(), and edm::StreamedProduct::StreamedProduct().

{ return transient_.branchName_; }

branchType()

BranchType const& edm::BranchDescription::branchType ( ) const

inline

Definition at line 124 of file BranchDescription.h.

References branchType_.

Referenced by edm::ProductRegistry::addProduct(), edm::Principal::adjustIndexesAfterProductRegistryAddition(), edm::Principal::adjustToNewProductRegistry(), l1t::L1TGlobalUtilHelper::checkToUpdateTags(), L1GtUtilsHelper::checkToUpdateTags(), edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), edm::WillGetIfMatch< T >::operator()(), edm::GetterOfProducts< edmtest::ThingCollection >::operator()(), edm::Principal::Principal(), edm::DelayedReaderInputProductResolver::retrieveAndMerge_(), edm::RootOutputFile::setBranchAliases(), setSwitchAliasForBranch(), edm::SwitchProducer::SwitchProducer(), and write().

{ return branchType_; }

className()

std::string const& edm::BranchDescription::className ( ) const

inline

Definition at line 79 of file BranchDescription.h.

References fullClassName().

Referenced by edm::SignallingProductRegistry::addCalled(), edm::Principal::addProduct_(), edm::DataManagingProductResolver::checkType(), edm::StableProvenance::className(), BareRootProductGetterBase::createNewBuffer(), edm::EventContentAnalyzer::EventContentAnalyzer(), and edm::root::FWLiteDelayedReader::getTheProduct().

{ return fullClassName(); }

clearBranchName()

void edm::BranchDescription::clearBranchName ( )

inline

Definition at line 123 of file BranchDescription.h.

References edm::BranchDescription::Transients::branchName_, and transient_.

Referenced by updateFriendlyClassName().

{ transient_.branchName_.clear(); }

dropped()

bool edm::BranchDescription::dropped ( ) const

inline

Definition at line 87 of file BranchDescription.h.

References edm::BranchDescription::Transients::dropped_, and transient_.

Referenced by edm::SignallingProductRegistry::addCalled(), l1t::L1TGlobalUtilHelper::checkToUpdateTags(), L1GtUtilsHelper::checkToUpdateTags(), HLTJetTag< T >::hltFilter(), and edm::GetterOfProducts< edmtest::ThingCollection >::operator()().

{ return transient_.dropped_; }

friendlyClassName()

std::string const& edm::BranchDescription::friendlyClassName ( ) const

inline

Definition at line 80 of file BranchDescription.h.

References friendlyClassName_.

Referenced by edm::Principal::addProduct_(), edm::Principal::addProductOrThrow(), edm::StableProvenance::friendlyClassName(), initBranchName(), and write().

{ return friendlyClassName_; }

fullClassName()

std::string const& edm::BranchDescription::fullClassName ( ) const

inline

Definition at line 78 of file BranchDescription.h.

References fullClassName_.

Referenced by className(), fwlite::DataGetterHelper::getByBranchDescription(), initFromDictionary(), edm::RootOutputFile::RootOutputFile(), updateFriendlyClassName(), and write().

{ return fullClassName_; }

init()

void edm::BranchDescription::init ( void  )

inline

Definition at line 59 of file BranchDescription.h.

References initBranchName(), and initFromDictionary().

Referenced by BranchDescription(), edm::streamer::dumpInitVerbose(), and edm::test::TestProcessor::TestProcessor().

                {
      initBranchName();
      initFromDictionary();
    }

initBranchName()

void edm::BranchDescription::initBranchName

(

)

Definition at line 106 of file BranchDescription.cc.

References branchID_, branchName(), edm::BranchDescription::Transients::branchName_, relativeConstraints::empty, Exception, friendlyClassName(), friendlyClassName_, edm::BranchID::isValid(), moduleLabel(), l1tstage2_dqm_sourceclient-live_cfg::period, processName(), processName_, productInstanceName(), productInstanceName_, edm::BranchID::setID(), AlCaHLTBitMon_QueryRunRegistry::string, throwIfInvalid_(), and transient_.

Referenced by init(), edm::StreamedProduct::StreamedProduct(), and updateFriendlyClassName().

                                         {
    if (!branchName().empty()) {
      return;  // already called
    }
    throwIfInvalid_();

    char const underscore('_');
    char const period('.');

    if (friendlyClassName_.find(underscore) != std::string::npos) {
      throw cms::Exception("IllegalCharacter")
          << "Class name '" << friendlyClassName()
          << "' contains an underscore ('_'), which is illegal in the name of a product.\n";
    }

    // Module labels of non-persistent products are allowed to contain
    // underscores. For module labels of persistent products, the module
    // label is checked for underscores in the function initFromDictionary
    // after we determine whether the product is persistent or not.

    if (productInstanceName_.find(underscore) != std::string::npos) {
      throw cms::Exception("IllegalCharacter")
          << "Product instance name '" << productInstanceName()
          << "' contains an underscore ('_'), which is illegal in a product instance name.\n";
    }

    if (processName_.find(underscore) != std::string::npos) {
      throw cms::Exception("IllegalCharacter")
          << "Process name '" << processName()
          << "' contains an underscore ('_'), which is illegal in a process name.\n";
    }

    std::string& brName = transient_.branchName_;
    brName.reserve(friendlyClassName().size() + moduleLabel().size() + productInstanceName().size() +
                   processName().size() + 4);
    brName += friendlyClassName();
    brName += underscore;
    brName += moduleLabel();
    brName += underscore;
    brName += productInstanceName();
    brName += underscore;
    brName += processName();
    brName += period;

    if (!branchID_.isValid()) {
      branchID_.setID(brName);
    }
  }

initFromDictionary()

void edm::BranchDescription::initFromDictionary

(

)

Definition at line 155 of file BranchDescription.cc.

References cms::Exception::addContext(), basketSize(), branchName(), edm::TypeWithDict::byName(), Exception, fullClassName(), edm::TypeWithDict::getClass(), invalidBasketSize, invalidSplitLevel, moduleLabel(), moduleLabel_, setBasketSize(), setSplitLevel(), setTransient(), setUnwrappedType(), setWrappedName(), setWrappedType(), splitLevel(), AlCaHLTBitMon_QueryRunRegistry::string, throwIfInvalid_(), unwrappedType(), l1tPFClustersFromHGC3DClusters_cfi::wp, edm::wrappedClassName(), wrappedName(), and wrappedType().

Referenced by init().

                                             {
    if (bool(wrappedType())) {
      return;  // already initialized;
    }

    throwIfInvalid_();

    try {
      setWrappedName(wrappedClassName(fullClassName()));
      // unwrapped type.
      setUnwrappedType(TypeWithDict::byName(fullClassName()));
      if (!bool(unwrappedType())) {
        setSplitLevel(invalidSplitLevel);
        setBasketSize(invalidBasketSize);
        setTransient(false);
        return;
      }
    } catch (edm::Exception& caughtException) {
      caughtException.addContext(std::string{"While initializing meta data for branch: "} + branchName());
      throw;
    }

    edm::TypeWithDict wrType(TypeWithDict::byName(wrappedName()));
    try {
      setWrappedType(wrType);
      if (!bool(wrappedType())) {
        setSplitLevel(invalidSplitLevel);
        setBasketSize(invalidBasketSize);
        return;
      }
    } catch (edm::Exception& caughtException) {
      caughtException.addContext(std::string{"While initializing meta data for branch: "} + branchName());
      throw;
    }

    setTransient(false);
    setSplitLevel(invalidSplitLevel);
    setBasketSize(invalidBasketSize);
    TDictAttributeMap* wp = wrappedType().getClass()->GetAttributeMap();
    if (wp && wp->HasKey("persistent") && !strcmp(wp->GetPropertyAsString("persistent"), "false")) {
      // Set transient if persistent == "false".
      setTransient(true);
      return;
    } else {
      // Module labels of persistent products cannot contain underscores,
      // but for non-persistent products it is allowed because path names
      // are used as module labels for path status products and there
      // are many path names that include underscores.
      char const underscore('_');
      if (moduleLabel_.find(underscore) != std::string::npos) {
        throw cms::Exception("IllegalCharacter")
            << "Module label '" << moduleLabel()
            << "' contains an underscore ('_'), which is illegal in a module label.\n";
      }
    }

    if (wp && wp->HasKey("splitLevel")) {
      setSplitLevel(strtol(wp->GetPropertyAsString("splitLevel"), nullptr, 0));
      if (splitLevel() < 0) {
        throw cms::Exception("IllegalSplitLevel") << "' An illegal ROOT split level of " << splitLevel()
                                                  << " is specified for class " << wrappedName() << ".'\n";
      }
      setSplitLevel(splitLevel() + 1);  //Compensate for wrapper
    }
    if (wp && wp->HasKey("basketSize")) {
      setBasketSize(strtol(wp->GetPropertyAsString("basketSize"), nullptr, 0));
      if (basketSize() <= 0) {
        throw cms::Exception("IllegalBasketSize") << "' An illegal ROOT basket size of " << basketSize()
                                                  << " is specified for class " << wrappedName() << "'.\n";
      }
    }
  }

initializeTransients()

void edm::BranchDescription::initializeTransients ( )

inline

Definition at line 133 of file BranchDescription.h.

References edm::BranchDescription::Transients::reset(), and transient_.

{ transient_.reset(); }

insertBranchAlias()

void edm::BranchDescription::insertBranchAlias ( std::string const &  alias )

inline

Definition at line 121 of file BranchDescription.h.

References isoTrack_cff::alias, and branchAliases_.

{ branchAliases_.insert(alias); }

isAlias()

bool edm::BranchDescription::isAlias ( ) const

inline

Definition at line 76 of file BranchDescription.h.

References aliasForBranchID_, edm::BranchID::isValid(), and produced().

Referenced by isAnyAlias(), and edm::Principal::Principal().

{ return aliasForBranchID_.isValid() && produced(); }

isAnyAlias()

bool edm::BranchDescription::isAnyAlias ( ) const

inline

Definition at line 112 of file BranchDescription.h.

References isAlias(), isSwitchAlias(), and or.

Referenced by GlobalRecHitsAnalyzer::GlobalRecHitsAnalyzer(), and edm::TypeMatch::operator()().

{ return isAlias() or isSwitchAlias(); }

isMergeable()

bool edm::BranchDescription::isMergeable ( ) const

inline

Definition at line 128 of file BranchDescription.h.

References edm::BranchDescription::Transients::isMergeable_, and transient_.

{ return transient_.isMergeable_; }

isProvenanceSetOnRead()

bool edm::BranchDescription::isProvenanceSetOnRead ( ) const

inlinenoexcept

Definition at line 114 of file BranchDescription.h.

References edm::BranchDescription::Transients::isProvenanceSetOnRead_, and transient_.

{ return transient_.isProvenanceSetOnRead_; }

isSwitchAlias()

bool edm::BranchDescription::isSwitchAlias ( ) const

inline

Definition at line 106 of file BranchDescription.h.

References edm::BranchDescription::Transients::switchAliasModuleLabel_, and transient_.

Referenced by isAnyAlias(), and edm::Principal::Principal().

{ return not transient_.switchAliasModuleLabel_.empty(); }

isTransform()

bool edm::BranchDescription::isTransform ( ) const

inline

Definition at line 84 of file BranchDescription.h.

References edm::BranchDescription::Transients::isTransform_, and transient_.

Referenced by edm::Principal::Principal(), and setIsTransform().

{ return transient_.isTransform_; }

merge()

void edm::BranchDescription::merge

(

BranchDescription const &

other

)

Definition at line 228 of file BranchDescription.cc.

References basketSize(), branchAliases_, invalidBasketSize, invalidSplitLevel, trackingPlots::other, setBasketSize(), setSplitLevel(), and splitLevel().

                                                              {
    branchAliases_.insert(other.branchAliases().begin(), other.branchAliases().end());
    if (splitLevel() == invalidSplitLevel)
      setSplitLevel(other.splitLevel());
    if (basketSize() == invalidBasketSize)
      setBasketSize(other.basketSize());
  }

moduleLabel()

std::string const& edm::BranchDescription::moduleLabel ( ) const

inline

Definition at line 72 of file BranchDescription.h.

References moduleLabel_.

Referenced by edm::SignallingProductRegistry::addCalled(), edm::ProductRegistry::addLabelAlias(), edm::Principal::addProduct_(), edm::Principal::addProductOrThrow(), edm::check(), edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), edm::DaqProvenanceHelper::DaqProvenanceHelper(), EcalDeadCellTriggerPrimitiveFilter::EcalDeadCellTriggerPrimitiveFilter(), edm::EventContentAnalyzer::EventContentAnalyzer(), edm::LHEProvenanceHelper::fillCommonProcessParameterSet(), fwlite::DataGetterHelper::getByBranchDescription(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), initBranchName(), initFromDictionary(), L3TkMuonProducer::L3TkMuonProducer(), edm::StableProvenance::moduleLabel(), edm::ProductResolverBase::moduleLabel(), edm::ModuleLabelMatch::operator()(), edm::InputTagMatch::operator()(), edm::WillGetIfMatch< T >::operator()(), edm::Principal::Principal(), edm::RootOutputFile::RootOutputFile(), edm::RootOutputFile::setBranchAliases(), edm::SwitchProducer::SwitchProducer(), edm::AsciiOutputModule::write(), and write().

{ return moduleLabel_; }

moduleName()

std::string const& edm::BranchDescription::moduleName ( ) const

inline

Definition at line 118 of file BranchDescription.h.

References edm::BranchDescription::Transients::moduleName_, and transient_.

Referenced by BranchDescription(), edm::DaqProvenanceHelper::DaqProvenanceHelper(), edm::LHEProvenanceHelper::fillCommonProcessParameterSet(), and edm::StableProvenance::moduleName().

{ return transient_.moduleName_; }

onDemand()

bool edm::BranchDescription::onDemand ( ) const

inline

Definition at line 90 of file BranchDescription.h.

References edm::BranchDescription::Transients::onDemand_, and transient_.

Referenced by edm::Principal::adjustIndexesAfterProductRegistryAddition(), and edm::Principal::Principal().

{ return transient_.onDemand_; }

originalBranchID()

BranchID const& edm::BranchDescription::originalBranchID ( ) const

inline

Definition at line 77 of file BranchDescription.h.

References aliasForBranchID_, branchID_, and edm::BranchID::isValid().

Referenced by edmtest::TestParentage::analyze(), edm::StableProvenance::originalBranchID(), setSwitchAliasForBranch(), and edm::SwitchBaseProductResolver::SwitchBaseProductResolver().

{ return aliasForBranchID_.isValid() ? aliasForBranchID_ : branchID_; }

parameterSetID()

ParameterSetID const& edm::BranchDescription::parameterSetID ( ) const

inline

Definition at line 117 of file BranchDescription.h.

References edm::BranchDescription::Transients::parameterSetID_, and transient_.

Referenced by BranchDescription(), and throwIfInvalid_().

{ return transient_.parameterSetID_; }

present()

bool edm::BranchDescription::present ( ) const

inline

Definition at line 86 of file BranchDescription.h.

References edm::BranchDescription::Transients::dropped_, and transient_.

{ return !transient_.dropped_; }

processName()

std::string const& edm::BranchDescription::processName ( ) const

inline

Definition at line 73 of file BranchDescription.h.

References processName_.

Referenced by edm::ProductRegistry::addProduct(), edm::Principal::addProduct_(), edm::Principal::addProductOrThrow(), edm::check(), edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), edm::DaqProvenanceHelper::daqInit(), edm::DaqProvenanceHelper::DaqProvenanceHelper(), edm::EventContentAnalyzer::EventContentAnalyzer(), edm::LHEProvenanceHelper::fillCommonProcessParameterSet(), fwlite::DataGetterHelper::getByBranchDescription(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), initBranchName(), L3TkMuonProducer::L3TkMuonProducer(), edm::LHEProvenanceHelper::lheInit(), edm::ProcessMatch::operator()(), edm::InputTagMatch::operator()(), edm::WillGetIfMatch< T >::operator()(), edm::Principal::Principal(), edm::StableProvenance::processName(), edm::ProductResolverBase::processName(), edm::RootOutputFile::RootOutputFile(), edm::DaqProvenanceHelper::saveInfo(), edm::RootOutputFile::setBranchAliases(), edm::SwitchProducer::SwitchProducer(), edm::AsciiOutputModule::write(), and write().

{ return processName_; }

produced()

bool edm::BranchDescription::produced ( ) const

inline

Definition at line 82 of file BranchDescription.h.

References edm::BranchDescription::Transients::produced_, and transient_.

Referenced by edm::ProductRegistry::addLabelAlias(), edm::ProductRegistry::addProduct(), edm::Principal::adjustIndexesAfterProductRegistryAddition(), edm::Principal::adjustToNewProductRegistry(), BranchDescription(), edm::ProductRegistry::copyProduct(), isAlias(), edm::Principal::Principal(), edm::EventPrincipal::putOnRead(), setSwitchAliasForBranch(), and throwIfInvalid_().

{ return transient_.produced_; }

productInstanceName()

std::string const& edm::BranchDescription::productInstanceName ( ) const

inline

Definition at line 81 of file BranchDescription.h.

References productInstanceName_.

Referenced by edm::SignallingProductRegistry::addCalled(), edm::Principal::addProductOrThrow(), edm::check(), edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), edm::EventContentAnalyzer::EventContentAnalyzer(), fwlite::DataGetterHelper::getByBranchDescription(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), initBranchName(), L3TkMuonProducer::L3TkMuonProducer(), edm::InputTagMatch::operator()(), edm::WillGetIfMatch< T >::operator()(), edm::StableProvenance::productInstanceName(), edm::ProductResolverBase::productInstanceName(), edm::RootOutputFile::RootOutputFile(), edm::RootOutputFile::setBranchAliases(), edm::SwitchProducer::SwitchProducer(), and write().

{ return productInstanceName_; }

setBasketSize()

void edm::BranchDescription::setBasketSize ( int  size )

inline

Definition at line 104 of file BranchDescription.h.

References edm::BranchDescription::Transients::basketSize_, and transient_.

Referenced by initFromDictionary(), and merge().

{ transient_.basketSize_ = size; }

setDropped()

void edm::BranchDescription::setDropped ( bool  isDropped )

inline

Definition at line 88 of file BranchDescription.h.

References edm::BranchDescription::Transients::dropped_, and transient_.

Referenced by BranchDescription().

{ transient_.dropped_ = isDropped; }

setIsMergeable()

void edm::BranchDescription::setIsMergeable ( bool  v )

inline

Definition at line 129 of file BranchDescription.h.

References edm::BranchDescription::Transients::isMergeable_, transient_, and findQualityFiles::v.

{ transient_.isMergeable_ = v; }

setIsProvenanceSetOnRead()

void edm::BranchDescription::setIsProvenanceSetOnRead ( bool  value = true )

inlinenoexcept

Definition at line 115 of file BranchDescription.h.

References edm::BranchDescription::Transients::isProvenanceSetOnRead_, transient_, and relativeConstraints::value.

Referenced by edm::LHEProvenanceHelper::LHEProvenanceHelper(), and edmtest::PutOrMergeTestSource::registerProducts().

{ transient_.isProvenanceSetOnRead_ = value; }

setIsTransform()

void edm::BranchDescription::setIsTransform ( bool  isTransform )

inline

Definition at line 85 of file BranchDescription.h.

References isTransform(), edm::BranchDescription::Transients::isTransform_, and transient_.

{ transient_.isTransform_ = isTransform; }

setOnDemand()

void edm::BranchDescription::setOnDemand ( bool  isOnDemand )

inline

Definition at line 91 of file BranchDescription.h.

References edm::BranchDescription::Transients::onDemand_, and transient_.

Referenced by BranchDescription().

{ transient_.onDemand_ = isOnDemand; }

setProduced()

void edm::BranchDescription::setProduced ( bool  isProduced )

inline

Definition at line 83 of file BranchDescription.h.

References edm::BranchDescription::Transients::produced_, and transient_.

Referenced by BranchDescription().

{ transient_.produced_ = isProduced; }

setSplitLevel()

void edm::BranchDescription::setSplitLevel ( int  level )

inline

Definition at line 102 of file BranchDescription.h.

References gammaJetAnalysis_CHSJECs_cff::level, edm::BranchDescription::Transients::splitLevel_, and transient_.

Referenced by initFromDictionary(), and merge().

{ transient_.splitLevel_ = level; }

setSwitchAliasForBranch()

void edm::BranchDescription::setSwitchAliasForBranch

(

BranchDescription const &

aliasForBranch

)

Definition at line 236 of file BranchDescription.cc.

References availableOnlyAtEndTransition(), edm::BranchDescription::Transients::availableOnlyAtEndTransition_, branchAliases(), branchAliases_, branchType(), branchType_, Exception, edm::errors::LogicError, edm::TypeID::name(), originalBranchID(), produced(), edm::BranchDescription::Transients::switchAliasForBranchID_, transient_, edm::TypeWithDict::typeInfo(), unwrappedType(), and unwrappedTypeID().

                                                                                         {
    if (branchType_ != aliasForBranch.branchType()) {
      throw Exception(errors::LogicError) << "BranchDescription::setSwitchAliasForBranch: branchType (" << branchType_
                                          << ") differs from aliasForBranch (" << aliasForBranch.branchType()
                                          << ").\nPlease report this error to the FWCore developers";
    }
    if (produced() != aliasForBranch.produced()) {
      throw Exception(errors::LogicError) << "BranchDescription::setSwitchAliasForBranch: produced differs from "
                                             "aliasForBranch.\nPlease report this error to the FWCore developers";
    }
    if (unwrappedTypeID().typeInfo() != aliasForBranch.unwrappedType().typeInfo()) {
      throw Exception(errors::LogicError)
          << "BranchDescription::setSwitchAliasForBranch: unwrapped type info (" << unwrappedTypeID().name()
          << ") differs from aliasForBranch (" << aliasForBranch.unwrappedType().typeInfo().name()
          << ").\nPlease report this error to the FWCore developers";
    }

    branchAliases_ = aliasForBranch.branchAliases();
    transient_.switchAliasForBranchID_ = aliasForBranch.originalBranchID();
    transient_.availableOnlyAtEndTransition_ = aliasForBranch.availableOnlyAtEndTransition();
  }

setSwitchAliasModuleLabel()

void edm::BranchDescription::setSwitchAliasModuleLabel ( std::string  label )

inline

Definition at line 108 of file BranchDescription.h.

References label, eostools::move(), edm::BranchDescription::Transients::switchAliasModuleLabel_, and transient_.

{ transient_.switchAliasModuleLabel_ = std::move(label); }

setTransient()

void edm::BranchDescription::setTransient ( bool  isTransient )

inline

Definition at line 94 of file BranchDescription.h.

References edm::BranchDescription::Transients::transient_, and transient_.

Referenced by initFromDictionary().

{ transient_.transient_ = isTransient; }

setUnwrappedType()

void edm::BranchDescription::setUnwrappedType ( TypeWithDict const &  type )

inline

Definition at line 98 of file BranchDescription.h.

References transient_, and edm::BranchDescription::Transients::unwrappedType_.

Referenced by BranchDescription(), and initFromDictionary().

{ transient_.unwrappedType_ = type; }

setWrappedName()

void edm::BranchDescription::setWrappedName ( std::string const &  name )

inline

Definition at line 126 of file BranchDescription.h.

References mergeVDriftHistosByStation::name, transient_, and edm::BranchDescription::Transients::wrappedName_.

Referenced by initFromDictionary().

{ transient_.wrappedName_ = name; }

setWrappedType()

void edm::BranchDescription::setWrappedType ( TypeWithDict const &  type )

inline

Definition at line 96 of file BranchDescription.h.

References transient_, and edm::BranchDescription::Transients::wrappedType_.

Referenced by initFromDictionary().

{ transient_.wrappedType_ = type; }

splitLevel()

int edm::BranchDescription::splitLevel ( ) const

inline

Definition at line 101 of file BranchDescription.h.

References edm::BranchDescription::Transients::splitLevel_, and transient_.

Referenced by initFromDictionary(), and merge().

{ return transient_.splitLevel_; }

switchAliasForBranchID()

BranchID const& edm::BranchDescription::switchAliasForBranchID ( ) const

inline

Definition at line 109 of file BranchDescription.h.

References edm::BranchDescription::Transients::switchAliasForBranchID_, and transient_.

{ return transient_.switchAliasForBranchID_; }

switchAliasModuleLabel()

std::string const& edm::BranchDescription::switchAliasModuleLabel ( ) const

inline

Definition at line 107 of file BranchDescription.h.

References edm::BranchDescription::Transients::switchAliasModuleLabel_, and transient_.

{ return transient_.switchAliasModuleLabel_; }

throwIfInvalid_()

void edm::BranchDescription::throwIfInvalid_ ( ) const

private

Definition at line 275 of file BranchDescription.cc.

References branchType_, friendlyClassName_, fullClassName_, edm::Hash< I >::isValid(), moduleLabel_, edm::NumBranchTypes, parameterSetID(), processName_, produced(), and edm::throwExceptionWithText().

Referenced by initBranchName(), and initFromDictionary().

                                                {
    if (branchType_ >= NumBranchTypes)
      throwExceptionWithText("Illegal BranchType detected");

    if (moduleLabel_.empty())
      throwExceptionWithText("Module label is not allowed to be empty");

    if (processName_.empty())
      throwExceptionWithText("Process name is not allowed to be empty");

    if (fullClassName_.empty())
      throwExceptionWithText("Full class name is not allowed to be empty");

    if (friendlyClassName_.empty())
      throwExceptionWithText("Friendly class name is not allowed to be empty");

    if (produced() && !parameterSetID().isValid())
      throwExceptionWithText("Invalid ParameterSetID detected");
  }

transient()

bool edm::BranchDescription::transient ( ) const

inline

Definition at line 93 of file BranchDescription.h.

References edm::BranchDescription::Transients::transient_, and transient_.

{ return transient_.transient_; }

unwrappedType()

TypeWithDict const& edm::BranchDescription::unwrappedType ( ) const

inline

Definition at line 97 of file BranchDescription.h.

References transient_, and edm::BranchDescription::Transients::unwrappedType_.

Referenced by BranchDescription(), edm::DataManagingProductResolver::checkType(), initFromDictionary(), and setSwitchAliasForBranch().

{ return transient_.unwrappedType_; }

unwrappedTypeID()

TypeID edm::BranchDescription::unwrappedTypeID ( ) const

inline

Definition at line 100 of file BranchDescription.h.

References transient_, edm::TypeWithDict::typeInfo(), and edm::BranchDescription::Transients::unwrappedType_.

Referenced by edm::ProductRegistry::addLabelAlias(), edm::check(), L1GtUtilsHelper::checkToUpdateTags(), l1t::L1TGlobalUtilHelper::checkToUpdateTags(), edm::ConcurrentHadronizerFilter< HAD, DEC >::ConcurrentHadronizerFilter(), edm::EventContentAnalyzer::EventContentAnalyzer(), edm::HadronizerFilter< HAD, DEC >::HadronizerFilter(), L3TkMuonProducer::L3TkMuonProducer(), edm::GetterOfProducts< edmtest::ThingCollection >::operator()(), setSwitchAliasForBranch(), edm::SwitchProducer::SwitchProducer(), edm::DataManagingProductResolver::throwProductDeletedException(), edm::ProvenanceCheckerOutputModule::write(), and edmtest::TableTestOutputModule::write().

{ return TypeID(transient_.unwrappedType_.typeInfo()); }

updateFriendlyClassName()

void edm::BranchDescription::updateFriendlyClassName

(

)

Definition at line 295 of file BranchDescription.cc.

References clearBranchName(), friendlyClassName_, edm::friendlyname::friendlyName(), fullClassName(), and initBranchName().

Referenced by edm::RootFile::RootFile(), and TFWLiteSelectorBasic::setupNewFile().

                                                  {
    friendlyClassName_ = friendlyname::friendlyName(fullClassName());
    clearBranchName();
    initBranchName();
  }

wrappedName()

std::string const& edm::BranchDescription::wrappedName ( ) const

inline

Definition at line 125 of file BranchDescription.h.

References transient_, and edm::BranchDescription::Transients::wrappedName_.

Referenced by initFromDictionary().

{ return transient_.wrappedName_; }

wrappedType()

TypeWithDict const& edm::BranchDescription::wrappedType ( ) const

inline

Definition at line 95 of file BranchDescription.h.

References transient_, and edm::BranchDescription::Transients::wrappedType_.

Referenced by initFromDictionary().

{ return transient_.wrappedType_; }

wrappedTypeID()

TypeID edm::BranchDescription::wrappedTypeID ( ) const

inline

Definition at line 99 of file BranchDescription.h.

References transient_, edm::TypeWithDict::typeInfo(), and edm::BranchDescription::Transients::wrappedType_.

{ return TypeID(transient_.wrappedType_.typeInfo()); }

write()

void edm::BranchDescription::write

(

std::ostream &

os

)

const

Definition at line 258 of file BranchDescription.cc.

References branchID(), branchType(), friendlyClassName(), fullClassName(), moduleLabel(), l1tGTMenu_BTagSeeds_cff::os, processName(), and productInstanceName().

Referenced by pkg.AbstractPkg::generate(), and edm::StableProvenance::write().

                                                    {
    os << "Branch Type = " << branchType() << std::endl;
    os << "Process Name = " << processName() << std::endl;
    os << "ModuleLabel = " << moduleLabel() << std::endl;
    os << "Branch ID = " << branchID() << '\n';
    os << "Class Name = " << fullClassName() << '\n';
    os << "Friendly Class Name = " << friendlyClassName() << '\n';
    os << "Product Instance Name = " << productInstanceName() << std::endl;
  }

Member Data Documentation

aliasForBranchID_

BranchID edm::BranchDescription::aliasForBranchID_

private

Definition at line 240 of file BranchDescription.h.

Referenced by aliasForBranchID(), isAlias(), and originalBranchID().

branchAliases_

std::set<std::string> edm::BranchDescription::branchAliases_

private

Definition at line 235 of file BranchDescription.h.

Referenced by branchAliases(), insertBranchAlias(), merge(), and setSwitchAliasForBranch().

branchID_

BranchID edm::BranchDescription::branchID_

private

Definition at line 222 of file BranchDescription.h.

Referenced by branchID(), initBranchName(), and originalBranchID().

branchType_

BranchType edm::BranchDescription::branchType_

private

Definition at line 212 of file BranchDescription.h.

Referenced by branchType(), setSwitchAliasForBranch(), and throwIfInvalid_().

friendlyClassName_

std::string edm::BranchDescription::friendlyClassName_

private

Definition at line 228 of file BranchDescription.h.

Referenced by friendlyClassName(), initBranchName(), throwIfInvalid_(), and updateFriendlyClassName().

fullClassName_

std::string edm::BranchDescription::fullClassName_

private

Definition at line 225 of file BranchDescription.h.

Referenced by fullClassName(), and throwIfInvalid_().

invalidBasketSize

int const edm::BranchDescription::invalidBasketSize = 0

static

Definition at line 35 of file BranchDescription.h.

Referenced by edm::RootOutputTree::addBranch(), edm::PoolOutputModule::fillSelectedItemList(), initFromDictionary(), and merge().

invalidSplitLevel

int const edm::BranchDescription::invalidSplitLevel = -1

static

Definition at line 34 of file BranchDescription.h.

Referenced by edm::RootOutputTree::addBranch(), edm::PoolOutputModule::fillSelectedItemList(), initFromDictionary(), and merge().

moduleLabel_

std::string edm::BranchDescription::moduleLabel_

private

Definition at line 216 of file BranchDescription.h.

Referenced by initFromDictionary(), ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Modules.SwitchProducer::insertInto(), Mixins._TypedParameterizable::insertInto(), moduleLabel(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), and throwIfInvalid_().

processName_

std::string edm::BranchDescription::processName_

private

Definition at line 219 of file BranchDescription.h.

Referenced by initBranchName(), processName(), and throwIfInvalid_().

productInstanceName_

std::string edm::BranchDescription::productInstanceName_

private

Definition at line 232 of file BranchDescription.h.

Referenced by initBranchName(), and productInstanceName().

transient_

Transients edm::BranchDescription::transient_

private

Definition at line 242 of file BranchDescription.h.

Referenced by availableOnlyAtEndTransition(), basketSize(), BranchDescription(), branchName(), clearBranchName(), dropped(), initBranchName(), initializeTransients(), isMergeable(), isProvenanceSetOnRead(), isSwitchAlias(), isTransform(), moduleName(), onDemand(), parameterSetID(), present(), produced(), setBasketSize(), setDropped(), setIsMergeable(), setIsProvenanceSetOnRead(), setIsTransform(), setOnDemand(), setProduced(), setSplitLevel(), setSwitchAliasForBranch(), setSwitchAliasModuleLabel(), setTransient(), setUnwrappedType(), setWrappedName(), setWrappedType(), splitLevel(), switchAliasForBranchID(), switchAliasModuleLabel(), transient(), unwrappedType(), unwrappedTypeID(), wrappedName(), wrappedType(), and wrappedTypeID().