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::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 <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/EDFilterBase.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     EDFilterBase::EDFilterBase()
0048         : ProducerBase(), moduleDescription_(), previousParentages_(), previousParentageIds_() {}
0049 
0050     EDFilterBase::~EDFilterBase() {}
0051 
0052     bool EDFilterBase::doEvent(EventTransitionInfo const& info,
0053                                ActivityRegistry* act,
0054                                ModuleCallingContext const* mcc) {
0055       EventSignalsSentry sentry(act, mcc);
0056       Event e(info, moduleDescription_, mcc);
0057       e.setConsumer(this);
0058       const auto streamIndex = e.streamID().value();
0059       e.setProducer(
0060           this, &previousParentages_[streamIndex], hasAcquire() ? &gotBranchIDsFromAcquire_[streamIndex] : nullptr);
0061       ESParentContext parentC(mcc);
0062       const EventSetup c{
0063           info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC};
0064       bool returnValue = this->filter(e.streamID(), e, c);
0065       commit_(e, &previousParentageIds_[streamIndex]);
0066       return returnValue;
0067     }
0068 
0069     void EDFilterBase::doAcquire(EventTransitionInfo const& info,
0070                                  ActivityRegistry* act,
0071                                  ModuleCallingContext const* mcc,
0072                                  WaitingTaskHolder&& holder) {
0073       EventAcquireSignalsSentry sentry(act, mcc);
0074       Event e(info, moduleDescription_, mcc);
0075       e.setConsumer(this);
0076       const auto streamIndex = e.streamID().value();
0077       e.setProducerForAcquire(this, nullptr, gotBranchIDsFromAcquire_[streamIndex]);
0078       ESParentContext parentC(mcc);
0079       const EventSetup c{
0080           info, static_cast<unsigned int>(Transition::Event), esGetTokenIndices(Transition::Event), parentC};
0081       this->doAcquire_(e.streamID(), e, c, std::move(holder));
0082     }
0083 
0084     void EDFilterBase::doTransformAsync(WaitingTaskHolder iTask,
0085                                         size_t iTransformIndex,
0086                                         EventPrincipal const& iEvent,
0087                                         ActivityRegistry* iAct,
0088                                         ModuleCallingContext iMCC,
0089                                         ServiceWeakToken const& iToken) noexcept {
0090       EventForTransformer ev(iEvent, iMCC);
0091       transformAsync_(iTask, iTransformIndex, ev, iAct, iToken);
0092     }
0093 
0094     size_t EDFilterBase::transformIndex_(edm::ProductDescription const& iBranch) const noexcept { return -1; }
0095     ProductResolverIndex EDFilterBase::transformPrefetch_(std::size_t iIndex) const noexcept { return 0; }
0096     void EDFilterBase::transformAsync_(WaitingTaskHolder iTask,
0097                                        std::size_t iIndex,
0098                                        edm::EventForTransformer& iEvent,
0099                                        edm::ActivityRegistry* iAct,
0100                                        ServiceWeakToken const& iToken) const noexcept {}
0101 
0102     void EDFilterBase::doPreallocate(PreallocationConfiguration const& iPrealloc) {
0103       const auto nStreams = iPrealloc.numberOfStreams();
0104       previousParentages_ = std::make_unique<std::vector<BranchID>[]>(nStreams);
0105       if (hasAcquire()) {
0106         gotBranchIDsFromAcquire_ = std::make_unique<std::vector<BranchID>[]>(nStreams);
0107       }
0108       previousParentageIds_ = std::make_unique<ParentageID[]>(nStreams);
0109       preallocStreams(nStreams);
0110       preallocRuns(iPrealloc.numberOfRuns());
0111       preallocRunsSummary(iPrealloc.numberOfRuns());
0112       preallocLumis(iPrealloc.numberOfLuminosityBlocks());
0113       preallocLumisSummary(iPrealloc.numberOfLuminosityBlocks());
0114       preallocate(iPrealloc);
0115     }
0116 
0117     void EDFilterBase::doBeginJob() { this->beginJob(); }
0118 
0119     void EDFilterBase::doEndJob() { this->endJob(); }
0120 
0121     void EDFilterBase::doBeginProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0122       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0123       processBlock.setConsumer(this);
0124       ProcessBlock const& constProcessBlock = processBlock;
0125       this->doBeginProcessBlock_(constProcessBlock);
0126       processBlock.setProducer(this);
0127       this->doBeginProcessBlockProduce_(processBlock);
0128       commit_(processBlock);
0129     }
0130 
0131     void EDFilterBase::doAccessInputProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0132       ProcessBlock processBlock(pbp, moduleDescription_, mcc, false);
0133       processBlock.setConsumer(this);
0134       ProcessBlock const& constProcessBlock = processBlock;
0135       this->doAccessInputProcessBlock_(constProcessBlock);
0136     }
0137 
0138     void EDFilterBase::doEndProcessBlock(ProcessBlockPrincipal const& pbp, ModuleCallingContext const* mcc) {
0139       ProcessBlock processBlock(pbp, moduleDescription_, mcc, true);
0140       processBlock.setConsumer(this);
0141       ProcessBlock const& constProcessBlock = processBlock;
0142       this->doEndProcessBlock_(constProcessBlock);
0143       processBlock.setProducer(this);
0144       this->doEndProcessBlockProduce_(processBlock);
0145       commit_(processBlock);
0146     }
0147 
0148     void EDFilterBase::doBeginRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0149       Run r(info, moduleDescription_, mcc, false);
0150       r.setConsumer(this);
0151       Run const& cnstR = r;
0152       ESParentContext parentC(mcc);
0153       const EventSetup c{
0154           info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC};
0155       this->doBeginRun_(cnstR, c);
0156       this->doBeginRunSummary_(cnstR, c);
0157       r.setProducer(this);
0158       this->doBeginRunProduce_(r, c);
0159       commit_(r);
0160     }
0161 
0162     void EDFilterBase::doEndRun(RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0163       Run r(info, moduleDescription_, mcc, true);
0164       r.setConsumer(this);
0165       r.setProducer(this);
0166       Run const& cnstR = r;
0167       ESParentContext parentC(mcc);
0168       const EventSetup c{
0169           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
0170       this->doEndRunSummary_(r, c);
0171       this->doEndRunProduce_(r, c);
0172       this->doEndRun_(cnstR, c);
0173       commit_(r);
0174     }
0175 
0176     void EDFilterBase::doBeginLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0177       LuminosityBlock lb(info, moduleDescription_, mcc, false);
0178       lb.setConsumer(this);
0179       LuminosityBlock const& cnstLb = lb;
0180       ESParentContext parentC(mcc);
0181       const EventSetup c{info,
0182                          static_cast<unsigned int>(Transition::BeginLuminosityBlock),
0183                          esGetTokenIndices(Transition::BeginLuminosityBlock),
0184                          parentC};
0185       this->doBeginLuminosityBlock_(cnstLb, c);
0186       this->doBeginLuminosityBlockSummary_(cnstLb, c);
0187       lb.setProducer(this);
0188       this->doBeginLuminosityBlockProduce_(lb, c);
0189       commit_(lb);
0190     }
0191 
0192     void EDFilterBase::doEndLuminosityBlock(LumiTransitionInfo const& info, ModuleCallingContext const* mcc) {
0193       LuminosityBlock lb(info, moduleDescription_, mcc, true);
0194       lb.setConsumer(this);
0195       lb.setProducer(this);
0196       LuminosityBlock const& cnstLb = lb;
0197       ESParentContext parentC(mcc);
0198       const EventSetup c{info,
0199                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
0200                          esGetTokenIndices(Transition::EndLuminosityBlock),
0201                          parentC};
0202       this->doEndLuminosityBlockSummary_(cnstLb, c);
0203       this->doEndLuminosityBlockProduce_(lb, c);
0204       this->doEndLuminosityBlock_(cnstLb, c);
0205       commit_(lb);
0206     }
0207 
0208     void EDFilterBase::doBeginStream(StreamID id) { doBeginStream_(id); }
0209     void EDFilterBase::doEndStream(StreamID id) { doEndStream_(id); }
0210     void EDFilterBase::doStreamBeginRun(StreamID id, RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0211       Run r(info, moduleDescription_, mcc, false);
0212       r.setConsumer(this);
0213       ESParentContext parentC(mcc);
0214       const EventSetup c{
0215           info, static_cast<unsigned int>(Transition::BeginRun), esGetTokenIndices(Transition::BeginRun), parentC};
0216       this->doStreamBeginRun_(id, r, c);
0217     }
0218     void EDFilterBase::doStreamEndRun(StreamID id, RunTransitionInfo const& info, ModuleCallingContext const* mcc) {
0219       Run r(info, moduleDescription_, mcc, true);
0220       r.setConsumer(this);
0221       ESParentContext parentC(mcc);
0222       const EventSetup c{
0223           info, static_cast<unsigned int>(Transition::EndRun), esGetTokenIndices(Transition::EndRun), parentC};
0224       this->doStreamEndRun_(id, r, c);
0225       this->doStreamEndRunSummary_(id, r, c);
0226     }
0227     void EDFilterBase::doStreamBeginLuminosityBlock(StreamID id,
0228                                                     LumiTransitionInfo const& info,
0229                                                     ModuleCallingContext const* mcc) {
0230       LuminosityBlock lb(info, moduleDescription_, mcc, false);
0231       lb.setConsumer(this);
0232       ESParentContext parentC(mcc);
0233       const EventSetup c{info,
0234                          static_cast<unsigned int>(Transition::BeginLuminosityBlock),
0235                          esGetTokenIndices(Transition::BeginLuminosityBlock),
0236                          parentC};
0237       this->doStreamBeginLuminosityBlock_(id, lb, c);
0238     }
0239 
0240     void EDFilterBase::doStreamEndLuminosityBlock(StreamID id,
0241                                                   LumiTransitionInfo const& info,
0242                                                   ModuleCallingContext const* mcc) {
0243       LuminosityBlock lb(info, moduleDescription_, mcc, true);
0244       lb.setConsumer(this);
0245       ESParentContext parentC(mcc);
0246       const EventSetup c{info,
0247                          static_cast<unsigned int>(Transition::EndLuminosityBlock),
0248                          esGetTokenIndices(Transition::EndLuminosityBlock),
0249                          parentC};
0250       this->doStreamEndLuminosityBlock_(id, lb, c);
0251       this->doStreamEndLuminosityBlockSummary_(id, lb, c);
0252     }
0253 
0254     void EDFilterBase::preallocStreams(unsigned int) {}
0255     void EDFilterBase::preallocRuns(unsigned int) {}
0256     void EDFilterBase::preallocRunsSummary(unsigned int) {}
0257     void EDFilterBase::preallocLumis(unsigned int) {}
0258     void EDFilterBase::preallocLumisSummary(unsigned int) {}
0259     void EDFilterBase::preallocate(PreallocationConfiguration const&) {}
0260     void EDFilterBase::doBeginStream_(StreamID id) {}
0261     void EDFilterBase::doEndStream_(StreamID id) {}
0262     void EDFilterBase::doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c) {}
0263     void EDFilterBase::doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c) {}
0264     void EDFilterBase::doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c) {}
0265     void EDFilterBase::doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c) {}
0266     void EDFilterBase::doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c) {}
0267     void EDFilterBase::doStreamEndLuminosityBlockSummary_(StreamID id,
0268                                                           LuminosityBlock const& lbp,
0269                                                           EventSetup const& c) {}
0270 
0271     void EDFilterBase::doBeginProcessBlock_(ProcessBlock const&) {}
0272     void EDFilterBase::doAccessInputProcessBlock_(ProcessBlock const&) {}
0273     void EDFilterBase::doEndProcessBlock_(ProcessBlock const&) {}
0274     void EDFilterBase::doBeginRun_(Run const& rp, EventSetup const& c) {}
0275     void EDFilterBase::doEndRun_(Run const& rp, EventSetup const& c) {}
0276     void EDFilterBase::doBeginRunSummary_(Run const& rp, EventSetup const& c) {}
0277     void EDFilterBase::doEndRunSummary_(Run const& rp, EventSetup const& c) {}
0278 
0279     void EDFilterBase::doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0280     void EDFilterBase::doEndLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c) {}
0281     void EDFilterBase::doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c) {}
0282     void EDFilterBase::doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c) {}
0283 
0284     void EDFilterBase::doBeginProcessBlockProduce_(ProcessBlock&) {}
0285     void EDFilterBase::doEndProcessBlockProduce_(ProcessBlock&) {}
0286     void EDFilterBase::doBeginRunProduce_(Run& rp, EventSetup const& c) {}
0287     void EDFilterBase::doEndRunProduce_(Run& rp, EventSetup const& c) {}
0288     void EDFilterBase::doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0289     void EDFilterBase::doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c) {}
0290 
0291     void EDFilterBase::clearInputProcessBlockCaches() {}
0292 
0293     void EDFilterBase::doAcquire_(StreamID, Event const&, EventSetup const&, WaitingTaskHolder&&) {}
0294 
0295     void EDFilterBase::fillDescriptions(ConfigurationDescriptions& descriptions) {
0296       ParameterSetDescription desc;
0297       desc.setUnknown();
0298       descriptions.addDefault(desc);
0299     }
0300 
0301     void EDFilterBase::prevalidate(ConfigurationDescriptions& iConfig) { edmodule_mightGet_config(iConfig); }
0302 
0303     static const std::string kBaseType("EDFilter");
0304 
0305     const std::string& EDFilterBase::baseType() { return kBaseType; }
0306 
0307   }  // namespace global
0308 }  // 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!