Classes | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
art::BranchDescription Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/canvas/v3_06_01/source/canvas/Persistency/Provenance/BranchDescription.h"

Classes

struct  Transients
 

Public Member Functions

 BranchDescription ()=default
 
 BranchDescription (BranchType bt, TypeLabel const &tl, ModuleDescription const &modDesc)
 
 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, bool supportsView, bool transient)
 
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
 
Transientsguts ()
 
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::ParameterSetIDpsetIDs_ {}
 
std::set< ProcessConfigurationIDprocessConfigurationIDs_ {}
 
Transient< Transientstransients_ {}
 

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  bt,
TypeLabel const &  tl,
ModuleDescription const &  modDesc 
)
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,
bool  supportsView,
bool  transient 
)

Member Function Documentation

int art::BranchDescription::basketSize ( ) const
inline

Definition at line 135 of file BranchDescription.h.

136  {
137  return guts().basketSize_;
138  }
std::string const& art::BranchDescription::branchName ( ) const
inline

Definition at line 167 of file BranchDescription.h.

References string.

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

168  {
169  return guts().branchName_;
170  }
BranchType art::BranchDescription::branchType ( ) const
inline

Definition at line 157 of file BranchDescription.h.

158  {
159  return branchType_;
160  }
int art::BranchDescription::compression ( ) const
inline

Definition at line 140 of file BranchDescription.h.

141  {
142  return guts().compression_;
143  }
bool art::BranchDescription::dropped ( ) const
inline
void art::BranchDescription::fluffTransients_ ( ) const
private
std::string const& art::BranchDescription::friendlyClassName ( ) const
inline

Definition at line 92 of file BranchDescription.h.

References string.

Referenced by art::Principal::fillGroup(), and art::Provenance::friendlyClassName().

93  {
94  return friendlyClassName_;
95  }
Transients& art::BranchDescription::guts ( )
inlineprivate

Definition at line 251 of file BranchDescription.h.

252  {
253  return transients_.get();
254  }
Transient< Transients > transients_
Transients const& art::BranchDescription::guts ( ) const
inlineprivate

Definition at line 256 of file BranchDescription.h.

257  {
258  return transients_.get();
259  }
Transient< Transients > transients_
void art::BranchDescription::initProductID_ ( )
private
InputTag art::BranchDescription::inputTag ( ) const
inline

Definition at line 103 of file BranchDescription.h.

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

104  {
105  return InputTag{moduleLabel(), productInstanceName(), processName()};
106  }
std::string const & moduleLabel() const
std::string const & productInstanceName() const
std::string const & processName() const
bool art::BranchDescription::isPsetIDUnique ( ) const
inlineprivate

Definition at line 240 of file BranchDescription.h.

241  {
242  return psetIDs().size() == 1;
243  }
std::set< fhicl::ParameterSetID > const & psetIDs() const
void art::BranchDescription::merge ( BranchDescription const &  other)
std::string const& art::BranchDescription::moduleLabel ( ) const
inline

Definition at line 77 of file BranchDescription.h.

References string.

Referenced by art::ModuleLabelSelector::doMatch(), art::Principal::fillGroup(), and art::Provenance::moduleLabel().

78  {
79  return moduleLabel_;
80  }
bool art::BranchDescription::present ( ) const
inline
std::set<ProcessConfigurationID> const& art::BranchDescription::processConfigurationIDs ( ) const
inlineprivate

Definition at line 245 of file BranchDescription.h.

246  {
248  }
std::set< ProcessConfigurationID > processConfigurationIDs_
std::string const& art::BranchDescription::processName ( ) const
inline

Definition at line 82 of file BranchDescription.h.

References string.

Referenced by art::ProcessNameSelector::doMatch(), art::Principal::fillGroup(), and art::Provenance::processName().

83  {
84  return processName_;
85  }
bool art::BranchDescription::produced ( ) const
inline
std::string const& art::BranchDescription::producedClassName ( ) const
inline

Definition at line 87 of file BranchDescription.h.

References string.

Referenced by art::Principal::fillGroup(), and art::Provenance::producedClassName().

88  {
89  return producedClassName_;
90  }
ProductID art::BranchDescription::productID ( ) const
inline
std::string const& art::BranchDescription::productInstanceName ( ) const
inline

Definition at line 97 of file BranchDescription.h.

Referenced by art::ProductInstanceNameSelector::doMatch(), and art::Provenance::productInstanceName().

98  {
99  return productInstanceName_;
100  }
fhicl::ParameterSetID const& art::BranchDescription::psetID ( ) const
private
std::set<fhicl::ParameterSetID> const& art::BranchDescription::psetIDs ( ) const
inline

Definition at line 146 of file BranchDescription.h.

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

147  {
148  return psetIDs_;
149  }
std::set< fhicl::ParameterSetID > psetIDs_
void art::BranchDescription::setValidity ( Transients::validity_state const  state)
inline

Definition at line 222 of file BranchDescription.h.

References makeDatasetsPage::state.

int art::BranchDescription::splitLevel ( ) const
inline

Definition at line 130 of file BranchDescription.h.

131  {
132  return guts().splitLevel_;
133  }
bool art::BranchDescription::supportsView ( ) const
inline

Definition at line 162 of file BranchDescription.h.

References string.

163  {
164  return supportsView_;
165  }
void art::BranchDescription::swap ( BranchDescription other)
void art::BranchDescription::throwIfInvalid_ ( ) const
private
bool art::BranchDescription::transient ( ) const
inline

Definition at line 124 of file BranchDescription.h.

125  {
126  return guts().transient_;
127  }
bool art::BranchDescription::transientsFluffed_ ( ) const
inlineprivate

Definition at line 231 of file BranchDescription.h.

232  {
233  return !guts().branchName_.empty();
234  }
std::string const& art::BranchDescription::wrappedName ( ) const
inline

Definition at line 172 of file BranchDescription.h.

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

173  {
174  return guts().wrappedName_;
175  }
void art::BranchDescription::write ( std::ostream &  os) const

Friends And Related Function Documentation

bool combinable ( BranchDescription const &  ,
BranchDescription const &   
)
friend
friend class detail::BranchDescriptionStreamer
friend

Definition at line 228 of file BranchDescription.h.

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

Member Data Documentation

BranchType art::BranchDescription::branchType_ {InEvent}
private

Definition at line 264 of file BranchDescription.h.

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

Definition at line 280 of file BranchDescription.h.

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

Definition at line 55 of file BranchDescription.h.

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

Definition at line 56 of file BranchDescription.h.

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

Definition at line 54 of file BranchDescription.h.

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

Definition at line 268 of file BranchDescription.h.

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

Definition at line 295 of file BranchDescription.h.

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

Definition at line 271 of file BranchDescription.h.

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

Definition at line 277 of file BranchDescription.h.

ProductID art::BranchDescription::productID_ {}
private

Definition at line 274 of file BranchDescription.h.

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

Definition at line 284 of file BranchDescription.h.

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

Definition at line 291 of file BranchDescription.h.

bool art::BranchDescription::supportsView_ {false}
private

Definition at line 287 of file BranchDescription.h.

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

Definition at line 297 of file BranchDescription.h.


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