#include "BranchDescription.h"

Classes
struct	Transients

Public Member Functions
	BranchDescription ()=default

	BranchDescription (BranchType const bt, TypeLabel const &tl, ModuleDescription const &modDesc)

void	write (std::ostream &os) const

std::string const &	moduleLabel () const

std::string const &	processName () const

std::string const &	producedClassName () const

std::string const &	friendlyClassName () const

std::string const &	productInstanceName () const

InputTag	inputTag () const

bool	produced () const

bool	present () const

bool	dropped () const

bool	transient () const

int	splitLevel () const

int	basketSize () const

int	compression () const

std::set< fhicl::ParameterSetID > const &	psetIDs () const

ProductID	productID () const

BranchType	branchType () const

bool	supportsView () const

std::string const &	branchName () const

std::string const &	wrappedName () const

void	merge (BranchDescription const &other)

void	swap (BranchDescription &other)

void	setValidity (Transients::validity_state const state)

Static Public Attributes
static int constexpr	invalidSplitLevel {-1}

static int constexpr	invalidBasketSize {0}

static int constexpr	invalidCompression {-1}

Private Member Functions
bool	transientsFluffed_ () const

void	initProductID_ ()

void	fluffTransients_ () const

fhicl::ParameterSetID const &	psetID () const

bool	isPsetIDUnique () const

std::set< ProcessConfigurationID > const &	processConfigurationIDs () const

Transients &	guts ()

Transients const &	guts () const

void	throwIfInvalid_ () const

Private Attributes
BranchType	branchType_ {InEvent}

std::string	moduleLabel_ {}

std::string	processName_ {}

ProductID	productID_ {}

std::string	producedClassName_ {}

std::string	friendlyClassName_ {}

std::string	productInstanceName_ {}

bool	supportsView_ {false}

std::set< fhicl::ParameterSetID >	psetIDs_ {}

std::set< ProcessConfigurationID >	processConfigurationIDs_ {}

Transient< Transients >	transients_ {}

Friends
class	detail::BranchDescriptionStreamer

bool	combinable (BranchDescription const &, BranchDescription const &)

bool	operator< (BranchDescription const &, BranchDescription const &)

bool	operator== (BranchDescription const &, BranchDescription const &)

Detailed Description

Definition at line 52 of file BranchDescription.h.

Constructor & Destructor Documentation

art::BranchDescription::BranchDescription ( )

default

art::BranchDescription::BranchDescription	(	BranchType const	bt,
		TypeLabel const &	tl,
		ModuleDescription const &	modDesc
	)

Definition at line 31 of file BranchDescription.cc.

References fluffTransients_(), friendlyClassName_, guts(), initProductID_(), moduleLabel_, processConfigurationIDs_, processName_, art::BranchDescription::Transients::Produced, producedClassName_, productInstanceName_, psetIDs_, supportsView_, throwIfInvalid_(), art::BranchDescription::Transients::transient_, and art::BranchDescription::Transients::validity_.

     : branchType_{bt}
     , moduleLabel_{tl.hasEmulatedModule() ? tl.emulatedModule() :
                                             md.moduleLabel()}
     , processName_{md.processName()}
     , producedClassName_{tl.className()}
     , friendlyClassName_{tl.friendlyClassName()}
     , productInstanceName_{tl.productInstanceName()}
     , supportsView_{tl.supportsView()}
   {
     guts().validity_ = Transients::Produced;
     guts().transient_ = tl.transient();
     psetIDs_.insert(md.parameterSetID());
     processConfigurationIDs_.insert(md.processConfigurationID());
     throwIfInvalid_();
     fluffTransients_();
     initProductID_();
   }

Member Function Documentation

int art::BranchDescription::basketSize ( ) const

inline

Definition at line 127 of file BranchDescription.h.

Referenced by art::RootOutputTree::addOutputBranch().

   {
     return guts().basketSize_;
   }

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

inline

Definition at line 159 of file BranchDescription.h.

Referenced by art::RootInputTree::addBranch(), art::RootOutputTree::addOutputBranch(), art::Provenance::branchName(), art::RootOutputTree::resetOutputBranchAddress(), and art::RootOutputTree::setOutputBranchAddress().

   {
     return guts().branchName_;
   }

BranchType art::BranchDescription::branchType ( ) const

inline

Definition at line 149 of file BranchDescription.h.

Referenced by art::GroupSelectorRules::Rule::appliesTo(), art::combinable(), art::OutputModule::doSelectProducts(), art::operator<(), and art::EventPrincipal::throwIfExistingGroup().

   {
     return branchType_;
   }

int art::BranchDescription::compression ( ) const

inline

Definition at line 132 of file BranchDescription.h.

Referenced by art::RootOutputTree::addOutputBranch().

   {
     return guts().compression_;
   }

bool art::BranchDescription::dropped ( ) const

inline

Definition at line 111 of file BranchDescription.h.

Referenced by art::OutputModule::doSelectProducts().

   {
     return guts().validity_ == Transients::Dropped;
   }

void art::BranchDescription::fluffTransients_ ( ) const

private

Definition at line 64 of file BranchDescription.cc.

References art::canonicalProductName(), friendlyClassName(), moduleLabel(), processName(), producedClassName_, productInstanceName(), transients_, transientsFluffed_(), and art::wrappedClassName().

Referenced by BranchDescription().

   {
     if (transientsFluffed_()) {
       return;
     }
     transients_.get().branchName_ = canonicalProductName(
       friendlyClassName(), moduleLabel(), productInstanceName(), processName());
     transients_.get().wrappedName_ = wrappedClassName(producedClassName_);
   }

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

inline

Definition at line 84 of file BranchDescription.h.

Referenced by art::GroupSelectorRules::Rule::appliesTo(), art::BranchKey::BranchKey(), art::combinable(), art::Principal::fillGroup(), fluffTransients_(), art::Provenance::friendlyClassName(), art::operator<(), art::EventPrincipal::throwIfExistingGroup(), throwIfInvalid_(), and write().

   {
     return friendlyClassName_;
   }

Transients& art::BranchDescription::guts ( )

inlineprivate

Definition at line 243 of file BranchDescription.h.

Referenced by BranchDescription(), initProductID_(), merge(), and psetID().

   {
     return transients_.get();
   }

Transients const& art::BranchDescription::guts ( ) const

inlineprivate

Definition at line 248 of file BranchDescription.h.

   {
     return transients_.get();
   }

void art::BranchDescription::initProductID_ ( )

private

Definition at line 53 of file BranchDescription.cc.

References guts(), art::ProductID::isValid(), productID_, art::ProductID::setID(), and transientsFluffed_().

Referenced by BranchDescription().

   {
     if (!transientsFluffed_()) {
       return;
     }
     if (!productID_.isValid()) {
       productID_.setID(guts().branchName_);
     }
   }

InputTag art::BranchDescription::inputTag ( ) const

inline

Definition at line 95 of file BranchDescription.h.

Referenced by art::Provenance::inputTag().

   {
     return InputTag{moduleLabel(), productInstanceName(), processName()};
   }

bool art::BranchDescription::isPsetIDUnique ( ) const

inlineprivate

Definition at line 232 of file BranchDescription.h.

   {
     return psetIDs().size() == 1;
   }

void art::BranchDescription::merge ( BranchDescription const & other )

Definition at line 90 of file BranchDescription.cc.

References art::BranchDescription::Transients::basketSize_, art::BranchDescription::Transients::compression_, guts(), invalidBasketSize, invalidCompression, invalidSplitLevel, processConfigurationIDs(), processConfigurationIDs_, psetIDs(), psetIDs_, and art::BranchDescription::Transients::splitLevel_.

   {
     psetIDs_.insert(other.psetIDs().begin(), other.psetIDs().end());
     processConfigurationIDs_.insert(other.processConfigurationIDs().begin(),
                                     other.processConfigurationIDs().end());
     if (guts().splitLevel_ == invalidSplitLevel) {
       guts().splitLevel_ = other.guts().splitLevel_;
     }
     if (guts().basketSize_ == invalidBasketSize) {
       guts().basketSize_ = other.guts().basketSize_;
     }
     // FIXME: This is probably wrong! We are going from defaulted compression
     //        to a possibly different compression, bad.
     if (guts().compression_ == invalidCompression) {
       guts().compression_ = other.guts().compression_;
     }
   }

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

inline

Definition at line 69 of file BranchDescription.h.

Referenced by art::GroupSelectorRules::Rule::appliesTo(), art::combinable(), art::ModuleLabelSelector::doMatch(), art::Principal::fillGroup(), fluffTransients_(), art::Provenance::moduleLabel(), art::operator<(), art::EventPrincipal::throwIfExistingGroup(), throwIfInvalid_(), and write().

   {
     return moduleLabel_;
   }

bool art::BranchDescription::present ( ) const

inline

Definition at line 106 of file BranchDescription.h.

Referenced by art::RootInputTree::addBranch().

   {
     return guts().validity_ == Transients::PresentFromSource;
   }

std::set<ProcessConfigurationID> const& art::BranchDescription::processConfigurationIDs ( ) const

inlineprivate

Definition at line 237 of file BranchDescription.h.

Referenced by merge(), art::operator<(), and art::operator==().

   {
     return processConfigurationIDs_;
   }

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

inline

Definition at line 74 of file BranchDescription.h.

Referenced by art::GroupSelectorRules::Rule::appliesTo(), art::combinable(), art::ProcessNameSelector::doMatch(), art::Principal::fillGroup(), fluffTransients_(), art::operator<(), art::Provenance::processName(), art::EventPrincipal::throwIfExistingGroup(), throwIfInvalid_(), and write().

   {
     return processName_;
   }

bool art::BranchDescription::produced ( ) const

inline

Definition at line 101 of file BranchDescription.h.

Referenced by art::RootOutputTree::addOutputBranch(), and art::Provenance::produced().

   {
     return guts().validity_ == Transients::Produced;
   }

std::string const& art::BranchDescription::producedClassName ( ) const

inline

Definition at line 79 of file BranchDescription.h.

Referenced by art::checkDictionaries(), art::combinable(), art::Principal::fillGroup(), art::operator<(), art::Provenance::producedClassName(), and write().

   {
     return producedClassName_;
   }

ProductID art::BranchDescription::productID ( ) const

inline

Definition at line 144 of file BranchDescription.h.

Referenced by art::combinable(), art::ResultsPrincipal::fillGroup(), art::RunPrincipal::fillGroup(), art::SubRunPrincipal::fillGroup(), art::EventPrincipal::fillGroup(), art::Principal::fillGroup(), art::operator<(), art::ResultsPrincipal::put(), art::RunPrincipal::put(), art::SubRunPrincipal::put(), art::EventPrincipal::put(), art::rangeSetFor(), art::EventPrincipal::throwIfExistingGroup(), and write().

   {
     return productID_;
   }

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

inline

Definition at line 89 of file BranchDescription.h.

Referenced by art::GroupSelectorRules::Rule::appliesTo(), art::combinable(), art::ProductInstanceNameSelector::doMatch(), fluffTransients_(), art::operator<(), art::Provenance::productInstanceName(), art::EventPrincipal::throwIfExistingGroup(), throwIfInvalid_(), and write().

   {
     return productInstanceName_;
   }

ParameterSetID const & art::BranchDescription::psetID ( ) const

private

Definition at line 75 of file BranchDescription.cc.

References art::BranchDescription::Transients::branchName_, art::errors::Configuration, guts(), and psetIDs().

   {
     assert(!psetIDs().empty());
     if (psetIDs().size() != 1) {
       throw Exception(errors::Configuration, "AmbiguousProvenance")
         << "Your application requires all events on Branch '"
         << guts().branchName_
         << "'\n to have the same provenance. This file has events with "
            "mixed provenance\n"
         << "on this branch.  Use a different input file.\n";
     }
     return *psetIDs().begin();
   }

std::set<fhicl::ParameterSetID> const& art::BranchDescription::psetIDs ( ) const

inline

Definition at line 138 of file BranchDescription.h.

Referenced by merge(), art::operator<(), art::operator==(), psetID(), and art::Provenance::psetIDs().

   {
     return psetIDs_;
   }

void art::BranchDescription::setValidity ( Transients::validity_state const state )

inline

Definition at line 214 of file BranchDescription.h.

   {
     guts().validity_ = state;
   }

int art::BranchDescription::splitLevel ( ) const

inline

Definition at line 122 of file BranchDescription.h.

Referenced by art::RootOutputTree::addOutputBranch().

   {
     return guts().splitLevel_;
   }

bool art::BranchDescription::supportsView ( ) const

inline

Definition at line 154 of file BranchDescription.h.

   {
     return supportsView_;
   }

void art::BranchDescription::swap ( BranchDescription & other )

Definition at line 121 of file BranchDescription.cc.

References branchType_, friendlyClassName_, moduleLabel_, processConfigurationIDs_, processName_, producedClassName_, productID_, productInstanceName_, psetIDs_, supportsView_, and transients_.

   {
     using std::swap;
     swap(branchType_, other.branchType_);
     swap(moduleLabel_, other.moduleLabel_);
     swap(processName_, other.processName_);
     swap(productID_, other.productID_);
     swap(producedClassName_, other.producedClassName_);
     swap(friendlyClassName_, other.friendlyClassName_);
     swap(productInstanceName_, other.productInstanceName_);
     swap(supportsView_, other.supportsView_);
     swap(psetIDs_, other.psetIDs_);
     swap(processConfigurationIDs_, other.processConfigurationIDs_);
     swap(transients_, other.transients_);
   }

void art::BranchDescription::throwIfInvalid_ ( ) const

private

Definition at line 138 of file BranchDescription.cc.

References branchType_, art::errors::Configuration, friendlyClassName(), friendlyClassName_, art::errors::LogicError, moduleLabel(), moduleLabel_, art::NumBranchTypes, processName(), processName_, producedClassName_, productInstanceName(), productInstanceName_, and transientsFluffed_().

Referenced by BranchDescription().

   {
     constexpr char underscore{'_'};
     if (transientsFluffed_()) {
       return;
     }
     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 (producedClassName_.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 (friendlyClassName_.find(underscore) != std::string::npos) {
       throw Exception(errors::LogicError, "IllegalCharacter")
         << "Class name '" << friendlyClassName()
         << "' contains an underscore ('_'), which is illegal in the "
         << "name of a product.\n";
     }
     if (moduleLabel_.find(underscore) != std::string::npos) {
       throw Exception(errors::Configuration, "IllegalCharacter")
         << "Module label '" << moduleLabel()
         << "' contains an underscore ('_'), which is illegal in a "
         << "module label.\n";
     }
     if (productInstanceName_.find(underscore) != std::string::npos) {
       throw Exception(errors::Configuration, "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 Exception(errors::Configuration, "IllegalCharacter")
         << "Process name '" << processName()
         << "' contains an underscore ('_'), which is illegal in a "
         << "process name.\n";
     }
   }

bool art::BranchDescription::transient ( ) const

inline

Definition at line 116 of file BranchDescription.h.

Referenced by art::checkDictionaries(), art::OutputModule::doSelectProducts(), and art::DataViewImpl::recordAsParent().

   {
     return guts().transient_;
   }

bool art::BranchDescription::transientsFluffed_ ( ) const

inlineprivate

Definition at line 223 of file BranchDescription.h.

Referenced by fluffTransients_(), initProductID_(), and throwIfInvalid_().

   {
     return !guts().branchName_.empty();
   }

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

inline

Definition at line 164 of file BranchDescription.h.

References art::combinable(), art::operator<(), art::operator==(), fhicl::other, and art::swap().

Referenced by art::RootOutputTree::addOutputBranch(), and art::checkDictionaries().

   {
     return guts().wrappedName_;
   }

void art::BranchDescription::write ( std::ostream & os ) const

Definition at line 109 of file BranchDescription.cc.

References branchType_, friendlyClassName(), moduleLabel(), processName(), producedClassName(), productID(), and productInstanceName().

Referenced by art::operator<<(), and art::Provenance::write().

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

Friends And Related Function Documentation

bool combinable	(	BranchDescription const &	,
		BranchDescription const &
	)

friend

Definition at line 246 of file BranchDescription.cc.

Referenced by art::operator==().

   {
     return (a.branchType() == b.branchType()) &&
            (a.processName() == b.processName()) &&
            (a.producedClassName() == b.producedClassName()) &&
            (a.friendlyClassName() == b.friendlyClassName()) &&
            (a.productInstanceName() == b.productInstanceName()) &&
            (a.moduleLabel() == b.moduleLabel()) &&
            (a.productID() == b.productID());
   }

friend class detail::BranchDescriptionStreamer

friend

Definition at line 220 of file BranchDescription.h.

bool operator<	(	BranchDescription const &	,
		BranchDescription const &
	)

friend

Definition at line 186 of file BranchDescription.cc.

   {
     if (a.processName() < b.processName()) {
       return true;
     }
     if (b.processName() < a.processName()) {
       return false;
     }
     if (a.producedClassName() < b.producedClassName()) {
       return true;
     }
     if (b.producedClassName() < a.producedClassName()) {
       return false;
     }
     if (a.friendlyClassName() < b.friendlyClassName()) {
       return true;
     }
     if (b.friendlyClassName() < a.friendlyClassName()) {
       return false;
     }
     if (a.productInstanceName() < b.productInstanceName()) {
       return true;
     }
     if (b.productInstanceName() < a.productInstanceName()) {
       return false;
     }
     if (a.moduleLabel() < b.moduleLabel()) {
       return true;
     }
     if (b.moduleLabel() < a.moduleLabel()) {
       return false;
     }
     if (a.branchType() < b.branchType()) {
       return true;
     }
     if (b.branchType() < a.branchType()) {
       return false;
     }
     if (a.productID() < b.productID()) {
       return true;
     }
     if (b.productID() < a.productID()) {
       return false;
     }
     if (a.psetIDs() < b.psetIDs()) {
       return true;
     }
     if (b.psetIDs() < a.psetIDs()) {
       return false;
     }
     if (a.processConfigurationIDs() < b.processConfigurationIDs()) {
       return true;
     }
     if (b.processConfigurationIDs() < a.processConfigurationIDs()) {
       return false;
     }
     return false;
   }

bool operator==	(	BranchDescription const &	,
		BranchDescription const &
	)

friend

Definition at line 258 of file BranchDescription.cc.

   {
     return combinable(a, b) && (a.psetIDs() == b.psetIDs()) &&
            (a.processConfigurationIDs() == b.processConfigurationIDs());
   }

Member Data Documentation

BranchType art::BranchDescription::branchType_ {InEvent}

private

Definition at line 256 of file BranchDescription.h.

Referenced by swap(), throwIfInvalid_(), and write().

std::string art::BranchDescription::friendlyClassName_ {}

private

Definition at line 272 of file BranchDescription.h.

Referenced by BranchDescription(), swap(), and throwIfInvalid_().

int constexpr art::BranchDescription::invalidBasketSize {0}

static

Definition at line 55 of file BranchDescription.h.

Referenced by merge().

int constexpr art::BranchDescription::invalidCompression {-1}

static

Definition at line 56 of file BranchDescription.h.

Referenced by merge().

int constexpr art::BranchDescription::invalidSplitLevel {-1}

static

Definition at line 54 of file BranchDescription.h.

Referenced by merge().

std::string art::BranchDescription::moduleLabel_ {}

private

Definition at line 260 of file BranchDescription.h.

Referenced by BranchDescription(), swap(), and throwIfInvalid_().

std::set<ProcessConfigurationID> art::BranchDescription::processConfigurationIDs_ {}

private

Definition at line 287 of file BranchDescription.h.

Referenced by BranchDescription(), merge(), and swap().

std::string art::BranchDescription::processName_ {}

private

Definition at line 263 of file BranchDescription.h.

Referenced by BranchDescription(), swap(), and throwIfInvalid_().

std::string art::BranchDescription::producedClassName_ {}

private

Definition at line 269 of file BranchDescription.h.

Referenced by BranchDescription(), fluffTransients_(), swap(), and throwIfInvalid_().

ProductID art::BranchDescription::productID_ {}

private

Definition at line 266 of file BranchDescription.h.

Referenced by initProductID_(), and swap().

std::string art::BranchDescription::productInstanceName_ {}

private

Definition at line 276 of file BranchDescription.h.

Referenced by BranchDescription(), swap(), and throwIfInvalid_().

std::set<fhicl::ParameterSetID> art::BranchDescription::psetIDs_ {}

private

Definition at line 283 of file BranchDescription.h.

Referenced by BranchDescription(), merge(), and swap().

bool art::BranchDescription::supportsView_ {false}

private

Definition at line 279 of file BranchDescription.h.

Referenced by BranchDescription(), and swap().

Transient<Transients> art::BranchDescription::transients_ {}

mutableprivate

Definition at line 289 of file BranchDescription.h.

Referenced by fluffTransients_(), and swap().

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

canvas/Persistency/Provenance/BranchDescription.h
canvas/Persistency/Provenance/BranchDescription.cc

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation