edm::OutputModule Class Reference

#include <OutputModule.h>

Inheritance diagram for edm::OutputModule:

Public Types
typedef OutputModule	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
BranchIDLists const *	branchIDLists ()
std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const
SelectedProductsForBranchType const &	keptProducts () const
int	maxEvents () const
OutputModule &	operator= (OutputModule const &)=delete
	OutputModule (ParameterSet const &pset)
	OutputModule (OutputModule const &)=delete
std::string const &	processName () const
int	remainingEvents () const
bool	selected (BranchDescription const &desc) const
void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)
ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const
bool	wantAllEvents () const
virtual	~OutputModule ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Static Public Member Functions
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc)
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
void	configure (OutputModuleDescription const &desc)
ModuleDescription const &	description () const
void	doBeginJob ()
bool	doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *mcc)
bool	doBeginRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *mcc)
void	doEndJob ()
bool	doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *mcc)
bool	doEndRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *mcc)
bool	doEvent (EventPrincipal const &ep, EventSetup const &c, ActivityRegistry *act, ModuleCallingContext const *mcc)
void	doPreallocate (PreallocationConfiguration const &)
std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()
Trig	getTriggerResults (EDGetTokenT< TriggerResults > const &token, EventPrincipal const &ep, ModuleCallingContext const *) const
ModuleDescription const &	moduleDescription () const
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)
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 ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
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)

Private Member Functions
virtual void	beginJob ()
virtual void	beginLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)
virtual void	beginRun (RunPrincipal const &, ModuleCallingContext const *)
void	doCloseFile ()
	Tell the OutputModule that is must end the current file. More...
void	doOpenFile (FileBlock const &fb)
void	doPostForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren)
void	doPreForkReleaseResources ()
void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doWriteLuminosityBlock (LuminosityBlockPrincipal const &lbp, ModuleCallingContext const *mcc)
void	doWriteRun (RunPrincipal const &rp, ModuleCallingContext const *mcc)
virtual void	endJob ()
virtual void	endLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)
virtual void	endRun (RunPrincipal const &, ModuleCallingContext const *)
virtual bool	isFileOpen () const
void	keepThisBranch (BranchDescription const &desc, std::map< BranchID, BranchDescription const * > &trueBranchIDToKeptBranchDesc, std::set< BranchID > &keptProductsInEvent)
bool	limitReached () const
void	maybeOpenFile ()
virtual void	openFile (FileBlock const &)
virtual void	postForkReacquireResources (unsigned int, unsigned int)
virtual void	preForkReleaseResources ()
bool	prePrefetchSelection (StreamID id, EventPrincipal const &, ModuleCallingContext const *)
virtual void	reallyCloseFile ()
virtual void	reallyOpenFile ()
void	registerProductsAndCallbacks (OutputModule const *, ProductRegistry const *)
virtual void	respondToCloseInputFile (FileBlock const &)
virtual void	respondToOpenInputFile (FileBlock const &)
void	setModuleDescription (ModuleDescription const &md)
virtual bool	shouldWeCloseFile () const
	Ask the OutputModule if we should end the current file. More...
std::string	workerType () const
virtual void	write (EventPrincipal const &e, ModuleCallingContext const *)=0
virtual void	writeLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)=0
virtual void	writeRun (RunPrincipal const &, ModuleCallingContext const *)=0

Private Attributes
edm::propagate_const < std::unique_ptr < BranchIDLists > >	branchIDLists_
std::map< BranchID::value_type, BranchID::value_type >	droppedBranchIDToKeptBranchID_
std::array< bool, NumBranchTypes >	hasNewlyDroppedBranch_
std::map< BranchID, bool >	keepAssociation_
SelectedProductsForBranchType	keptProducts_
int	maxEvents_
ModuleDescription	moduleDescription_
std::mutex	mutex_
BranchIDLists const *	origBranchIDLists_
std::string	process_name_
ProductSelector	productSelector_
ProductSelectorRules	productSelectorRules_
std::atomic< int >	remainingEvents_
SharedResourcesAcquirer	resourceAcquirer_
ParameterSet	selectEvents_
ParameterSetID	selector_config_id_
std::vector < detail::TriggerResultsBasedEventSelector >	selectors_
edm::propagate_const < std::unique_ptr < ThinnedAssociationsHelper > >	thinnedAssociationsHelper_
bool	wantAllEvents_

Friends
template<typename T >
class	maker::ModuleHolderT
template<typename T >
class	OutputModuleCommunicatorT
template<typename T >
class	WorkerT

Detailed Description

Definition at line 51 of file OutputModule.h.

Member Typedef Documentation

typedef OutputModule edm::OutputModule::ModuleType

Definition at line 56 of file OutputModule.h.

Constructor & Destructor Documentation

edm::OutputModule::OutputModule ( ParameterSet const &  pset )

explicit

Definition at line 34 of file OutputModule.cc.

References edm::detail::configureEventSelector(), edm::getAllTriggerNames(), edm::ParameterSet::getUntrackedParameterSet(), hasNewlyDroppedBranch_, edm::ParameterSet::id(), edm::SharedResourcesRegistry::instance(), edm::SharedResourcesRegistry::kLegacyModuleResourceName, process_name_, edm::ParameterSet::registerIt(), edm::SharedResourcesRegistry::registerSharedResource(), selectEvents_, selector_config_id_, selectors_, and wantAllEvents_.

                                                     :
    maxEvents_(-1),
    remainingEvents_(maxEvents_),
    keptProducts_(),
    hasNewlyDroppedBranch_(),
    process_name_(),
    productSelectorRules_(pset, "outputCommands", "OutputModule"),
    productSelector_(),
    moduleDescription_(),
    wantAllEvents_(false),
    selectors_(),
    selector_config_id_(),
    droppedBranchIDToKeptBranchID_(),
    branchIDLists_(new BranchIDLists),
    origBranchIDLists_(nullptr),
    thinnedAssociationsHelper_(new ThinnedAssociationsHelper) {

    hasNewlyDroppedBranch_.fill(false);

    Service<service::TriggerNamesService> tns;
    process_name_ = tns->getProcessName();

    selectEvents_ =
      pset.getUntrackedParameterSet("SelectEvents", ParameterSet());

    selectEvents_.registerIt(); // Just in case this PSet is not registered

    selector_config_id_ = selectEvents_.id();
    selectors_.resize(1);
    //need to set wantAllEvents_ in constructor
    // we will make the remaining selectors once we know how many streams
    wantAllEvents_ = detail::configureEventSelector(selectEvents_,
                                                          process_name_,
                                                          getAllTriggerNames(),
                                                          selectors_[0]);

    SharedResourcesRegistry::instance()->registerSharedResource(
                                                                SharedResourcesRegistry::kLegacyModuleResourceName);

  }

edm::OutputModule::~OutputModule ( )

virtual

Definition at line 174 of file OutputModule.cc.

{ }

edm::OutputModule::OutputModule ( OutputModule const &  )

delete

Member Function Documentation

const std::string & edm::OutputModule::baseType ( )

static

Definition at line 399 of file OutputModule.cc.

References edm::kBaseType().

                         {
    return kBaseType;
  }

virtual void edm::OutputModule::beginJob ( void  )

inlineprivatevirtual

Definition at line 211 of file OutputModule.h.

Referenced by doBeginJob().

{}

virtual void edm::OutputModule::beginLuminosityBlock ( LuminosityBlockPrincipal const &  , ModuleCallingContext const *    )

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >.

Definition at line 216 of file OutputModule.h.

Referenced by doBeginLuminosityBlock().

{}

virtual void edm::OutputModule::beginRun ( RunPrincipal const &  , ModuleCallingContext const *    )

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >.

Definition at line 213 of file OutputModule.h.

Referenced by doBeginRun().

{}

BranchIDLists const * edm::OutputModule::branchIDLists

(

)

Definition at line 345 of file OutputModule.cc.

References branchIDLists_, droppedBranchIDToKeptBranchID_, and origBranchIDLists_.

                              {
    if(!droppedBranchIDToKeptBranchID_.empty()) {
      // Make a private copy of the BranchIDLists.
      *branchIDLists_ = *origBranchIDLists_;
      // Check for branches dropped while an EDAlias was kept.
      for(BranchIDList& branchIDList : *branchIDLists_) {
        for(BranchID::value_type& branchID : branchIDList) {
          // Replace BranchID of each dropped branch with that of the kept alias, so the alias branch will have the product ID of the original branch.
          std::map<BranchID::value_type, BranchID::value_type>::const_iterator iter = droppedBranchIDToKeptBranchID_.find(branchID);
          if(iter != droppedBranchIDToKeptBranchID_.end()) {
            branchID = iter->second;
          }
        }
      }
      return branchIDLists_.get();
    }
    return origBranchIDLists_;
  }

void edm::OutputModule::configure ( OutputModuleDescription const &  desc )

protected

Definition at line 75 of file OutputModule.cc.

References edm::OutputModuleDescription::branchIDLists_, edm::OutputModuleDescription::maxEvents_, maxEvents_, origBranchIDLists_, and remainingEvents_.

                                                                  {
    remainingEvents_ = maxEvents_ = desc.maxEvents_;
    origBranchIDLists_ = desc.branchIDLists_;
  }

ModuleDescription const & edm::OutputModule::description ( ) const

protected

Definition at line 370 of file OutputModule.cc.

References moduleDescription_.

Referenced by setEventSelectionInfo().

                                  {
    return moduleDescription_;
  }

void edm::OutputModule::doBeginJob ( )

protected

Definition at line 193 of file OutputModule.cc.

References beginJob(), edm::SharedResourcesRegistry::createAcquirer(), edm::SharedResourcesRegistry::instance(), edm::SharedResourcesRegistry::kLegacyModuleResourceName, and resourceAcquirer_.

                                {
    std::vector<std::string> res = {SharedResourcesRegistry::kLegacyModuleResourceName};
    resourceAcquirer_ = SharedResourcesRegistry::instance()->createAcquirer(res);

    this->beginJob();
  }

bool edm::OutputModule::doBeginLuminosityBlock ( LuminosityBlockPrincipal const &  lbp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

protected

Definition at line 286 of file OutputModule.cc.

References beginLuminosityBlock(), and FDEBUG.

                                                                        {
    FDEBUG(2) << "beginLuminosityBlock called\n";
    beginLuminosityBlock(lbp, mcc);
    return true;
  }

bool edm::OutputModule::doBeginRun ( RunPrincipal const &  rp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

protected

Definition at line 261 of file OutputModule.cc.

References beginRun(), and FDEBUG.

                                                            {
    FDEBUG(2) << "beginRun called\n";
    beginRun(rp, mcc);
    return true;
  }

void edm::OutputModule::doCloseFile ( )

private

Tell the OutputModule that is must end the current file.

Definition at line 335 of file OutputModule.cc.

References isFileOpen(), and reallyCloseFile().

                                 {
    if(isFileOpen()) {
      reallyCloseFile();
    }
  }

void edm::OutputModule::doEndJob ( )

protected

Definition at line 200 of file OutputModule.cc.

References endJob().

                              {
    endJob();
  }

bool edm::OutputModule::doEndLuminosityBlock ( LuminosityBlockPrincipal const &  lbp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

protected

Definition at line 295 of file OutputModule.cc.

References endLuminosityBlock(), and FDEBUG.

                                                                      {
    FDEBUG(2) << "endLuminosityBlock called\n";
    endLuminosityBlock(lbp, mcc);
    return true;
  }

bool edm::OutputModule::doEndRun ( RunPrincipal const &  rp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

protected

Definition at line 270 of file OutputModule.cc.

References endRun(), and FDEBUG.

                                                          {
    FDEBUG(2) << "endRun called\n";
    endRun(rp, mcc);
    return true;
  }

bool edm::OutputModule::doEvent ( EventPrincipal const &  ep, EventSetup const &  c, ActivityRegistry *  act, ModuleCallingContext const *  mcc  )

protected

Definition at line 222 of file OutputModule.cc.

References FDEBUG, mutex_, remainingEvents_, resourceAcquirer_, and write().

                                                         {

    FDEBUG(2) << "writeEvent called\n";

    {
      std::lock_guard<std::mutex> guard(mutex_);
      
      {
        std::lock_guard<SharedResourcesAcquirer> guardAcq(resourceAcquirer_);
        EventSignalsSentry signals(act,mcc);
        write(ep, mcc);
      }
    }
    if(remainingEvents_ > 0) {
      --remainingEvents_;
    }
    return true;
  }

void edm::OutputModule::doOpenFile ( FileBlock const &  fb )

private

Definition at line 309 of file OutputModule.cc.

References openFile().

                                                   {
    openFile(fb);
  }

void edm::OutputModule::doPostForkReacquireResources ( unsigned int  iChildIndex, unsigned int  iNumberOfChildren  )

private

Definition at line 327 of file OutputModule.cc.

References postForkReacquireResources().

                                                                                                     {
    postForkReacquireResources(iChildIndex, iNumberOfChildren);
  }

void edm::OutputModule::doPreallocate ( PreallocationConfiguration const &  iPC )

protected

Definition at line 176 of file OutputModule.cc.

References edm::detail::configureEventSelector(), edm::getAllTriggerNames(), edm::PreallocationConfiguration::numberOfStreams(), process_name_, alignCSCRings::s, selectEvents_, and selectors_.

                                                                        {
    auto nstreams = iPC.numberOfStreams();
    selectors_.resize(nstreams);

    bool seenFirst = false;
    for(auto& s : selectors_) {
      if(seenFirst) {
        detail::configureEventSelector(selectEvents_,
                                       process_name_,
                                       getAllTriggerNames(),
                                       s);
      }
      seenFirst = true;
    }
  }

void edm::OutputModule::doPreForkReleaseResources ( )

private

Definition at line 322 of file OutputModule.cc.

References preForkReleaseResources().

                                          {
    preForkReleaseResources();
  }

void edm::OutputModule::doRegisterThinnedAssociations ( ProductRegistry const &  , ThinnedAssociationsHelper &    )

inlineprivate

Definition at line 186 of file OutputModule.h.

                                                                   { }

void edm::OutputModule::doRespondToCloseInputFile ( FileBlock const &  fb )

private

Definition at line 317 of file OutputModule.cc.

References respondToCloseInputFile().

                                                                  {
    respondToCloseInputFile(fb);
  }

void edm::OutputModule::doRespondToOpenInputFile ( FileBlock const &  fb )

private

Definition at line 313 of file OutputModule.cc.

References respondToOpenInputFile().

                                                                 {
    respondToOpenInputFile(fb);
  }

void edm::OutputModule::doWriteLuminosityBlock ( LuminosityBlockPrincipal const &  lbp, ModuleCallingContext const *  mcc  )

private

Definition at line 303 of file OutputModule.cc.

References FDEBUG, and writeLuminosityBlock().

                                                                             {
    FDEBUG(2) << "writeLuminosityBlock called\n";
    writeLuminosityBlock(lbp, mcc);
  }

void edm::OutputModule::doWriteRun ( RunPrincipal const &  rp, ModuleCallingContext const *  mcc  )

private

Definition at line 279 of file OutputModule.cc.

References FDEBUG, and writeRun().

                                                            {
    FDEBUG(2) << "writeRun called\n";
    writeRun(rp, mcc);
  }

std::map<BranchID::value_type, BranchID::value_type> const& edm::OutputModule::droppedBranchIDToKeptBranchID ( )

inlineprotected

Definition at line 125 of file OutputModule.h.

References droppedBranchIDToKeptBranchID_.

                                                                                          {
      return droppedBranchIDToKeptBranchID_;
    }

virtual void edm::OutputModule::endJob ( void  )

inlineprivatevirtual

Definition at line 212 of file OutputModule.h.

Referenced by doEndJob().

{}

virtual void edm::OutputModule::endLuminosityBlock ( LuminosityBlockPrincipal const &  , ModuleCallingContext const *    )

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >.

Definition at line 217 of file OutputModule.h.

Referenced by doEndLuminosityBlock().

{}

virtual void edm::OutputModule::endRun ( RunPrincipal const &  , ModuleCallingContext const *    )

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >.

Definition at line 214 of file OutputModule.h.

Referenced by doEndRun().

{}

void edm::OutputModule::fillDescription ( ParameterSetDescription &  desc )

static

Definition at line 387 of file OutputModule.cc.

References edm::ProductSelectorRules::fillDescription(), and edm::EventSelector::fillDescription().

Referenced by edm::StreamerOutputModuleBase::fillDescription(), edm::PoolOutputModule::fillDescription(), edm::AsciiOutputModule::fillDescriptions(), edm::ProvenanceCheckerOutputModule::fillDescriptions(), and edm::GetProductCheckerOutputModule::fillDescriptions().

                                                             {
    ProductSelectorRules::fillDescription(desc, "outputCommands");
    EventSelector::fillDescription(desc);
  }

void edm::OutputModule::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 380 of file OutputModule.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                        {
    ParameterSetDescription desc;
    desc.setUnknown();
    descriptions.addDefault(desc);
  }

Trig edm::OutputModule::getTriggerResults ( EDGetTokenT< TriggerResults > const &  token, EventPrincipal const &  ep, ModuleCallingContext const *  mcc  ) const

protected

Definition at line 205 of file OutputModule.cc.

References edm::convert_handle(), edm::PrincipalGetAdapter::getByToken_(), moduleDescription_, eostools::move(), edm::PRODUCT_TYPE, mps_fire::result, and edm::PrincipalGetAdapter::setConsumer().

                                                                                                                                                {
    //This cast is safe since we only call const functions of the EventPrincipal after this point
    PrincipalGetAdapter adapter(ep, moduleDescription_);
    adapter.setConsumer(this);
    Trig result;
    auto bh = adapter.getByToken_(TypeID(typeid(TriggerResults)),PRODUCT_TYPE, token, mcc);
    convert_handle(std::move(bh), result);
    return result;
  }

std::array<bool, NumBranchTypes> const& edm::OutputModule::hasNewlyDroppedBranch ( ) const

inline

Definition at line 77 of file OutputModule.h.

References hasNewlyDroppedBranch_.

{return hasNewlyDroppedBranch_;}

virtual bool edm::OutputModule::isFileOpen ( ) const

inlineprivatevirtual

Definition at line 225 of file OutputModule.h.

Referenced by doCloseFile(), and maybeOpenFile().

{ return true; }

void edm::OutputModule::keepThisBranch ( BranchDescription const &  desc, std::map< BranchID, BranchDescription const * > &  trueBranchIDToKeptBranchDesc, std::set< BranchID > &  keptProductsInEvent  )

private

Definition at line 129 of file OutputModule.cc.

References assert(), edm::BranchDescription::branchID(), edm::BranchDescription::branchType(), edm::ProductSelector::checkForDuplicateKeptBranch(), edm::EDConsumerBase::consumes(), edm::InEvent, edm::InLumi, HLT_25ns10e33_v2_cff::InputTag, edm::InRun, keptProducts_, edm::BranchDescription::moduleLabel(), edm::BranchDescription::originalBranchID(), edm::BranchDescription::processName(), edm::BranchDescription::produced(), edm::PRODUCT_TYPE, edm::BranchDescription::productInstanceName(), and edm::BranchDescription::unwrappedTypeID().

Referenced by selectProducts().

                                                                           {

    ProductSelector::checkForDuplicateKeptBranch(desc,
                                                 trueBranchIDToKeptBranchDesc);

    switch (desc.branchType()) {
    case InEvent:
      {
        if(desc.produced()) {
          keptProductsInEvent.insert(desc.originalBranchID());
        } else {
          keptProductsInEvent.insert(desc.branchID());
        }
        consumes(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                 InputTag{desc.moduleLabel(),
                     desc.productInstanceName(),
                     desc.processName()});
        break;
      }
    case InLumi:
      {
        consumes<InLumi>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                         InputTag(desc.moduleLabel(),
                                  desc.productInstanceName(),
                                  desc.processName()));
        break;
      }
    case InRun:
      {
        consumes<InRun>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                        InputTag(desc.moduleLabel(),
                                 desc.productInstanceName(),
                                 desc.processName()));
        break;
      }
    default:
      assert(false);
      break;
    }
    // Now put it in the list of selected branches.
    keptProducts_[desc.branchType()].push_back(&desc);
  }

SelectedProductsForBranchType const& edm::OutputModule::keptProducts ( ) const

inline

Definition at line 76 of file OutputModule.h.

References keptProducts_.

{return keptProducts_;}

bool edm::OutputModule::limitReached ( ) const

inlineprivate

Definition at line 237 of file OutputModule.h.

References remainingEvents_.

{return remainingEvents_ == 0;}

int edm::OutputModule::maxEvents ( ) const

inline

Accessor for maximum number of events to be written. -1 is used for unlimited.

Definition at line 66 of file OutputModule.h.

References maxEvents_.

{return maxEvents_;}

void edm::OutputModule::maybeOpenFile ( )

private

Tell the OutputModule to open an output file, if one is not already open.

Definition at line 331 of file OutputModule.cc.

References isFileOpen(), and reallyOpenFile().

                                   {
    if(!isFileOpen()) reallyOpenFile();
  }

ModuleDescription const& edm::OutputModule::moduleDescription ( ) const

inlineprotected

Definition at line 99 of file OutputModule.h.

References moduleDescription_.

                                                       { return moduleDescription_;
    }

virtual void edm::OutputModule::openFile ( FileBlock const &  )

inlineprivatevirtual

Definition at line 219 of file OutputModule.h.

Referenced by Vispa.Main.Application.Application::_readCommandLineAttributes(), doOpenFile(), Vispa.Main.Application.Application::doubleClickOnFile(), Vispa.Main.Application.Application::openFileDialog(), and Vispa.Main.Application.Application::openRecentFileSlot().

{}

OutputModule& edm::OutputModule::operator= ( OutputModule const &  )

delete

virtual void edm::OutputModule::postForkReacquireResources ( unsigned  int, unsigned  int  )

inlineprivatevirtual

Definition at line 223 of file OutputModule.h.

Referenced by doPostForkReacquireResources().

{}

virtual void edm::OutputModule::preForkReleaseResources ( )

inlineprivatevirtual

Definition at line 222 of file OutputModule.h.

Referenced by doPreForkReleaseResources().

{}

bool edm::OutputModule::prePrefetchSelection ( StreamID  id, EventPrincipal const &  ep, ModuleCallingContext const *  mcc  )

private

Definition at line 215 of file OutputModule.cc.

References or, alignCSCRings::s, selectors_, and wantAllEvents_.

                                                                                                                {
    
    auto& s = selectors_[id.value()];
    return wantAllEvents_ or s.wantEvent(ep,mcc);
  }

void edm::OutputModule::prevalidate ( ConfigurationDescriptions &  )

static

Definition at line 393 of file OutputModule.cc.

                                                       {
  }

std::string const& edm::OutputModule::processName ( ) const

inline

Definition at line 75 of file OutputModule.h.

References process_name_.

Referenced by edm::StreamerOutputModuleBase::serializeRegistry().

{return process_name_;}

void edm::OutputModule::reallyCloseFile ( )

privatevirtual

Definition at line 341 of file OutputModule.cc.

Referenced by doCloseFile().

                                     {
  }

virtual void edm::OutputModule::reallyOpenFile ( )

inlineprivatevirtual

Definition at line 227 of file OutputModule.h.

Referenced by maybeOpenFile().

{}

void edm::OutputModule::registerProductsAndCallbacks ( OutputModule const *  , ProductRegistry const *    )

inlineprivate

Definition at line 203 of file OutputModule.h.

{}

int edm::OutputModule::remainingEvents ( ) const

inline

Accessor for remaining number of events to be written. -1 is used for unlimited.

Definition at line 70 of file OutputModule.h.

References remainingEvents_.

{return remainingEvents_;}

virtual void edm::OutputModule::respondToCloseInputFile ( FileBlock const &  )

inlineprivatevirtual

Definition at line 221 of file OutputModule.h.

Referenced by doRespondToCloseInputFile().

{}

virtual void edm::OutputModule::respondToOpenInputFile ( FileBlock const &  )

inlineprivatevirtual

Definition at line 220 of file OutputModule.h.

Referenced by doRespondToOpenInputFile().

{}

bool edm::OutputModule::selected

(

BranchDescription const &

desc

)

const

Definition at line 375 of file OutputModule.cc.

References productSelector_, and edm::ProductSelector::selected().

Referenced by selectProducts().

                                                            {
    return productSelector_.selected(desc);
  }

ParameterSetID edm::OutputModule::selectorConfig ( ) const

inlineprotected

Definition at line 102 of file OutputModule.h.

References selector_config_id_.

{ return selector_config_id_; }

void edm::OutputModule::selectProducts	(	ProductRegistry const &	preg,
		ThinnedAssociationsHelper const &	thinnedAssociationsHelper
	)

Definition at line 80 of file OutputModule.cc.

References edm::ProductRegistry::allBranchDescriptions(), edm::BranchDescription::branchType(), droppedBranchIDToKeptBranchID_, edm::ProductSelector::fillDroppedToKept(), hasNewlyDroppedBranch_, edm::ProductSelector::initialize(), edm::ProductSelector::initialized(), keepAssociation_, keepThisBranch(), edm::BranchDescription::present(), edm::BranchDescription::produced(), edm::ProductRegistry::productList(), productSelector_, productSelectorRules_, edm::ThinnedAssociationsHelper::selectAssociationProducts(), selected(), thinnedAssociationsHelper_, edm::BranchDescription::transient(), and edm::BranchDescription::unwrappedType().

                                                                                                {
    if(productSelector_.initialized()) return;
    productSelector_.initialize(productSelectorRules_, preg.allBranchDescriptions());

    // TODO: See if we can collapse keptProducts_ and productSelector_ into a
    // single object. See the notes in the header for ProductSelector
    // for more information.

    std::map<BranchID, BranchDescription const*> trueBranchIDToKeptBranchDesc;
    std::vector<BranchDescription const*> associationDescriptions;
    std::set<BranchID> keptProductsInEvent;

    for(auto const& it : preg.productList()) {
      BranchDescription const& desc = it.second;
      if(desc.transient()) {
        // if the class of the branch is marked transient, output nothing
      } else if(!desc.present() && !desc.produced()) {
        // else if the branch containing the product has been previously dropped,
        // output nothing
      } else if(desc.unwrappedType() == typeid(ThinnedAssociation)) {
        associationDescriptions.push_back(&desc);
      } else if(selected(desc)) {
        keepThisBranch(desc, trueBranchIDToKeptBranchDesc, keptProductsInEvent);
      } else {
        // otherwise, output nothing,
        // and mark the fact that there is a newly dropped branch of this type.
        hasNewlyDroppedBranch_[desc.branchType()] = true;
      }
    }

    thinnedAssociationsHelper.selectAssociationProducts(associationDescriptions,
                                                        keptProductsInEvent,
                                                        keepAssociation_);

    for(auto association : associationDescriptions) {
      if(keepAssociation_[association->branchID()]) {
        keepThisBranch(*association, trueBranchIDToKeptBranchDesc, keptProductsInEvent);
      } else {
        hasNewlyDroppedBranch_[association->branchType()] = true;
      }
    }

    // Now fill in a mapping needed in the case that a branch was dropped while its EDAlias was kept.
    ProductSelector::fillDroppedToKept(preg, trueBranchIDToKeptBranchDesc, droppedBranchIDToKeptBranchID_);

    thinnedAssociationsHelper_->updateFromParentProcess(thinnedAssociationsHelper, keepAssociation_, droppedBranchIDToKeptBranchID_);
  }

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

protected

Definition at line 404 of file OutputModule.cc.

References description(), edm::getParameterSet(), edm::detail::registerProperSelectionInfo(), and selector_config_id_.

                                                               {
    selector_config_id_ = detail::registerProperSelectionInfo(getParameterSet(selector_config_id_),
                                      description().moduleLabel(),
                                                      outputModulePathPositions,
                                                      anyProductProduced);
  }

void edm::OutputModule::setModuleDescription ( ModuleDescription const &  md )

inlineprivate

Definition at line 233 of file OutputModule.h.

References moduleDescription_.

                                                           {
      moduleDescription_ = md;
    }

virtual bool edm::OutputModule::shouldWeCloseFile ( ) const

inlineprivatevirtual

Ask the OutputModule if we should end the current file.

Definition at line 208 of file OutputModule.h.

{return false;}

ThinnedAssociationsHelper const * edm::OutputModule::thinnedAssociationsHelper

(

)

const

Definition at line 365 of file OutputModule.cc.

References thinnedAssociationsHelper_.

                                                {
    return thinnedAssociationsHelper_.get();
  }

bool edm::OutputModule::wantAllEvents ( ) const

inline

Definition at line 84 of file OutputModule.h.

References wantAllEvents_.

{return wantAllEvents_;}

std::string edm::OutputModule::workerType ( ) const

inlineprivate

Definition at line 189 of file OutputModule.h.

{return "WorkerT<OutputModule>";}

virtual void edm::OutputModule::write ( EventPrincipal const &  e, ModuleCallingContext const *    )

privatepure virtual

Implemented in edm::GetProductCheckerOutputModule, RawEventOutputModuleForBU< Consumer >, and edm::ProvenanceCheckerOutputModule.

Referenced by doEvent(), and pkg.AbstractPkg::generate().

virtual void edm::OutputModule::writeLuminosityBlock ( LuminosityBlockPrincipal const &  , ModuleCallingContext const *    )

privatepure virtual

Implemented in RawEventOutputModuleForBU< Consumer >, edm::GetProductCheckerOutputModule, and edm::ProvenanceCheckerOutputModule.

Referenced by doWriteLuminosityBlock().

virtual void edm::OutputModule::writeRun ( RunPrincipal const &  , ModuleCallingContext const *    )

privatepure virtual

Implemented in edm::GetProductCheckerOutputModule, RawEventOutputModuleForBU< Consumer >, and edm::ProvenanceCheckerOutputModule.

Referenced by doWriteRun().

Friends And Related Function Documentation

template<typename T >

friend class maker::ModuleHolderT

friend

Definition at line 53 of file OutputModule.h.

template<typename T >

friend class OutputModuleCommunicatorT

friend

Definition at line 55 of file OutputModule.h.

template<typename T >

friend class WorkerT

friend

Definition at line 54 of file OutputModule.h.

Member Data Documentation

edm::propagate_const<std::unique_ptr<BranchIDLists> > edm::OutputModule::branchIDLists_

private

Definition at line 167 of file OutputModule.h.

Referenced by branchIDLists().

std::map<BranchID::value_type, BranchID::value_type> edm::OutputModule::droppedBranchIDToKeptBranchID_

private

Definition at line 166 of file OutputModule.h.

Referenced by branchIDLists(), droppedBranchIDToKeptBranchID(), and selectProducts().

std::array<bool, NumBranchTypes> edm::OutputModule::hasNewlyDroppedBranch_

private

Definition at line 150 of file OutputModule.h.

Referenced by hasNewlyDroppedBranch(), OutputModule(), and selectProducts().

std::map<BranchID, bool> edm::OutputModule::keepAssociation_

private

Definition at line 171 of file OutputModule.h.

Referenced by selectProducts().

SelectedProductsForBranchType edm::OutputModule::keptProducts_

private

Definition at line 149 of file OutputModule.h.

Referenced by keepThisBranch(), and keptProducts().

int edm::OutputModule::maxEvents_

private

Definition at line 131 of file OutputModule.h.

Referenced by configure(), and maxEvents().

ModuleDescription edm::OutputModule::moduleDescription_

private

Definition at line 155 of file OutputModule.h.

Referenced by description(), getTriggerResults(), moduleDescription(), and setModuleDescription().

std::mutex edm::OutputModule::mutex_

private

Definition at line 174 of file OutputModule.h.

Referenced by doEvent().

BranchIDLists const* edm::OutputModule::origBranchIDLists_

private

Definition at line 168 of file OutputModule.h.

Referenced by branchIDLists(), and configure().

std::string edm::OutputModule::process_name_

private

Definition at line 152 of file OutputModule.h.

Referenced by doPreallocate(), OutputModule(), and processName().

ProductSelector edm::OutputModule::productSelector_

private

Definition at line 154 of file OutputModule.h.

Referenced by selected(), and selectProducts().

ProductSelectorRules edm::OutputModule::productSelectorRules_

private

Definition at line 153 of file OutputModule.h.

Referenced by selectProducts().

std::atomic<int> edm::OutputModule::remainingEvents_

private

Definition at line 132 of file OutputModule.h.

Referenced by configure(), doEvent(), limitReached(), and remainingEvents().

SharedResourcesAcquirer edm::OutputModule::resourceAcquirer_

private

Definition at line 173 of file OutputModule.h.

Referenced by doBeginJob(), and doEvent().

ParameterSet edm::OutputModule::selectEvents_

private

Definition at line 161 of file OutputModule.h.

Referenced by doPreallocate(), and OutputModule().

ParameterSetID edm::OutputModule::selector_config_id_

private

Definition at line 162 of file OutputModule.h.

Referenced by OutputModule(), selectorConfig(), and setEventSelectionInfo().

std::vector<detail::TriggerResultsBasedEventSelector> edm::OutputModule::selectors_

private

Definition at line 158 of file OutputModule.h.

Referenced by doPreallocate(), OutputModule(), and prePrefetchSelection().

edm::propagate_const<std::unique_ptr<ThinnedAssociationsHelper> > edm::OutputModule::thinnedAssociationsHelper_

private

Definition at line 170 of file OutputModule.h.

Referenced by selectProducts(), and thinnedAssociationsHelper().

bool edm::OutputModule::wantAllEvents_

private

Definition at line 157 of file OutputModule.h.

Referenced by OutputModule(), prePrefetchSelection(), and wantAllEvents().