CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends
edm::one::OutputModuleBase Class Referenceabstract

#include <OutputModuleBase.h>

Inheritance diagram for edm::one::OutputModuleBase:
edm::core::OutputModuleCore edm::EDConsumerBase edm::one::OutputModule< T > edm::one::outputmodule::InputFileWatcher edm::one::outputmodule::LuminosityBlockCacheHolder< C > edm::one::outputmodule::LuminosityBlockWatcher edm::one::outputmodule::RunCacheHolder< C > edm::one::outputmodule::RunWatcher edm::one::OutputModule< edm::one::WatchLuminosityBlocks > edm::one::OutputModule< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks > edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks > edm::one::OutputModule< RunCache< int >, LuminosityBlockCache< int > > edm::one::OutputModule< WatchInputFiles > edm::one::OutputModule< WatchInputFiles, RunCache< int >, LuminosityBlockCache< int > > edm::one::OutputModule<>

Public Types

typedef OutputModuleBase ModuleType
 
- Public Types inherited from edm::core::OutputModuleCore
typedef OutputModuleCore ModuleType
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 

Public Member Functions

virtual SerialTaskQueueglobalLuminosityBlocksQueue ()
 
virtual SerialTaskQueueglobalRunsQueue ()
 
OutputModuleBaseoperator= (OutputModuleBase const &)=delete
 
 OutputModuleBase (ParameterSet const &pset)
 
 OutputModuleBase (OutputModuleBase const &)=delete
 
SharedResourcesAcquirersharedResourcesAcquirer ()
 
SubProcessParentageHelper const * subProcessParentageHelper () const
 
virtual bool wantsGlobalLuminosityBlocks () const =0
 
virtual bool wantsGlobalRuns () const =0
 
virtual bool wantsInputProcessBlocks () const =0
 
virtual bool wantsProcessBlocks () const =0
 
bool wantsStreamLuminosityBlocks () const
 
bool wantsStreamRuns () const
 
- Public Member Functions inherited from edm::core::OutputModuleCore
BranchIDLists const * branchIDLists () const
 
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
std::array< bool, NumBranchTypes > const & hasNewlyDroppedBranch () const
 
SelectedProductsForBranchType const & keptProducts () const
 
int maxEvents () const
 
const ModuleDescriptionmoduleDescription () const
 
OutputModuleCoreoperator= (OutputModuleCore const &)=delete
 
 OutputModuleCore (ParameterSet const &pset)
 
 OutputModuleCore (OutputModuleCore const &)=delete
 
OutputProcessBlockHelper const & outputProcessBlockHelper () const
 
std::string const & processName () const
 
int remainingEvents () const
 
bool selected (BranchDescription const &desc) const
 
void selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)
 
ThinnedAssociationsHelper const * thinnedAssociationsHelper () const
 
bool wantAllEvents () const
 
 ~OutputModuleCore () override
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
void convertCurrentProcessAlias (std::string const &processName)
 Convert "@currentProcess" in InputTag process names to the actual current process name. More...
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ESResolverIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
std::vector< ESResolverIndex > const & esGetTokenIndicesVector (edm::Transition iTrans) const
 
std::vector< ESRecordIndex > const & esGetTokenRecordIndicesVector (edm::Transition iTrans) const
 
ProductResolverIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
std::vector< ProductResolverIndexAndSkipBit > const & itemsToGetFrom (BranchType iType) const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const *> *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
void selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Protected Member Functions

void configure (OutputModuleDescription const &desc)
 
void doBeginJob ()
 
bool doEvent (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
 
void doPreallocate (PreallocationConfiguration const &)
 
- Protected Member Functions inherited from edm::core::OutputModuleCore
void configure (OutputModuleDescription const &desc)
 
ModuleDescription const & description () const
 
void doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
void doBeginJob_ ()
 
bool doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
 
void doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
bool doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)
 
void doEndJob ()
 
bool doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
 
void doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
bool doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)
 
bool doEvent_ (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
 
void doPreallocate_ (PreallocationConfiguration const &)
 
std::map< BranchID::value_type, BranchID::value_type > const & droppedBranchIDToKeptBranchID ()
 
virtual void preallocLumis (unsigned int)
 
ParameterSetID selectorConfig () const
 
void setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int >>> const &outputModulePathPositions, bool anyProductProduced)
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< Bconsumes (edm::InputTag tag) noexcept
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<Transition Tr = Transition::Event>
constexpr auto esConsumes ()
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag)
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
void resetItemsToGetFrom (BranchType iType)
 

Private Member Functions

virtual SharedResourcesAcquirer createAcquirer ()
 
bool hasAcquire () const
 
virtual void preActionBeforeRunEventAsync (WaitingTaskHolder iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) const
 
std::string workerType () const
 

Private Attributes

SerialTaskQueue luminosityBlockQueue_
 
SharedResourcesAcquirer resourcesAcquirer_
 
SerialTaskQueue runQueue_
 
SubProcessParentageHelper const * subProcessParentageHelper_
 

Friends

template<typename T >
class ::edm::OutputModuleCommunicatorT
 
template<typename T >
class ::edm::WorkerT
 
template<typename U >
class edm::maker::ModuleHolderT
 

Additional Inherited Members

- Static Public Member Functions inherited from edm::core::OutputModuleCore
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 
- Protected Attributes inherited from edm::core::OutputModuleCore
std::atomic< int > remainingEvents_
 

Detailed Description

Definition at line 34 of file OutputModuleBase.h.

Member Typedef Documentation

◆ ModuleType

Definition at line 42 of file OutputModuleBase.h.

Constructor & Destructor Documentation

◆ OutputModuleBase() [1/2]

OutputModuleBase::OutputModuleBase ( ParameterSet const &  pset)
explicit

Definition at line 47 of file OutputModuleBase.cc.

47 : core::OutputModuleCore(pset) {}

◆ OutputModuleBase() [2/2]

edm::one::OutputModuleBase::OutputModuleBase ( OutputModuleBase const &  )
delete

Member Function Documentation

◆ configure()

void OutputModuleBase::configure ( OutputModuleDescription const &  desc)
protected

Definition at line 49 of file OutputModuleBase.cc.

References edm::core::OutputModuleCore::configure(), submitPVResolutionJobs::desc, and subProcessParentageHelper_.

49  {
51  subProcessParentageHelper_ = desc.subProcessParentageHelper_;
52  }
SubProcessParentageHelper const * subProcessParentageHelper_
void configure(OutputModuleDescription const &desc)

◆ createAcquirer()

SharedResourcesAcquirer OutputModuleBase::createAcquirer ( )
privatevirtual

Definition at line 54 of file OutputModuleBase.cc.

Referenced by doBeginJob().

54  {
56  std::vector<std::shared_ptr<SerialTaskQueue>>(1, std::make_shared<SerialTaskQueue>())};
57  }

◆ doBeginJob()

void OutputModuleBase::doBeginJob ( )
protected

◆ doEvent()

bool OutputModuleBase::doEvent ( EventTransitionInfo const &  info,
ActivityRegistry act,
ModuleCallingContext const *  mcc 
)
protected

Definition at line 68 of file OutputModuleBase.cc.

References edm::core::OutputModuleCore::doEvent_(), info(), and edm::core::OutputModuleCore::remainingEvents_.

70  {
72  if (remainingEvents_ > 0) {
74  }
75  return true;
76  }
static const TGPicture * info(bool iBackgroundIsBlack)
std::atomic< int > remainingEvents_
bool doEvent_(EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)

◆ doPreallocate()

void OutputModuleBase::doPreallocate ( PreallocationConfiguration const &  iPC)
protected

Definition at line 59 of file OutputModuleBase.cc.

References edm::core::OutputModuleCore::doPreallocate_().

59  {
61  }
void doPreallocate_(PreallocationConfiguration const &)

◆ globalLuminosityBlocksQueue()

virtual SerialTaskQueue* edm::one::OutputModuleBase::globalLuminosityBlocksQueue ( )
inlinevirtual

◆ globalRunsQueue()

virtual SerialTaskQueue* edm::one::OutputModuleBase::globalRunsQueue ( )
inlinevirtual

◆ hasAcquire()

bool edm::one::OutputModuleBase::hasAcquire ( ) const
inlineprivate

Definition at line 86 of file OutputModuleBase.h.

86 { return false; }

◆ operator=()

OutputModuleBase& edm::one::OutputModuleBase::operator= ( OutputModuleBase const &  )
delete

◆ preActionBeforeRunEventAsync()

virtual void edm::one::OutputModuleBase::preActionBeforeRunEventAsync ( WaitingTaskHolder  iTask,
ModuleCallingContext const &  iModuleCallingContext,
Principal const &  iPrincipal 
) const
inlineprivatevirtual

Reimplemented in edm::PoolOutputModule.

Definition at line 82 of file OutputModuleBase.h.

84  {}

◆ sharedResourcesAcquirer()

SharedResourcesAcquirer& edm::one::OutputModuleBase::sharedResourcesAcquirer ( )
inline

Definition at line 59 of file OutputModuleBase.h.

References resourcesAcquirer_.

59 { return resourcesAcquirer_; }
SharedResourcesAcquirer resourcesAcquirer_

◆ subProcessParentageHelper()

SubProcessParentageHelper const* edm::one::OutputModuleBase::subProcessParentageHelper ( ) const
inline

Definition at line 61 of file OutputModuleBase.h.

References subProcessParentageHelper_.

Referenced by edm::PoolOutputModule::updateBranchParents().

SubProcessParentageHelper const * subProcessParentageHelper_

◆ wantsGlobalLuminosityBlocks()

virtual bool edm::one::OutputModuleBase::wantsGlobalLuminosityBlocks ( ) const
pure virtual

◆ wantsGlobalRuns()

virtual bool edm::one::OutputModuleBase::wantsGlobalRuns ( ) const
pure virtual

◆ wantsInputProcessBlocks()

virtual bool edm::one::OutputModuleBase::wantsInputProcessBlocks ( ) const
pure virtual

◆ wantsProcessBlocks()

virtual bool edm::one::OutputModuleBase::wantsProcessBlocks ( ) const
pure virtual

◆ wantsStreamLuminosityBlocks()

bool edm::one::OutputModuleBase::wantsStreamLuminosityBlocks ( ) const
inline

Definition at line 55 of file OutputModuleBase.h.

55 { return false; };

◆ wantsStreamRuns()

bool edm::one::OutputModuleBase::wantsStreamRuns ( ) const
inline

Definition at line 54 of file OutputModuleBase.h.

54 { return false; }

◆ workerType()

std::string edm::one::OutputModuleBase::workerType ( ) const
inlineprivate

Definition at line 80 of file OutputModuleBase.h.

80 { return "WorkerT<edm::one::OutputModuleBase>"; }

Friends And Related Function Documentation

◆ ::edm::OutputModuleCommunicatorT

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

Definition at line 41 of file OutputModuleBase.h.

◆ ::edm::WorkerT

template<typename T >
friend class ::edm::WorkerT
friend

Definition at line 39 of file OutputModuleBase.h.

◆ edm::maker::ModuleHolderT

template<typename U >
friend class edm::maker::ModuleHolderT
friend

Definition at line 37 of file OutputModuleBase.h.

Member Data Documentation

◆ luminosityBlockQueue_

SerialTaskQueue edm::one::OutputModuleBase::luminosityBlockQueue_
private

Definition at line 76 of file OutputModuleBase.h.

◆ resourcesAcquirer_

SharedResourcesAcquirer edm::one::OutputModuleBase::resourcesAcquirer_
private

Definition at line 74 of file OutputModuleBase.h.

Referenced by doBeginJob(), and sharedResourcesAcquirer().

◆ runQueue_

SerialTaskQueue edm::one::OutputModuleBase::runQueue_
private

Definition at line 75 of file OutputModuleBase.h.

◆ subProcessParentageHelper_

SubProcessParentageHelper const* edm::one::OutputModuleBase::subProcessParentageHelper_
private

Definition at line 72 of file OutputModuleBase.h.

Referenced by configure(), and subProcessParentageHelper().