CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions
edm::OutputModuleCommunicator Class Referenceabstract

#include "FWCore/Framework/interface/OutputModuleCommunicator.h"

Inheritance diagram for edm::OutputModuleCommunicator:
edm::OutputModuleCommunicatorT< T >

Public Member Functions

virtual void closeFile ()=0
 
virtual void configure (OutputModuleDescription const &desc)=0
 
virtual ModuleDescription const & description () const =0
 
virtual SelectedProductsForBranchType const & keptProducts () const =0
 
virtual bool limitReached () const =0
 
virtual void openFile (FileBlock const &fb)=0
 
 OutputModuleCommunicator ()=default
 
virtual void selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)=0
 
virtual void setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int > > > const &outputModulePathPositions, bool anyProductProduced)=0
 
virtual bool shouldWeCloseFile () const =0
 
virtual bool wantAllEvents () const =0
 
virtual void writeLumiAsync (WaitingTaskHolder iTask, LuminosityBlockPrincipal const &lbp, ProcessContext const *, ActivityRegistry *)=0
 
virtual void writeRunAsync (WaitingTaskHolder iTask, RunPrincipal const &rp, ProcessContext const *, ActivityRegistry *)=0
 
virtual ~OutputModuleCommunicator ()
 

Private Member Functions

const OutputModuleCommunicatoroperator= (const OutputModuleCommunicator &)=delete
 
 OutputModuleCommunicator (const OutputModuleCommunicator &)=delete
 

Detailed Description

Description: Base class used by the framework to communicate with an OutputModule

Usage: <usage>

Definition at line 38 of file OutputModuleCommunicator.h.

Constructor & Destructor Documentation

edm::OutputModuleCommunicator::OutputModuleCommunicator ( )
default
OutputModuleCommunicator::~OutputModuleCommunicator ( )
virtual

Definition at line 20 of file OutputModuleCommunicator.cc.

21 {
22 }
edm::OutputModuleCommunicator::OutputModuleCommunicator ( const OutputModuleCommunicator )
privatedelete

Member Function Documentation

virtual void edm::OutputModuleCommunicator::closeFile ( )
pure virtual
virtual void edm::OutputModuleCommunicator::configure ( OutputModuleDescription const &  desc)
pure virtual
virtual ModuleDescription const& edm::OutputModuleCommunicator::description ( ) const
pure virtual
virtual SelectedProductsForBranchType const& edm::OutputModuleCommunicator::keptProducts ( ) const
pure virtual
virtual bool edm::OutputModuleCommunicator::limitReached ( ) const
pure virtual
Returns
true if OutputModule has reached its limit on maximum number of events it wants to see

Implemented in edm::OutputModuleCommunicatorT< T >.

virtual void edm::OutputModuleCommunicator::openFile ( FileBlock const &  fb)
pure virtual
const OutputModuleCommunicator& edm::OutputModuleCommunicator::operator= ( const OutputModuleCommunicator )
privatedelete
virtual void edm::OutputModuleCommunicator::selectProducts ( ProductRegistry const &  preg,
ThinnedAssociationsHelper const &   
)
pure virtual
virtual void edm::OutputModuleCommunicator::setEventSelectionInfo ( std::map< std::string, std::vector< std::pair< std::string, int > > > const &  outputModulePathPositions,
bool  anyProductProduced 
)
pure virtual
virtual bool edm::OutputModuleCommunicator::shouldWeCloseFile ( ) const
pure virtual
Returns
true if output module wishes to close its file

Implemented in edm::OutputModuleCommunicatorT< T >.

Referenced by edm::Schedule::shouldWeCloseOutput().

virtual bool edm::OutputModuleCommunicator::wantAllEvents ( ) const
pure virtual
Returns
true if no event filtering is applied to OutputModule

Implemented in edm::OutputModuleCommunicatorT< T >.

virtual void edm::OutputModuleCommunicator::writeLumiAsync ( WaitingTaskHolder  iTask,
LuminosityBlockPrincipal const &  lbp,
ProcessContext const *  ,
ActivityRegistry  
)
pure virtual
virtual void edm::OutputModuleCommunicator::writeRunAsync ( WaitingTaskHolder  iTask,
RunPrincipal const &  rp,
ProcessContext const *  ,
ActivityRegistry  
)
pure virtual