edm::OutputModuleCommunicatorT< T > Class Template Reference

#include <OutputModuleCommunicatorT.h>

Inheritance diagram for edm::OutputModuleCommunicatorT< T >:

Public Member Functions
void	closeFile () override
void	configure (edm::OutputModuleDescription const &desc) override
ModuleDescription const &	description () const override
edm::SelectedProductsForBranchType const &	keptProducts () const override
bool	limitReached () const override
void	openFile (edm::FileBlock const &fb) override
	OutputModuleCommunicatorT (T *iModule)
void	selectProducts (edm::ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &) override
void	setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int > > > const &outputModulePathPositions, bool anyProductProduced) override
bool	shouldWeCloseFile () const override
bool	wantAllEvents () const override
void	writeLumiAsync (WaitingTaskHolder iTask, edm::LuminosityBlockPrincipal const &lbp, ProcessContext const *, ActivityRegistry *) override
void	writeProcessBlockAsync (WaitingTaskHolder iTask, ProcessBlockPrincipal const &, ProcessContext const *, ActivityRegistry *) override
void	writeRunAsync (WaitingTaskHolder iTask, edm::RunPrincipal const &rp, ProcessContext const *, ActivityRegistry *, MergeableRunProductMetadata const *) override
Public Member Functions inherited from edm::OutputModuleCommunicator
OutputModuleCommunicator &	operator= (const OutputModuleCommunicator &)=delete
	OutputModuleCommunicator ()=default
	OutputModuleCommunicator (const OutputModuleCommunicator &)=delete
virtual	~OutputModuleCommunicator ()

Static Public Member Functions
static std::unique_ptr< edm::OutputModuleCommunicator >	createIfNeeded (T *iMod)

Private Member Functions
T &	module () const

Private Attributes
T *	module_

Detailed Description

template<typename T>
class edm::OutputModuleCommunicatorT< T >

Definition at line 33 of file OutputModuleCommunicatorT.h.

Constructor & Destructor Documentation

OutputModuleCommunicatorT()

template<typename T >

edm::OutputModuleCommunicatorT< T >::OutputModuleCommunicatorT ( T *  iModule )

inline

Definition at line 35 of file OutputModuleCommunicatorT.h.

: module_(iModule) {}

Member Function Documentation

closeFile()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::closeFile ( )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 51 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                               {
    module().doCloseFile();
  }

configure()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::configure ( edm::OutputModuleDescription const &  desc )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 190 of file OutputModuleCommunicatorT.cc.

References submitPVResolutionJobs::desc, and callgraph::module.

                                                                                  {
    module().configure(desc);
  }

createIfNeeded()

template<typename T >

static std::unique_ptr<edm::OutputModuleCommunicator> edm::OutputModuleCommunicatorT< T >::createIfNeeded ( T *  iMod )

inlinestatic

Definition at line 79 of file OutputModuleCommunicatorT.h.

References edm::impl::createCommunicatorIfNeeded(), and eostools::move().

                                                                              {
      return std::move(impl::createCommunicatorIfNeeded(iMod));
    }

description()

template<typename T >

ModuleDescription const & edm::OutputModuleCommunicatorT< T >::description ( ) const

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 214 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                                           {
    return module().description();
  }

keptProducts()

template<typename T >

edm::SelectedProductsForBranchType const & edm::OutputModuleCommunicatorT< T >::keptProducts ( ) const

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 195 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                                                           {
    return module().keptProducts();
  }

limitReached()

template<typename T >

bool edm::OutputModuleCommunicatorT< T >::limitReached ( ) const

overridevirtual

Returns

true if OutputModule has reached its limit on maximum number of events it wants to see

Implements edm::OutputModuleCommunicator.

Definition at line 185 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                        {
    return module().limitReached();
  }

module()

template<typename T >

T& edm::OutputModuleCommunicatorT< T >::module ( ) const

inlineprivate

Definition at line 84 of file OutputModuleCommunicatorT.h.

References edm::OutputModuleCommunicatorT< T >::module_.

{ return *module_; }

openFile()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::openFile ( edm::FileBlock const &  fb )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 61 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                                    {
    module().doOpenFile(fb);
  }

selectProducts()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::selectProducts ( edm::ProductRegistry const &  preg, ThinnedAssociationsHelper const &  helper, ProcessBlockHelperBase const &  processBlockHelper  )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 200 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                                                                      {
    module().selectProducts(preg, helper, processBlockHelper);
  }

setEventSelectionInfo()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::setEventSelectionInfo ( std::map< std::string, std::vector< std::pair< std::string, int > > > const &  outputModulePathPositions, bool  anyProductProduced  )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 207 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                               {
    module().setEventSelectionInfo(outputModulePathPositions, anyProductProduced);
  }

shouldWeCloseFile()

template<typename T >

bool edm::OutputModuleCommunicatorT< T >::shouldWeCloseFile ( ) const

overridevirtual

Returns

true if output module wishes to close its file

Implements edm::OutputModuleCommunicator.

Definition at line 56 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                             {
    return module().shouldWeCloseFile();
  }

wantAllEvents()

template<typename T >

bool edm::OutputModuleCommunicatorT< T >::wantAllEvents ( ) const

overridevirtual

Returns

true if no event filtering is applied to OutputModule

Implements edm::OutputModuleCommunicator.

Definition at line 180 of file OutputModuleCommunicatorT.cc.

References callgraph::module.

                                                         {
    return module().wantAllEvents();
  }

writeLumiAsync()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::writeLumiAsync ( WaitingTaskHolder  iTask, edm::LuminosityBlockPrincipal const &  lbp, ProcessContext const *  processContext, ActivityRegistry *  activityRegistry  )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 146 of file OutputModuleCommunicatorT.cc.

References edm::LuminosityBlockPrincipal::beginTime(), CMS_SA_ALLOW, submitPVResolutionJobs::desc, edmLumisInFiles::description, edm::WaitingTaskHolder::doneWaiting(), edm::WaitingTaskHolder::group(), edm::LuminosityBlockPrincipal::id(), edm::LuminosityBlockPrincipal::index(), edm::RunPrincipal::index(), edm::ServiceRegistry::instance(), edm::GlobalContext::kWriteLuminosityBlock, edm::make_sentry(), mod(), callgraph::module, eostools::move(), edm::ActivityRegistry::postModuleWriteLumiSignal_, edm::ServiceRegistry::presentToken(), edm::LuminosityBlockPrincipal::runPrincipal(), submitPVValidationJobs::t, and unpackBuffers-CaloStage2::token.

                                                                                        {
    auto token = ServiceRegistry::instance().presentToken();
    GlobalContext globalContext(GlobalContext::Transition::kWriteLuminosityBlock,
                                lbp.id(),
                                lbp.runPrincipal().index(),
                                lbp.index(),
                                lbp.beginTime(),
                                processContext);
    auto t = [&mod = module(), &lbp, activityRegistry, token, globalContext, desc = &description(), iTask]() mutable {
      std::exception_ptr ex;
      // Caught exception is propagated via WaitingTaskHolder
      CMS_SA_ALLOW try {
        ServiceRegistry::Operate op(token);

        ParentContext parentContext(&globalContext);
        ModuleCallingContext mcc(desc);
        ModuleContextSentry moduleContextSentry(&mcc, parentContext);
        activityRegistry->preModuleWriteLumiSignal_(globalContext, mcc);
        auto sentry(make_sentry(activityRegistry, [&globalContext, &mcc](ActivityRegistry* ar) {
          ar->postModuleWriteLumiSignal_(globalContext, mcc);
        }));
        mod.doWriteLuminosityBlock(lbp, &mcc);
      } catch (...) {
        ex = std::current_exception();
      }
      iTask.doneWaiting(ex);
    };
    async(module(), *iTask.group(), std::move(t));
  }

writeProcessBlockAsync()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::writeProcessBlockAsync ( WaitingTaskHolder  iTask, ProcessBlockPrincipal const &  processBlockPrincipal, ProcessContext const *  processContext, ActivityRegistry *  activityRegistry  )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 66 of file OutputModuleCommunicatorT.cc.

References CMS_SA_ALLOW, submitPVResolutionJobs::desc, edmLumisInFiles::description, edm::WaitingTaskHolder::doneWaiting(), edm::WaitingTaskHolder::group(), edm::ServiceRegistry::instance(), edm::LuminosityBlockIndex::invalidLuminosityBlockIndex(), edm::RunIndex::invalidRunIndex(), edm::Timestamp::invalidTimestamp(), edm::GlobalContext::kWriteProcessBlock, edm::make_sentry(), mod(), callgraph::module, eostools::move(), edm::ActivityRegistry::postModuleWriteProcessBlockSignal_, edm::ActivityRegistry::preModuleWriteProcessBlockSignal_, edm::ServiceRegistry::presentToken(), submitPVValidationJobs::t, and unpackBuffers-CaloStage2::token.

                                                                                                {
    auto token = ServiceRegistry::instance().presentToken();
    GlobalContext globalContext(GlobalContext::Transition::kWriteProcessBlock,
                                LuminosityBlockID(),
                                RunIndex::invalidRunIndex(),
                                LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                Timestamp::invalidTimestamp(),
                                processContext);
    auto t = [&mod = module(),
              &processBlockPrincipal,
              globalContext,
              token,
              desc = &description(),
              activityRegistry,
              iTask]() mutable {
      std::exception_ptr ex;
      // Caught exception is propagated via WaitingTaskHolder
      CMS_SA_ALLOW try {
        ServiceRegistry::Operate op(token);
        ParentContext parentContext(&globalContext);
        ModuleCallingContext mcc(desc);
        ModuleContextSentry moduleContextSentry(&mcc, parentContext);
        activityRegistry->preModuleWriteProcessBlockSignal_(globalContext, mcc);
        auto sentry(make_sentry(activityRegistry, [&globalContext, &mcc](ActivityRegistry* ar) {
          ar->postModuleWriteProcessBlockSignal_(globalContext, mcc);
        }));
        mod.doWriteProcessBlock(processBlockPrincipal, &mcc);
      } catch (...) {
        ex = std::current_exception();
      }
      iTask.doneWaiting(ex);
    };
    async(module(), *iTask.group(), std::move(t));
  }

writeRunAsync()

template<typename T >

void edm::OutputModuleCommunicatorT< T >::writeRunAsync ( WaitingTaskHolder  iTask, edm::RunPrincipal const &  rp, ProcessContext const *  processContext, ActivityRegistry *  activityRegistry, MergeableRunProductMetadata const *  mergeableRunProductMetadata  )

overridevirtual

Implements edm::OutputModuleCommunicator.

Definition at line 105 of file OutputModuleCommunicatorT.cc.

References CMS_SA_ALLOW, submitPVResolutionJobs::desc, edmLumisInFiles::description, edm::WaitingTaskHolder::doneWaiting(), edm::RunPrincipal::endTime(), edm::WaitingTaskHolder::group(), edm::RunPrincipal::index(), edm::ServiceRegistry::instance(), edm::LuminosityBlockIndex::invalidLuminosityBlockIndex(), edm::GlobalContext::kWriteRun, edm::make_sentry(), mod(), callgraph::module, eostools::move(), edm::ActivityRegistry::postModuleWriteRunSignal_, edm::ActivityRegistry::preModuleWriteRunSignal_, edm::ServiceRegistry::presentToken(), edm::RunPrincipal::run(), submitPVValidationJobs::t, and unpackBuffers-CaloStage2::token.

                                                                                                                   {
    auto token = ServiceRegistry::instance().presentToken();
    GlobalContext globalContext(GlobalContext::Transition::kWriteRun,
                                LuminosityBlockID(rp.run(), 0),
                                rp.index(),
                                LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                rp.endTime(),
                                processContext);
    auto t = [&mod = module(),
              &rp,
              globalContext,
              token,
              desc = &description(),
              activityRegistry,
              mergeableRunProductMetadata,
              iTask]() mutable {
      std::exception_ptr ex;
      // Caught exception is propagated via WaitingTaskHolder
      CMS_SA_ALLOW try {
        ServiceRegistry::Operate op(token);
        ParentContext parentContext(&globalContext);
        ModuleCallingContext mcc(desc);
        ModuleContextSentry moduleContextSentry(&mcc, parentContext);
        activityRegistry->preModuleWriteRunSignal_(globalContext, mcc);
        auto sentry(make_sentry(activityRegistry, [&globalContext, &mcc](ActivityRegistry* ar) {
          ar->postModuleWriteRunSignal_(globalContext, mcc);
        }));
        mod.doWriteRun(rp, &mcc, mergeableRunProductMetadata);
      } catch (...) {
        ex = std::current_exception();
      }
      iTask.doneWaiting(ex);
    };
    async(module(), *iTask.group(), std::move(t));
  }

Member Data Documentation

module_

template<typename T >

T* edm::OutputModuleCommunicatorT< T >::module_

private

Definition at line 85 of file OutputModuleCommunicatorT.h.

Referenced by edm::OutputModuleCommunicatorT< T >::module().