src/one/EDProducerBase.cc

0001 // -*- C++ -*-
0002 //
0003 // Package:     FWCore/Framework
0004 // Class  :     one::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 "FWCore/Framework/interface/one/EDProducerBase.h"
0017 #include "FWCore/Framework/interface/Event.h"
0018 #include "FWCore/Framework/interface/LuminosityBlock.h"
0019 #include "FWCore/Framework/interface/ProcessBlock.h"
0020 #include "FWCore/Framework/interface/Run.h"
0021 #include "FWCore/Framework/interface/EventSetup.h"
0022 #include "FWCore/Framework/src/edmodule_mightGet_config.h"
0023 #include "FWCore/Framework/interface/PreallocationConfiguration.h"
0024 #include "FWCore/Framework/src/EventSignalsSentry.h"
0025 #include "FWCore/Framework/interface/TransitionInfoTypes.h"
0026 #include "FWCore/Framework/interface/EventForTransformer.h"
0027 #include "FWCore/ServiceRegistry/interface/ESParentContext.h"
0028
0029 #include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
0030 #include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
0031
0032 //
0033 // constants, enums and typedefs
0034 //
0035 namespace edm {
0036
0037   namespace one {
0038     //
0039     // static data member definitions
0040     //
0041
0042     //
0043     // constructors and destructor
0044     //
0045     EDProducerBase::EDProducerBase()
0046         : ProducerBase(), moduleDescription_(), previousParentage_(), previousParentageId_() {}
0047
0048     EDProducerBase::~EDProducerBase() {}
0049
0050     bool EDProducerBase::doEvent(EventTransitionInfo const& info,
0051                                  ActivityRegistry* act,
0052                                  ModuleCallingContext const* mcc) {
0053       Event e(info, moduleDescription_, mcc);
0054       e.setConsumer(this);
0055       e.setProducer(this, &previousParentage_);
0056       e.setSharedResourcesAcquirer(&resourcesAcquirer_);
0057       EventSignalsSentry sentry(act, mcc);
0058       ESParentContext parentC(mcc);
0059       const EventSetup c{
0060           info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC};
0061       this->produce(e, c);
0062       commit_(e, &previousParentageId_);
0063       return true;
0064     }
0065
0066     SharedResourcesAcquirer EDProducerBase::createAcquirer() {
0067       return SharedResourcesAcquirer{
0068           std::vector<std::shared_ptr<SerialTaskQueue>>(1, std::make_shared<SerialTaskQueue>())};
0069     }
0070
0071     SerialTaskQueue* EDProducerBase::globalRunsQueue() { return nullptr; }
0072     SerialTaskQueue* EDProducerBase::globalLuminosityBlocksQueue() { return nullptr; };
0073
0074     void EDProducerBase::doTransform(size_t iTransformIndex,
0075                                      EventPrincipal const& iEvent,
0076                                      ActivityRegistry*,
0077                                      ModuleCallingContext const* iMCC) {
0078       EventForTransformer ev(iEvent, iMCC);
0079       transform_(iTransformIndex, ev);
0080     }
0081
0082     size_t EDProducerBase::transformIndex_(edm::BranchDescription const& iBranch) const { return -1; }
0083     ProductResolverIndex EDProducerBase::transformPrefetch_(std::size_t iIndex) const { return 0; }
0084     void EDProducerBase::transform_(std::size_t iIndex, edm::EventForTransformer& iEvent) const {}
0085
0086     void EDProducerBase::doBeginJob() {
0087       resourcesAcquirer_ = createAcquirer();
0088
0089       this->beginJob();
0090     }
0091
0092     void EDProducerBase::doEndJob() { this->endJob(); }
0093
0094     void EDProducerBase::doPreallocate(PreallocationConfiguration const& iPrealloc) {
0095       auto const nThreads = iPrealloc.numberOfThreads();
0096       preallocThreads(nThreads);
0097       preallocLumis(iPrealloc.numberOfLuminosityBlocks());
0098     }
0099
0100     void EDProducerBase::preallocLumis(unsigned int){};
0101
0102     void EDProducerBase::doBeginProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0103       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0104       processBlock.setConsumer(this);
0105       ProcessBlock const& constProcessBlock = processBlock;
0106       this->doBeginProcessBlock_(constProcessBlock);
0107       processBlock.setProducer(this);
0108       this->doBeginProcessBlockProduce_(processBlock);
0109       commit_(processBlock);
0110     }
0111
0112     void EDProducerBase::doAccessInputProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0113       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0114       processBlock.setConsumer(this);
0115       ProcessBlock const& constProcessBlock = processBlock;
0116       this->doAccessInputProcessBlock_(constProcessBlock);
0117     }
0118
0119     void EDProducerBase::doEndProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0120       ProcessBlock processBlock(pbp, moduleDescription_, mcc, true);
0121       processBlock.setConsumer(this);
0122       ProcessBlock const& constProcessBlock = processBlock;
0123       this->doEndProcessBlock_(constProcessBlock);
0124       processBlock.setProducer(this);
0125       this->doEndProcessBlockProduce_(processBlock);
0126       commit_(processBlock);
0127     }
0128
0129     void EDProducerBase::doBeginRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0130       Run r(info, moduleDescription_, mcc, false);
0131       r.setConsumer(this);
0132       Run const& cnstR = r;
0133       ESParentContext parentC(mcc);
0134       const EventSetup c{
0135           info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC};
0136       this->doBeginRun_(cnstR, c);
0137       r.setProducer(this);
0138       this->doBeginRunProduce_(r, c);
0139       commit_(r);
0140     }
0141
0142     void EDProducerBase::doEndRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0143       Run r(info, moduleDescription_, mcc, true);
0144       r.setConsumer(this);
0145       Run const& cnstR = r;
0146       r.setProducer(this);
0147       ESParentContext parentC(mcc);
0148       const EventSetup c{
0149           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
0150       this->doEndRunProduce_(r, c);
0151       this->doEndRun_(cnstR, c);
0152       commit_(r);
0153     }
0154
0155     void EDProducerBase::doBeginLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0156       LuminosityBlock lb(info, moduleDescription_, mcc, false);
0157       lb.setConsumer(this);
0158       LuminosityBlock const& cnstLb = lb;
0159       ESParentContext parentC(mcc);
0160       const EventSetup c{info,
0161                          static_cast<unsigned int>(Transition::BeginLuminosityBlock),
0162                          esGetTokenIndices(Transition::BeginLuminosityBlock),
0163                          parentC};
0164       this->doBeginLuminosityBlock_(cnstLb, c);
0165       lb.setProducer(this);
0166       this->doBeginLuminosityBlockProduce_(lb, c);
0167       commit_(lb);
0168     }
0169
0170     void EDProducerBase::doEndLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0171       LuminosityBlock lb(info, moduleDescription_, mcc, true);
0172       lb.setConsumer(this);
0173       lb.setProducer(this);
0174       ESParentContext parentC(mcc);
0175       const EventSetup c{info,
0176                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
0177                          esGetTokenIndices(Transition::EndLuminosityBlock),
0178                          parentC};
0179       this->doEndLuminosityBlockProduce_(lb, c);
0180       LuminosityBlock const& cnstLb = lb;
0181       this->doEndLuminosityBlock_(cnstLb, c);
0182       commit_(lb);
0183     }
0184
0185     void EDProducerBase::doBeginProcessBlock_(ProcessBlock const&) {}
0186     void EDProducerBase::doAccessInputProcessBlock_(ProcessBlock const&) {}
0187     void EDProducerBase::doEndProcessBlock_(ProcessBlock const&) {}
0188     void EDProducerBase::doBeginRun_(Run const& rp, EventSetup const& c) {}
0189     void EDProducerBase::doEndRun_(Run const& rp, EventSetup const& c) {}
0190     void EDProducerBase::doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0191     void EDProducerBase::doEndLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0192
0193     void EDProducerBase::doBeginProcessBlockProduce_(ProcessBlock&) {}
0194     void EDProducerBase::doEndProcessBlockProduce_(ProcessBlock&) {}
0195     void EDProducerBase::doBeginRunProduce_(Run& rp, EventSetup const& c) {}
0196     void EDProducerBase::doEndRunProduce_(Run& rp, EventSetup const& c) {}
0197     void EDProducerBase::doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0198     void EDProducerBase::doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0199
0200     void EDProducerBase::clearInputProcessBlockCaches() {}
0201
0202     void EDProducerBase::fillDescriptions(ConfigurationDescriptions& descriptions) {
0203       ParameterSetDescription desc;
0204       desc.setUnknown();
0205       descriptions.addDefault(desc);
0206     }
0207
0208     void EDProducerBase::prevalidate(ConfigurationDescriptions& iConfig) { edmodule_mightGet_config(iConfig); }
0209
0210     static const std::string kBaseType("EDProducer");
0211
0212     const std::string& EDProducerBase::baseType() { return kBaseType; }
0213
0214   }  // namespace one
0215 }  // namespace edm