edm::Run Class Reference

#include <Run.h>

Inheritance diagram for edm::Run:

Public Types
typedef PrincipalGetAdapter	Base

Public Member Functions
template<typename PROD >
bool	get (SelectorBase const &, Handle< PROD > &result) 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	getByType (Handle< PROD > &result) const
template<typename PROD >
void	getMany (SelectorBase const &, std::vector< Handle< PROD > > &results) const
template<typename PROD >
void	getManyByType (std::vector< Handle< PROD > > &results) const
Provenance	getProvenance (BranchID const &theID) const
ProcessHistory const &	processHistory () const
template<typename PROD >
void	put (std::auto_ptr< PROD > product)
	Put a new product. More...
template<typename PROD >
void	put (std::auto_ptr< PROD > product, std::string const &productInstanceName)
	Put a new product with a 'product instance name'. More...
	Run (RunPrincipal &rp, ModuleDescription const &md)
RunAuxiliary const &	runAuxiliary () const
	~Run ()
Public Member Functions inherited from edm::RunBase
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
RunID const &	id () const
RunNumber_t	run () const
	RunBase ()
virtual	~RunBase ()

Private Types
typedef std::set< BranchID >	BranchIDSet
typedef std::vector< std::pair < EDProduct *, ConstBranchDescription const * > >	ProductPtrVec

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

Private Attributes
RunAuxiliary const &	aux_
BranchIDSet	gotBranchIDs_
PrincipalGetAdapter	provRecorder_
ProductPtrVec	putProducts_

Friends
class	ConfigurableInputSource
class	DaqSource
class	EDFilter
class	EDProducer
class	InputSource
class	RawInputSource

Detailed Description

Definition at line 31 of file Run.h.

Member Typedef Documentation

typedef PrincipalGetAdapter edm::Run::Base

Definition at line 36 of file Run.h.

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

private

Definition at line 136 of file Run.h.

typedef std::vector<std::pair<EDProduct*, ConstBranchDescription const*> > edm::Run::ProductPtrVec

private

Definition at line 115 of file Run.h.

Constructor & Destructor Documentation

Run::Run	(	RunPrincipal &	rp,
		ModuleDescription const &	md
	)

Definition at line 8 of file Run.cc.

                                                        :
    provRecorder_(rp, md),
    aux_(rp.aux()) {
  }

Run::~Run

(

)

Definition at line 13 of file Run.cc.

References edm::for_all(), and putProducts_.

            {
    // anything left here must be the result of a failure
    // let's record them as failed attempts in the event principal
    for_all(putProducts_, principal_get_adapter_detail::deleter());
  }

Member Function Documentation

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

private

Definition at line 105 of file Run.cc.

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

Referenced by getByLabelImpl().

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

void Run::commit_ ( )

private

Definition at line 77 of file Run.cc.

References begin, end, edm::productstatus::present(), edm::RunPrincipal::put(), putProducts(), and runPrincipal().

Referenced by edm::EDProducer::doBeginRun(), edm::EDFilter::doBeginRun(), edm::InputSource::doBeginRun(), edm::EDProducer::doEndRun(), edm::EDFilter::doEndRun(), and edm::InputSource::doEndRun().

               {
    // fill in guts of provenance here
    RunPrincipal& rp = runPrincipal();
    ProductPtrVec::iterator pit(putProducts().begin());
    ProductPtrVec::iterator pie(putProducts().end());

    while(pit != pie) {
    // set provenance
    std::auto_ptr<ProductProvenance> runEntryInfoPtr(
        new ProductProvenance(pit->second->branchID(),
                    productstatus::present()));
        std::auto_ptr<EDProduct> pr(pit->first);
        // Ownership has passed, so clear the pointer.
        pit->first = 0;
    rp.put(*pit->second, pr, runEntryInfoPtr);
    ++pit;
    }

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

template<typename PROD >

bool Run::get	(	SelectorBase const &	sel,
		Handle< PROD > &	result
	)		const

Definition at line 168 of file Run.h.

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

Referenced by Options.Options::__getitem__().

                                                              {
    return provRecorder_.get(sel,result);
  }

void Run::getAllProvenance

(

std::vector< Provenance const * > &

provenances

)

const

Definition at line 35 of file Run.cc.

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

Referenced by GlobalHitsProdHistStripper::beginRun(), and L1GtUtils::getL1GtTriggerMenuLiteInputTag().

                                                                       {
    runPrincipal().getAllProvenance(provenances);
  }

template<typename PROD >

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

Definition at line 174 of file Run.h.

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

Referenced by L1GtAnalyzer::analyzeConditionsInRunBlock(), L1GtAnalyzer::analyzeL1GtTriggerMenuLite(), LHEWriter::beginRun(), LHEProducer::beginRun(), HLTPrescaleRecorder::beginRun(), pat::PATTriggerEventProducer::beginRun(), LHE2HepMCConverter::beginRun(), pat::PATTriggerProducer::beginRun(), ExternalLHEAsciiDumper::endRun(), TkLasBeamFitter::endRun(), AlignmentProducer::endRun(), L1GtBeamModeFilter::filter(), PrescaleWeightProvider::initRun(), and L1GtUtils::retrieveL1GtTriggerMenuLite().

                                                                    {
    return provRecorder_.getByLabel(label,result);
  }

template<typename PROD >

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

Definition at line 180 of file Run.h.

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

                                              {
    return provRecorder_.getByLabel(label,productInstanceName,result);
  }

template<typename PROD >

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

same as above, but using the InputTag class

Definition at line 189 of file Run.h.

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

                                                                 {
    return provRecorder_.getByLabel(tag,result);
  }

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

privatevirtual

Implements edm::RunBase.

Definition at line 110 of file Run.cc.

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

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

template<typename PROD >

bool Run::getByType

(

Handle< PROD > &

result

)

const

Definition at line 201 of file Run.h.

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

Referenced by FWFFLooper::beginRun(), FWFFService::postBeginRun(), and EveService::postBeginRun().

                                           {
    return provRecorder_.getByType(result);
  }

template<typename PROD >

void Run::getMany	(	SelectorBase const &	sel,
		std::vector< Handle< PROD > > &	results
	)		const

Definition at line 195 of file Run.h.

References edm::PrincipalGetAdapter::getMany(), provRecorder_, and python.entryComment::results.

                                                                               {
    return provRecorder_.getMany(sel,results);
  }

template<typename PROD >

void Run::getManyByType

(

std::vector< Handle< PROD > > &

results

)

const

Definition at line 207 of file Run.h.

References edm::PrincipalGetAdapter::getManyByType(), provRecorder_, and python.entryComment::results.

Referenced by edm::HadronizerFilter< HAD, DEC >::beginRun(), and GlobalHitsProdHistStripper::endRun().

                                                            {
    return provRecorder_.getManyByType(results);
  }

Provenance Run::getProvenance

(

BranchID const &

theID

)

const

Definition at line 30 of file Run.cc.

References edm::Principal::getProvenance(), and runPrincipal().

                                              {
    return runPrincipal().getProvenance(bid);
  }

ProcessHistory const & Run::processHistory

(

)

const

Definition at line 100 of file Run.cc.

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

Referenced by pat::PATTriggerEventProducer::beginRun(), pat::PATTriggerProducer::beginRun(), and HLTConfigProvider::init().

                            {
    return provRecorder_.processHistory();
  }

template<typename PROD >

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

inline

Put a new product.

Definition at line 79 of file Run.h.

Referenced by LHESource::beginRun(), AlpgenSource::beginRun(), MCatNLOSource::beginRun(), L1GtTriggerMenuLiteProducer::beginRun(), ExternalLHEProducer::beginRun(), edm::CosMuoGenSource::endRun(), edm::CosMuoGenProducer::endRun(), edm::PomwigProducer::endRun(), edm::FlatBaseThetaGunProducer::endRun(), LHESource::endRun(), edm::BeamHaloProducer::endRun(), edm::ExhumeProducer::endRun(), edm::BaseFlatGunProducer::endRun(), LHEProducer::endRun(), HLTPrescaleRecorder::endRun(), edm::GeneratorFilter< HAD, DEC >::endRun(), edm::HadronizerFilter< HAD, DEC >::endRun(), ConditionDumperInEdm::endRun(), ExternalLHEProducer::endRun(), TkLasBeamFitter::endRun(), GlobalHitsProdHist::endRun(), and LaserAlignment::endRun().

{put<PROD>(product, std::string());}

template<typename PROD >

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

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

Definition at line 142 of file Run.h.

References edm::PrincipalGetAdapter::getBranchDescription(), PROD, provRecorder_, putProducts(), edm::principal_get_adapter_detail::throwOnPutOfNullProduct(), and relativeConstraints::value.

                                                                          {
    if (product.get() == 0) {                // null pointer is illegal
      TypeID typeID(typeid(PROD));
      principal_get_adapter_detail::throwOnPutOfNullProduct("Run", typeID, productInstanceName);
    }

    // The following will call post_insert if T has such a function,
    // and do nothing if T has no such function.
    typename boost::mpl::if_c<detail::has_postinsert<PROD>::value,
      DoPostInsert<PROD>,
      DoNotPostInsert<PROD> >::type maybe_inserter;
    maybe_inserter(product.get());

    ConstBranchDescription const& desc =
      provRecorder_.getBranchDescription(TypeID(*product), productInstanceName);

    Wrapper<PROD> *wp(new Wrapper<PROD>(product));

    putProducts().push_back(std::make_pair(wp, &desc));

    // product.release(); // The object has been copied into the Wrapper.
    // The old copy must be deleted, so we cannot release ownership.
  }

ProductPtrVec& edm::Run::putProducts ( )

inlineprivate

Definition at line 116 of file Run.h.

References putProducts_.

Referenced by commit_(), and put().

{return putProducts_;}

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

inlineprivate

Definition at line 117 of file Run.h.

References putProducts_.

{return putProducts_;}

RunAuxiliary const& edm::Run::runAuxiliary ( ) const

inlinevirtual

Implements edm::RunBase.

Definition at line 38 of file Run.h.

References aux_.

Referenced by L1GtUtils::retrieveL1GtTriggerMenuLite().

{return aux_;}

RunPrincipal const & Run::runPrincipal ( ) const

private

Definition at line 25 of file Run.cc.

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

Referenced by commit_(), getAllProvenance(), and getProvenance().

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

RunPrincipal & Run::runPrincipal ( )

private

Definition at line 20 of file Run.cc.

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

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

Friends And Related Function Documentation

friend class ConfigurableInputSource

friend

Definition at line 123 of file Run.h.

friend class DaqSource

friend

Definition at line 124 of file Run.h.

friend class EDFilter

friend

Definition at line 127 of file Run.h.

friend class EDProducer

friend

Definition at line 128 of file Run.h.

friend class InputSource

friend

Definition at line 125 of file Run.h.

friend class RawInputSource

friend

Definition at line 126 of file Run.h.

Member Data Documentation

RunAuxiliary const& edm::Run::aux_

private

Definition at line 135 of file Run.h.

Referenced by runAuxiliary().

BranchIDSet edm::Run::gotBranchIDs_

mutableprivate

Definition at line 137 of file Run.h.

Referenced by addToGotBranchIDs().

PrincipalGetAdapter edm::Run::provRecorder_

private

Definition at line 133 of file Run.h.

Referenced by get(), getByLabel(), getByLabelImpl(), getByType(), getMany(), getManyByType(), processHistory(), put(), and runPrincipal().

ProductPtrVec edm::Run::putProducts_

private

Definition at line 134 of file Run.h.

Referenced by putProducts(), and ~Run().