Back to home page

Project CMSSW displayed by LXR
 
 

    

File indexing completed on 2025-01-31 02:19:22 

0001 // -*- C++ -*-
0002 //
0003 // Package:     FWCore/Framework
0004 // Class  :     global::EDProducerBase
0005 //
0006 // Implementation:
0007 //     [Notes on implementation]
0008 //
0009 // Original Author:  Chris Jones
0010 //         Created:  Thu, 02 May 2013 21:56:04 GMT
0011 //
0012 
0013 // system include files
0014 
0015 // user include files
0016 #include <memory>
0017 
0018 #include "FWCore/Framework/interface/Event.h"
0019 #include "FWCore/Framework/interface/EventSetup.h"
0020 #include "FWCore/Framework/interface/LuminosityBlock.h"
0021 #include "FWCore/Framework/interface/ProcessBlock.h"
0022 #include "FWCore/Framework/interface/Run.h"
0023 #include "FWCore/Framework/interface/global/EDProducerBase.h"
0024 #include "FWCore/Framework/src/EventAcquireSignalsSentry.h"
0025 #include "FWCore/Framework/src/EventSignalsSentry.h"
0026 #include "FWCore/Framework/interface/PreallocationConfiguration.h"
0027 #include "FWCore/Framework/src/edmodule_mightGet_config.h"
0028 #include "FWCore/Framework/interface/TransitionInfoTypes.h"
0029 #include "FWCore/Framework/interface/EventForTransformer.h"
0030 #include "FWCore/ServiceRegistry/interface/ESParentContext.h"
0031 
0032 #include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
0033 #include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
0034 
0035 //
0036 // constants, enums and typedefs
0037 //
0038 namespace edm {
0039   namespace global {
0040     //
0041     // static data member definitions
0042     //
0043 
0044     //
0045     // constructors and destructor
0046     //
0047     EDProducerBase::EDProducerBase()
0048         : ProducerBase(),
0049           moduleDescription_(),
0050           previousParentages_(),
0051           gotBranchIDsFromAcquire_(),
0052           previousParentageIds_() {}
0053 
0054     EDProducerBase::~EDProducerBase() {}
0055 
0056     bool EDProducerBase::doEvent(EventTransitionInfo const& info,
0057                                  ActivityRegistry* act,
0058                                  ModuleCallingContext const* mcc) {
0059       EventSignalsSentry sentry(act, mcc);
0060       Event e(info, moduleDescription_, mcc);
0061       e.setConsumer(this);
0062       const auto streamIndex = e.streamID().value();
0063       e.setProducer(
0064           this, &previousParentages_[streamIndex], hasAcquire() ? &gotBranchIDsFromAcquire_[streamIndex] : nullptr);
0065       ESParentContext parentC(mcc);
0066       this->produce(
0067           e.streamID(),
0068           e,
0069           EventSetup{
0070               info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC});
0071       commit_(e, &previousParentageIds_[streamIndex]);
0072       return true;
0073     }
0074 
0075     void EDProducerBase::doAcquire(EventTransitionInfo const& info,
0076                                    ActivityRegistry* act,
0077                                    ModuleCallingContext const* mcc,
0078                                    WaitingTaskHolder&& holder) {
0079       EventAcquireSignalsSentry sentry(act, mcc);
0080       Event e(info, moduleDescription_, mcc);
0081       e.setConsumer(this);
0082       const auto streamIndex = e.streamID().value();
0083       e.setProducerForAcquire(this, nullptr, gotBranchIDsFromAcquire_[streamIndex]);
0084       ESParentContext parentC(mcc);
0085       const EventSetup c{
0086           info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC};
0087       this->doAcquire_(e.streamID(), e, c, std::move(holder));
0088     }
0089 
0090     void EDProducerBase::doTransformAsync(WaitingTaskHolder iTask,
0091                                           size_t iTransformIndex,
0092                                           EventPrincipal const& iEvent,
0093                                           ActivityRegistry* iAct,
0094                                           ModuleCallingContext iMCC,
0095                                           ServiceWeakToken const& iToken) noexcept {
0096       EventForTransformer ev(iEvent, iMCC);
0097       transformAsync_(iTask, iTransformIndex, ev, iAct, iToken);
0098     }
0099 
0100     size_t EDProducerBase::transformIndex_(edm::ProductDescription const& iBranch) const noexcept { return -1; }
0101     ProductResolverIndex EDProducerBase::transformPrefetch_(std::size_t iIndex) const noexcept { return 0; }
0102     void EDProducerBase::transformAsync_(WaitingTaskHolder iTask,
0103                                          std::size_t iIndex,
0104                                          edm::EventForTransformer& iEvent,
0105                                          edm::ActivityRegistry* iAct,
0106                                          ServiceWeakToken const& iToken) const noexcept {}
0107 
0108     void EDProducerBase::doPreallocate(PreallocationConfiguration const& iPrealloc) {
0109       auto const nStreams = iPrealloc.numberOfStreams();
0110       previousParentages_ = std::make_unique<std::vector<BranchID>[]>(nStreams);
0111       if (hasAcquire()) {
0112         gotBranchIDsFromAcquire_ = std::make_unique<std::vector<BranchID>[]>(nStreams);
0113       }
0114       previousParentageIds_ = std::make_unique<ParentageID[]>(nStreams);
0115       preallocStreams(nStreams);
0116       preallocRuns(iPrealloc.numberOfRuns());
0117       preallocRunsSummary(iPrealloc.numberOfRuns());
0118       preallocLumis(iPrealloc.numberOfLuminosityBlocks());
0119       preallocLumisSummary(iPrealloc.numberOfLuminosityBlocks());
0120       preallocate(iPrealloc);
0121     }
0122 
0123     void EDProducerBase::doBeginJob() { this->beginJob(); }
0124 
0125     void EDProducerBase::doEndJob() { this->endJob(); }
0126 
0127     void EDProducerBase::doBeginProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0128       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0129       processBlock.setConsumer(this);
0130       ProcessBlock const& constProcessBlock = processBlock;
0131       this->doBeginProcessBlock_(constProcessBlock);
0132       processBlock.setProducer(this);
0133       this->doBeginProcessBlockProduce_(processBlock);
0134       commit_(processBlock);
0135     }
0136 
0137     void EDProducerBase::doAccessInputProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0138       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0139       processBlock.setConsumer(this);
0140       ProcessBlock const& constProcessBlock = processBlock;
0141       this->doAccessInputProcessBlock_(constProcessBlock);
0142     }
0143 
0144     void EDProducerBase::doEndProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0145       ProcessBlock processBlock(pbp, moduleDescription_, mcc, true);
0146       processBlock.setConsumer(this);
0147       ProcessBlock const& constProcessBlock = processBlock;
0148       this->doEndProcessBlock_(constProcessBlock);
0149       processBlock.setProducer(this);
0150       this->doEndProcessBlockProduce_(processBlock);
0151       commit_(processBlock);
0152     }
0153 
0154     void EDProducerBase::doBeginRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0155       Run r(info, moduleDescription_, mcc, false);
0156       r.setConsumer(this);
0157       Run const& cnstR = r;
0158       ESParentContext parentC(mcc);
0159       const EventSetup c{
0160           info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC};
0161       this->doBeginRun_(cnstR, c);
0162       this->doBeginRunSummary_(cnstR, c);
0163       r.setProducer(this);
0164       this->doBeginRunProduce_(r, c);
0165       commit_(r);
0166     }
0167 
0168     void EDProducerBase::doEndRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0169       Run r(info, moduleDescription_, mcc, true);
0170       r.setConsumer(this);
0171       r.setProducer(this);
0172       Run const& cnstR = r;
0173       ESParentContext parentC(mcc);
0174       const EventSetup c{
0175           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
0176       this->doEndRunSummary_(r, c);
0177       this->doEndRunProduce_(r, c);
0178       this->doEndRun_(cnstR, c);
0179       commit_(r);
0180     }
0181 
0182     void EDProducerBase::doBeginLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0183       LuminosityBlock lb(info, moduleDescription_, mcc, false);
0184       lb.setConsumer(this);
0185       LuminosityBlock const& cnstLb = lb;
0186       ESParentContext parentC(mcc);
0187       const EventSetup c{info,
0188                          static_cast<unsigned int>(Transition::BeginLuminosityBlock),
0189                          esGetTokenIndices(Transition::BeginLuminosityBlock),
0190                          parentC};
0191       this->doBeginLuminosityBlock_(cnstLb, c);
0192       this->doBeginLuminosityBlockSummary_(cnstLb, c);
0193       lb.setProducer(this);
0194       this->doBeginLuminosityBlockProduce_(lb, c);
0195       commit_(lb);
0196     }
0197 
0198     void EDProducerBase::doEndLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0199       LuminosityBlock lb(info, moduleDescription_, mcc, true);
0200       lb.setConsumer(this);
0201       lb.setProducer(this);
0202       LuminosityBlock const& cnstLb = lb;
0203       ESParentContext parentC(mcc);
0204       const EventSetup c{info,
0205                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
0206                          esGetTokenIndices(Transition::EndLuminosityBlock),
0207                          parentC};
0208       this->doEndLuminosityBlockSummary_(cnstLb, c);
0209       this->doEndLuminosityBlockProduce_(lb, c);
0210       this->doEndLuminosityBlock_(cnstLb, c);
0211       commit_(lb);
0212     }
0213 
0214     void EDProducerBase::doBeginStream(StreamID id) { doBeginStream_(id); }
0215     void EDProducerBase::doEndStream(StreamID id) { doEndStream_(id); }
0216     void EDProducerBase::doStreamBeginRun(StreamID id, RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0217       Run r(info, moduleDescription_, mcc, false);
0218       r.setConsumer(this);
0219       ESParentContext parentC(mcc);
0220       this->doStreamBeginRun_(
0221           id,
0222           r,
0223           EventSetup{
0224               info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC});
0225     }
0226     void EDProducerBase::doStreamEndRun(StreamID id, RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0227       Run r(info, moduleDescription_, mcc, true);
0228       r.setConsumer(this);
0229       ESParentContext parentC(mcc);
0230       const EventSetup c{
0231           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
0232       this->doStreamEndRun_(id, r, c);
0233       this->doStreamEndRunSummary_(id, r, c);
0234     }
0235     void EDProducerBase::doStreamBeginLuminosityBlock(StreamID id,
0236                                                       LumiTransitionInfo const& info,
0237                                                       ModuleCallingContext const* mcc) {
0238       LuminosityBlock lb(info, moduleDescription_, mcc, false);
0239       lb.setConsumer(this);
0240       ESParentContext parentC(mcc);
0241 
0242       this->doStreamBeginLuminosityBlock_(id,
0243                                           lb,
0244                                           EventSetup{info,
0245                                                      static_cast<unsigned int>(Transition::BeginLuminosityBlock),
0246                                                      esGetTokenIndices(Transition::BeginLuminosityBlock),
0247                                                      parentC});
0248     }
0249 
0250     void EDProducerBase::doStreamEndLuminosityBlock(StreamID id,
0251                                                     LumiTransitionInfo const& info,
0252                                                     ModuleCallingContext const* mcc) {
0253       LuminosityBlock lb(info, moduleDescription_, mcc, true);
0254       lb.setConsumer(this);
0255       ESParentContext parentC(mcc);
0256       const EventSetup c{info,
0257                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
0258                          esGetTokenIndices(Transition::EndLuminosityBlock),
0259                          parentC};
0260       this->doStreamEndLuminosityBlock_(id, lb, c);
0261       this->doStreamEndLuminosityBlockSummary_(id, lb, c);
0262     }
0263 
0264     void EDProducerBase::preallocStreams(unsigned int) {}
0265     void EDProducerBase::preallocRuns(unsigned int) {}
0266     void EDProducerBase::preallocRunsSummary(unsigned int) {}
0267     void EDProducerBase::preallocLumis(unsigned int) {}
0268     void EDProducerBase::preallocLumisSummary(unsigned int) {}
0269     void EDProducerBase::preallocate(PreallocationConfiguration const&) {}
0270     void EDProducerBase::doBeginStream_(StreamID id) {}
0271     void EDProducerBase::doEndStream_(StreamID id) {}
0272     void EDProducerBase::doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c) {}
0273     void EDProducerBase::doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c) {}
0274     void EDProducerBase::doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c) {}
0275     void EDProducerBase::doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c) {}
0276     void EDProducerBase::doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c) {}
0277     void EDProducerBase::doStreamEndLuminosityBlockSummary_(StreamID id,
0278                                                             LuminosityBlock const& lbp,
0279                                                             EventSetup const& c) {}
0280 
0281     void EDProducerBase::doBeginProcessBlock_(ProcessBlock const&) {}
0282     void EDProducerBase::doAccessInputProcessBlock_(ProcessBlock const&) {}
0283     void EDProducerBase::doEndProcessBlock_(ProcessBlock const&) {}
0284     void EDProducerBase::doBeginRun_(Run const& rp, EventSetup const& c) {}
0285     void EDProducerBase::doEndRun_(Run const& rp, EventSetup const& c) {}
0286     void EDProducerBase::doBeginRunSummary_(Run const& rp, EventSetup const& c) {}
0287     void EDProducerBase::doEndRunSummary_(Run const& rp, EventSetup const& c) {}
0288 
0289     void EDProducerBase::doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0290     void EDProducerBase::doEndLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0291     void EDProducerBase::doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c) {}
0292     void EDProducerBase::doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c) {}
0293 
0294     void EDProducerBase::doBeginProcessBlockProduce_(ProcessBlock&) {}
0295     void EDProducerBase::doEndProcessBlockProduce_(ProcessBlock&) {}
0296     void EDProducerBase::doBeginRunProduce_(Run& rp, EventSetup const& c) {}
0297     void EDProducerBase::doEndRunProduce_(Run& rp, EventSetup const& c) {}
0298     void EDProducerBase::doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0299     void EDProducerBase::doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0300 
0301     void EDProducerBase::clearInputProcessBlockCaches() {}
0302 
0303     void EDProducerBase::doAcquire_(StreamID, Event const&, EventSetup const&, WaitingTaskHolder&&) {}
0304 
0305     void EDProducerBase::fillDescriptions(ConfigurationDescriptions& descriptions) {
0306       ParameterSetDescription desc;
0307       desc.setUnknown();
0308       descriptions.addDefault(desc);
0309     }
0310 
0311     void EDProducerBase::prevalidate(ConfigurationDescriptions& iConfig) { edmodule_mightGet_config(iConfig); }
0312 
0313     static const std::string kBaseType("EDProducer");
0314 
0315     const std::string& EDProducerBase::baseType() { return kBaseType; }
0316 
0317   }  // namespace global
0318 }  // namespace edm
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.2.1 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!