Back to home page

Project CMSSW displayed by LXR

 
 

    


File indexing completed on 2022-10-18 04:13:18

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