edm::LuminosityBlock Class Reference

#include <LuminosityBlock.h>

Inheritance diagram for edm::LuminosityBlock:

Public Types
typedef unsigned long	CacheIdentifier_t

Public Member Functions
CacheIdentifier_t	cacheIdentifier () const
void	getAllProvenance (std::vector< Provenance const * > &provenances) const
template<typename PROD >
bool	getByLabel (std::string const &label, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...
template<typename PROD >
bool	getByToken (EDGetToken token, Handle< PROD > &result) const
template<typename PROD >
bool	getByToken (EDGetTokenT< PROD > token, Handle< PROD > &result) const
template<typename PROD >
void	getManyByType (std::vector< Handle< PROD > > &results) const
Provenance	getProvenance (BranchID const &theID) const
Run const &	getRun () const
LuminosityBlockIndex	index () const
void	labelsForToken (EDGetToken const &iToken, ProductLabels &oLabels) const
	LuminosityBlock (LuminosityBlockPrincipal const &lbp, ModuleDescription const &md, ModuleCallingContext const *)
LuminosityBlockAuxiliary const &	luminosityBlockAuxiliary () const
ModuleCallingContext const *	moduleCallingContext () const
ProcessHistory const &	processHistory () const
ProcessHistoryID const &	processHistoryID () const
template<typename PROD >
void	put (std::auto_ptr< PROD > product)
	Put a new product. More...
template<typename PROD >
void	put (std::unique_ptr< PROD > product)
template<typename PROD >
void	put (std::auto_ptr< PROD > product, std::string const &productInstanceName)
	Put a new product with a 'product instance name'. More...
template<typename PROD >
void	put (std::unique_ptr< PROD > product, std::string const &productInstanceName)
void	setConsumer (EDConsumerBase const *iConsumer)
void	setSharedResourcesAcquirer (SharedResourcesAcquirer *iResourceAcquirer)
	~LuminosityBlock ()
Public Member Functions inherited from edm::LuminosityBlockBase
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...
template<class T >
bool	getByLabel (const InputTag &tag, Handle< T > &result) const
LuminosityBlockID	id () const
LuminosityBlockNumber_t	luminosityBlock () const
	LuminosityBlockBase ()
RunNumber_t	run () const
virtual	~LuminosityBlockBase ()

Private Types
typedef std::set< BranchID >	BranchIDSet
typedef std::vector< std::pair < edm::propagate_const < std::unique_ptr< WrapperBase > >, BranchDescription const * > >	ProductPtrVec

Private Member Functions
void	addToGotBranchIDs (Provenance const &prov) const
void	commit_ ()
virtual BasicHandle	getByLabelImpl (std::type_info const &iWrapperType, std::type_info const &iProductType, InputTag const &iTag) const
LuminosityBlockPrincipal const &	luminosityBlockPrincipal () const
ProductPtrVec &	putProducts ()
ProductPtrVec const &	putProducts () const

Private Attributes
LuminosityBlockAuxiliary const &	aux_
BranchIDSet	gotBranchIDs_
ModuleCallingContext const *	moduleCallingContext_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_
std::shared_ptr< Run const > const	run_

Static Private Attributes
static const std::string	emptyString_

Friends
class	InputSource
class	ProducerBase
class	RawInputSource
template<typename T >
class	stream::ProducingModuleAdaptorBase

Detailed Description

Definition at line 46 of file LuminosityBlock.h.

Member Typedef Documentation

typedef std::set<BranchID> edm::LuminosityBlock::BranchIDSet

private

Definition at line 168 of file LuminosityBlock.h.

typedef unsigned long edm::LuminosityBlock::CacheIdentifier_t

If you are caching data from the LuminosityBlock, you should also keep this number. If this number changes then you know that the data you have cached is invalid. The value of '0' will never be returned so you can use that to denote that you have not yet checked the value.

Definition at line 65 of file LuminosityBlock.h.

typedef std::vector<std::pair<edm::propagate_const<std::unique_ptr<WrapperBase> >, BranchDescription const*> > edm::LuminosityBlock::ProductPtrVec

private

Definition at line 147 of file LuminosityBlock.h.

Constructor & Destructor Documentation

LuminosityBlock::LuminosityBlock	(	LuminosityBlockPrincipal const &	lbp,
		ModuleDescription const &	md,
		ModuleCallingContext const *	moduleCallingContext
	)

Definition at line 12 of file LuminosityBlock.cc.

                                                                                     :
        provRecorder_(lbp, md),
        aux_(lbp.aux()),
        run_(new Run(lbp.runPrincipal(), md, moduleCallingContext)),
        moduleCallingContext_(moduleCallingContext) {
  }

LuminosityBlock::~LuminosityBlock

(

)

Definition at line 20 of file LuminosityBlock.cc.

                                    {
  }

Member Function Documentation

void LuminosityBlock::addToGotBranchIDs ( Provenance const &  prov ) const

private

Definition at line 88 of file LuminosityBlock.cc.

References edm::Provenance::branchID(), and gotBranchIDs_.

Referenced by getByLabelImpl().

                                                                 {
    gotBranchIDs_.insert(prov.branchID());
  }

LuminosityBlock::CacheIdentifier_t LuminosityBlock::cacheIdentifier

(

)

const

Definition at line 29 of file LuminosityBlock.cc.

References edm::Principal::cacheIdentifier(), and luminosityBlockPrincipal().

{return luminosityBlockPrincipal().cacheIdentifier();}

void LuminosityBlock::commit_ ( )

private

Definition at line 63 of file LuminosityBlock.cc.

References begin, end, edm::get_underlying_safe(), luminosityBlockPrincipal(), eostools::move(), edm::LuminosityBlockPrincipal::put(), and putProducts().

                           {
    LuminosityBlockPrincipal const& lbp = luminosityBlockPrincipal();
    ProductPtrVec::iterator pit(putProducts().begin());
    ProductPtrVec::iterator pie(putProducts().end());

    while(pit != pie) {
        lbp.put(*pit->second, std::move(get_underlying_safe(pit->first)));
        ++pit;
    }

    // the cleanup is all or none
    putProducts().clear();
  }

void LuminosityBlock::getAllProvenance

(

std::vector< Provenance const * > &

provenances

)

const

Definition at line 58 of file LuminosityBlock.cc.

References edm::Principal::getAllProvenance(), and luminosityBlockPrincipal().

                                                                                   {
    luminosityBlockPrincipal().getAllProvenance(provenances);
  }

template<typename PROD >

bool LuminosityBlock::getByLabel	(	std::string const &	label,
		Handle< PROD > &	result
	)		const

Definition at line 208 of file LuminosityBlock.h.

template<typename PROD >

bool LuminosityBlock::getByLabel	(	std::string const &	label,
		std::string const &	productInstanceName,
		Handle< PROD > &	result
	)		const

Definition at line 214 of file LuminosityBlock.h.

template<typename PROD >

bool LuminosityBlock::getByLabel	(	InputTag const &	tag,
		Handle< PROD > &	result
	)		const

same as above, but using the InputTag class

Definition at line 232 of file LuminosityBlock.h.

BasicHandle LuminosityBlock::getByLabelImpl ( std::type_info const &  iWrapperType, std::type_info const &  iProductType, InputTag const &  iTag  ) const

privatevirtual

Implements edm::LuminosityBlockBase.

Definition at line 93 of file LuminosityBlock.cc.

References addToGotBranchIDs(), edm::PrincipalGetAdapter::getByLabel_(), h, edm::BasicHandle::isValid(), moduleCallingContext_, edm::BasicHandle::provenance(), and provRecorder_.

                                                                                                                   {
    BasicHandle h = provRecorder_.getByLabel_(TypeID(iProductType), iTag, moduleCallingContext_);
    if (h.isValid()) {
      addToGotBranchIDs(*(h.provenance()));
    }
    return h;
  }

template<typename PROD >

bool LuminosityBlock::getByToken	(	EDGetToken	token,
		Handle< PROD > &	result
	)		const

Definition at line 247 of file LuminosityBlock.h.

Referenced by EventHeader::analyze(), BrilClient::dqmEndLuminosityBlock(), GenFilterEfficiencyAnalyzer::endLuminosityBlock(), DQMLumiMonitor::endLuminosityBlock(), MillePedeFileExtractor::endLuminosityBlock(), and GetLumi::getRawValue().

template<typename PROD >

bool LuminosityBlock::getByToken	(	EDGetTokenT< PROD >	token,
		Handle< PROD > &	result
	)		const

Definition at line 262 of file LuminosityBlock.h.

template<typename PROD >

void LuminosityBlock::getManyByType

(

std::vector< Handle< PROD > > &

results

)

const

Definition at line 278 of file LuminosityBlock.h.

Provenance LuminosityBlock::getProvenance

(

BranchID const &

theID

)

const

Definition at line 53 of file LuminosityBlock.cc.

References edm::Principal::getProvenance(), luminosityBlockPrincipal(), and moduleCallingContext_.

                                                          {
    return luminosityBlockPrincipal().getProvenance(bid, moduleCallingContext_);
  }

Run const& edm::LuminosityBlock::getRun ( ) const

inline

Definition at line 103 of file LuminosityBlock.h.

LuminosityBlockIndex LuminosityBlock::index

(

)

const

Returns

Reusable index which can be used to separate data for different simultaneous LuminosityBlocks.

Definition at line 24 of file LuminosityBlock.cc.

References edm::LuminosityBlockPrincipal::index(), and luminosityBlockPrincipal().

Referenced by edm::BeamHaloProducer::beginLuminosityBlock(), and RandomEngineStateProducer::globalBeginLuminosityBlockProduce().

                               {
    return luminosityBlockPrincipal().index();
  }

void edm::LuminosityBlock::labelsForToken ( EDGetToken const &  iToken, ProductLabels &  oLabels  ) const

inline

Definition at line 138 of file LuminosityBlock.h.

LuminosityBlockAuxiliary const& edm::LuminosityBlock::luminosityBlockAuxiliary ( ) const

inlinevirtual

Implements edm::LuminosityBlockBase.

Definition at line 53 of file LuminosityBlock.h.

LuminosityBlockPrincipal const & LuminosityBlock::luminosityBlockPrincipal ( ) const

private

Definition at line 48 of file LuminosityBlock.cc.

References compareJSON::const, edm::PrincipalGetAdapter::principal(), and provRecorder_.

Referenced by cacheIdentifier(), commit_(), getAllProvenance(), getProvenance(), index(), and processHistoryID().

                                                  {
    return dynamic_cast<LuminosityBlockPrincipal const&>(provRecorder_.principal());
  }

ModuleCallingContext const* edm::LuminosityBlock::moduleCallingContext ( ) const

inline

Definition at line 136 of file LuminosityBlock.h.

Referenced by DQMEDAnalyzer::endLuminosityBlockSummary().

ProcessHistory const & LuminosityBlock::processHistory

(

)

const

Definition at line 83 of file LuminosityBlock.cc.

References edm::PrincipalGetAdapter::processHistory(), and provRecorder_.

Referenced by gen::BaseHadronizer::generateLHE().

                                        {
    return provRecorder_.processHistory();
  }

ProcessHistoryID const & LuminosityBlock::processHistoryID

(

)

const

Definition at line 78 of file LuminosityBlock.cc.

References luminosityBlockPrincipal(), and edm::Principal::processHistoryID().

                                          {
    return luminosityBlockPrincipal().processHistoryID();
  }

template<typename PROD >

void edm::LuminosityBlock::put ( std::auto_ptr< PROD >  product )

inline

Put a new product.

Definition at line 110 of file LuminosityBlock.h.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), MillePedeFileConverter::endLuminosityBlockProduce(), EventCountProducer::endLuminosityBlockProduce(), GenFilterEfficiencyProducer::endLuminosityBlockProduce(), ConditionDumperInEdm::endLuminosityBlockProduce(), and RandomEngineStateProducer::globalBeginLuminosityBlockProduce().

template<typename PROD >

void edm::LuminosityBlock::put ( std::unique_ptr< PROD >  product )

inline

Definition at line 114 of file LuminosityBlock.h.

template<typename PROD >

void LuminosityBlock::put	(	std::auto_ptr< PROD >	product,
		std::string const &	productInstanceName
	)

Put a new product with a 'product instance name'.

Definition at line 177 of file LuminosityBlock.h.

template<typename PROD >

void LuminosityBlock::put	(	std::unique_ptr< PROD >	product,
		std::string const &	productInstanceName
	)

Definition at line 183 of file LuminosityBlock.h.

ProductPtrVec& edm::LuminosityBlock::putProducts ( )

inlineprivate

Definition at line 148 of file LuminosityBlock.h.

Referenced by commit_().

ProductPtrVec const& edm::LuminosityBlock::putProducts ( ) const

inlineprivate

Definition at line 149 of file LuminosityBlock.h.

void LuminosityBlock::setConsumer

(

EDConsumerBase const *

iConsumer

)

Definition at line 33 of file LuminosityBlock.cc.

References provRecorder_, run_, and edm::PrincipalGetAdapter::setConsumer().

Referenced by edm::EDAnalyzer::doBeginLuminosityBlock(), edm::EDProducer::doBeginLuminosityBlock(), edm::EDFilter::doBeginLuminosityBlock(), edm::one::EDFilterBase::doBeginLuminosityBlock(), edm::one::EDProducerBase::doBeginLuminosityBlock(), edm::one::EDAnalyzerBase::doBeginLuminosityBlock(), edm::EDAnalyzer::doEndLuminosityBlock(), edm::EDProducer::doEndLuminosityBlock(), edm::EDFilter::doEndLuminosityBlock(), edm::one::EDProducerBase::doEndLuminosityBlock(), edm::one::EDFilterBase::doEndLuminosityBlock(), and edm::one::EDAnalyzerBase::doEndLuminosityBlock().

                                                              {
    provRecorder_.setConsumer(iConsumer);
    if(run_) {
      const_cast<Run*>(run_.get())->setConsumer(iConsumer);
    }
  }

void LuminosityBlock::setSharedResourcesAcquirer

(

SharedResourcesAcquirer *

iResourceAcquirer

)

Definition at line 41 of file LuminosityBlock.cc.

References provRecorder_, run_, and edm::PrincipalGetAdapter::setSharedResourcesAcquirer().

                                                                                         {
    provRecorder_.setSharedResourcesAcquirer(iResourceAcquirer);
    const_cast<Run*>(run_.get())->setSharedResourcesAcquirer(iResourceAcquirer);
  }

Friends And Related Function Documentation

friend class InputSource

friend

Definition at line 155 of file LuminosityBlock.h.

friend class ProducerBase

friend

Definition at line 157 of file LuminosityBlock.h.

friend class RawInputSource

friend

Definition at line 156 of file LuminosityBlock.h.

template<typename T >

friend class stream::ProducingModuleAdaptorBase

friend

Definition at line 158 of file LuminosityBlock.h.

Member Data Documentation

LuminosityBlockAuxiliary const& edm::LuminosityBlock::aux_

private

Definition at line 166 of file LuminosityBlock.h.

std::string const LuminosityBlock::emptyString_

staticprivate

Definition at line 172 of file LuminosityBlock.h.

BranchIDSet edm::LuminosityBlock::gotBranchIDs_

mutableprivate

Definition at line 169 of file LuminosityBlock.h.

Referenced by addToGotBranchIDs().

ModuleCallingContext const* edm::LuminosityBlock::moduleCallingContext_

private

Definition at line 170 of file LuminosityBlock.h.

Referenced by getByLabelImpl(), and getProvenance().

PrincipalGetAdapter edm::LuminosityBlock::provRecorder_

private

Definition at line 164 of file LuminosityBlock.h.

Referenced by getByLabelImpl(), luminosityBlockPrincipal(), processHistory(), setConsumer(), and setSharedResourcesAcquirer().

ProductPtrVec edm::LuminosityBlock::putProducts_

private

Definition at line 165 of file LuminosityBlock.h.

std::shared_ptr<Run const> const edm::LuminosityBlock::run_

private

Definition at line 167 of file LuminosityBlock.h.

Referenced by setConsumer(), and setSharedResourcesAcquirer().