art::BranchDescription Class Reference

#include <BranchDescription.h>

Classes
struct	Transients

Public Member Functions
	BranchDescription ()=default
	BranchDescription (BranchType const bt, TypeLabel const &tl, std::string const &moduleLabel, fhicl::ParameterSetID const &modulePSetID, ProcessConfiguration const &processConfig)
	BranchDescription (BranchType bt, std::string const &moduleLabel, std::string const &processName, std::string const &producedClassName, std::string const &productInstanceName, fhicl::ParameterSetID const &psetID, ProcessConfigurationID const &processConfigurationID, Transients::validity_state validity, bool supportsView, bool transient)
void	write (std::ostream &os) const
std::string const &	moduleLabel () const noexcept
std::string const &	processName () const noexcept
std::string const &	producedClassName () const noexcept
std::string const &	friendlyClassName () const noexcept
std::string const &	productInstanceName () const noexcept
InputTag	inputTag () const
bool	produced () const noexcept
bool	present () const noexcept
bool	dropped () const noexcept
bool	transient () const noexcept
int	splitLevel () const noexcept
int	basketSize () const noexcept
int	compression () const noexcept
std::set< fhicl::ParameterSetID > const &	psetIDs () const noexcept
ProductID	productID () const noexcept
BranchType	branchType () const noexcept
bool	supportsView () const noexcept
std::string const &	branchName () const noexcept
std::string const &	wrappedName () const noexcept
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
fhicl::ParameterSetID const &	psetID () const
void	initProductID_ ()
void	fluffTransients_ () const
bool	transientsFluffed_ () const noexcept
bool	isPsetIDUnique () const noexcept
std::set< ProcessConfigurationID > const &	processConfigurationIDs () const noexcept
Transients &	guts () noexcept
Transients const &	guts () const noexcept
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 41 of file BranchDescription.h.

Constructor & Destructor Documentation

art::BranchDescription::BranchDescription ( )

default

art::BranchDescription::BranchDescription	(	BranchType const	bt,
		TypeLabel const &	tl,
		std::string const &	moduleLabel,
		fhicl::ParameterSetID const &	modulePSetID,
		ProcessConfiguration const &	processConfig
	)

Definition at line 33 of file BranchDescription.cc.

    : BranchDescription{bt,
                        tl.hasEmulatedModule() ? tl.emulatedModule() :
                                                 moduleLabel,
                        processConfig.processName(),
                        tl.className(),
                        tl.productInstanceName(),
                        modulePSetID,
                        processConfig.id(),
                        tl.hasEmulatedModule() ? Transients::PresentFromSource :
                                                 Transients::Produced,
                        tl.supportsView(),
                        tl.transient()}
  {}

art::BranchDescription::BranchDescription	(	BranchType	bt,
		std::string const &	moduleLabel,
		std::string const &	processName,
		std::string const &	producedClassName,
		std::string const &	productInstanceName,
		fhicl::ParameterSetID const &	psetID,
		ProcessConfigurationID const &	processConfigurationID,
		Transients::validity_state	validity,
		bool	supportsView,
		bool	transient
	)

Definition at line 53 of file BranchDescription.cc.

    : branchType_{branchType}
    , moduleLabel_{moduleLabel}
    , processName_{processName}
    , producedClassName_{producedClassName}
    , friendlyClassName_{friendlyname::friendlyName(producedClassName_)}
    , productInstanceName_{productInstanceName}
    , supportsView_{supportsView}
  {
    guts().validity_ = validity;
    guts().transient_ = transient;
    psetIDs_.insert(psetID);
    processConfigurationIDs_.insert(processConfigurationID);
    throwIfInvalid_();
    fluffTransients_();
    initProductID_();
  }

Member Function Documentation

int art::BranchDescription::basketSize ( ) const

inlinenoexcept

Definition at line 171 of file BranchDescription.h.

    {
      return guts().basketSize_;
    }

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

inlinenoexcept

Definition at line 203 of file BranchDescription.h.

    {
      return guts().branchName_;
    }

BranchType art::BranchDescription::branchType ( ) const

inlinenoexcept

Definition at line 193 of file BranchDescription.h.

    {
      return branchType_;
    }

int art::BranchDescription::compression ( ) const

inlinenoexcept

Definition at line 176 of file BranchDescription.h.

    {
      return guts().compression_;
    }

bool art::BranchDescription::dropped ( ) const

inlinenoexcept

Definition at line 155 of file BranchDescription.h.

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

void art::BranchDescription::fluffTransients_ ( ) const

private

Definition at line 93 of file BranchDescription.cc.

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

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

inlinenoexcept

Definition at line 129 of file BranchDescription.h.

    {
      return friendlyClassName_;
    }

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

privatenoexcept

Definition at line 234 of file BranchDescription.cc.

  {
    return transients_.get();
  }

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

privatenoexcept

Definition at line 240 of file BranchDescription.cc.

  {
    return transients_.get();
  }

void art::BranchDescription::initProductID_ ( )

private

Definition at line 82 of file BranchDescription.cc.

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

InputTag art::BranchDescription::inputTag ( ) const

inline

Definition at line 139 of file BranchDescription.h.

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

bool art::BranchDescription::isPsetIDUnique ( ) const

privatenoexcept

Definition at line 222 of file BranchDescription.cc.

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

void art::BranchDescription::merge

(

BranchDescription const &

other

)

Definition at line 119 of file BranchDescription.cc.

  {
    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

inlinenoexcept

Definition at line 114 of file BranchDescription.h.

    {
      return moduleLabel_;
    }

bool art::BranchDescription::present ( ) const

inlinenoexcept

Definition at line 150 of file BranchDescription.h.

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

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

privatenoexcept

Definition at line 228 of file BranchDescription.cc.

  {
    return processConfigurationIDs_;
  }

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

inlinenoexcept

Definition at line 119 of file BranchDescription.h.

    {
      return processName_;
    }

bool art::BranchDescription::produced ( ) const

inlinenoexcept

Definition at line 145 of file BranchDescription.h.

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

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

inlinenoexcept

Definition at line 124 of file BranchDescription.h.

    {
      return producedClassName_;
    }

ProductID art::BranchDescription::productID ( ) const

inlinenoexcept

Definition at line 188 of file BranchDescription.h.

    {
      return productID_;
    }

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

inlinenoexcept

Definition at line 134 of file BranchDescription.h.

    {
      return productInstanceName_;
    }

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

private

Definition at line 104 of file BranchDescription.cc.

  {
    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

inlinenoexcept

Definition at line 182 of file BranchDescription.h.

    {
      return psetIDs_;
    }

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

inline

Definition at line 217 of file BranchDescription.h.

    {
      guts().validity_ = state;
    }

int art::BranchDescription::splitLevel ( ) const

inlinenoexcept

Definition at line 166 of file BranchDescription.h.

    {
      return guts().splitLevel_;
    }

bool art::BranchDescription::supportsView ( ) const

inlinenoexcept

Definition at line 198 of file BranchDescription.h.

    {
      return supportsView_;
    }

void art::BranchDescription::swap

(

BranchDescription &

other

)

Definition at line 150 of file BranchDescription.cc.

  {
    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 168 of file BranchDescription.cc.

  {
    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) != 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) != 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) != 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) != 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

inlinenoexcept

Definition at line 160 of file BranchDescription.h.

    {
      return guts().transient_;
    }

bool art::BranchDescription::transientsFluffed_ ( ) const

privatenoexcept

Definition at line 216 of file BranchDescription.cc.

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

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

inlinenoexcept

Definition at line 208 of file BranchDescription.h.

    {
      return guts().wrappedName_;
    }

void art::BranchDescription::write

(

std::ostream &

os

)

const

Definition at line 138 of file BranchDescription.cc.

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

Friends And Related Function Documentation

bool combinable ( BranchDescription const &  , BranchDescription const &    )

friend

Definition at line 306 of file BranchDescription.cc.

  {
    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 47 of file BranchDescription.h.

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

friend

Definition at line 246 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 318 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 239 of file BranchDescription.h.

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

private

Definition at line 255 of file BranchDescription.h.

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

static

Definition at line 51 of file BranchDescription.h.

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

static

Definition at line 52 of file BranchDescription.h.

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

static

Definition at line 50 of file BranchDescription.h.

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

private

Definition at line 243 of file BranchDescription.h.

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

private

Definition at line 270 of file BranchDescription.h.

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

private

Definition at line 246 of file BranchDescription.h.

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

private

Definition at line 252 of file BranchDescription.h.

ProductID art::BranchDescription::productID_ {}

private

Definition at line 249 of file BranchDescription.h.

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

private

Definition at line 259 of file BranchDescription.h.

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

private

Definition at line 266 of file BranchDescription.h.

bool art::BranchDescription::supportsView_ {false}

private

Definition at line 262 of file BranchDescription.h.

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

mutableprivate

Definition at line 273 of file BranchDescription.h.

---

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

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