edm::ProductSelector Class Reference

#include <ProductSelector.h>

Public Member Functions
void	initialize (ProductSelectorRules const &rules, std::vector< BranchDescription const * > const &branchDescriptions)
bool	initialized () const
void	print (std::ostream &os) const
	ProductSelector ()
bool	selected (BranchDescription const &desc) const

Static Public Member Functions
static void	checkForDuplicateKeptBranch (BranchDescription const &desc, std::map< BranchID, BranchDescription const * > &trueBranchIDToKeptBranchDesc)
static void	fillDroppedToKept (ProductRegistry const &preg, std::map< BranchID, BranchDescription const * > const &trueBranchIDToKeptBranchDesc, std::map< BranchID::value_type, BranchID::value_type > &droppedBranchIDToKeptBranchID_)

Private Attributes
bool	initialized_
std::vector< std::string >	productsToSelect_

Detailed Description

Definition at line 26 of file ProductSelector.h.

Constructor & Destructor Documentation

edm::ProductSelector::ProductSelector

(

)

Definition at line 18 of file ProductSelector.cc.

: productsToSelect_(), initialized_(false) {}

Member Function Documentation

void edm::ProductSelector::checkForDuplicateKeptBranch ( BranchDescription const &  desc, std::map< BranchID, BranchDescription const * > &  trueBranchIDToKeptBranchDesc  )

static

Definition at line 71 of file ProductSelector.cc.

References edm::check(), edm::errors::Configuration, Exception, edm::BranchDescription::isSwitchAlias(), edm::BranchDescription::originalBranchID(), edm::BranchDescription::produced(), and edm::BranchDescription::switchAliasForBranchID().

Referenced by initialized(), edm::OutputModule::keepThisBranch(), edm::SubProcess::keepThisBranch(), edm::one::OutputModuleBase::keepThisBranch(), edm::global::OutputModuleBase::keepThisBranch(), and edm::limited::OutputModuleBase::keepThisBranch().

                                                                                                               {
    // Check if an equivalent branch has already been selected due to an EDAlias.
    // We only need the check for products produced in this process.
    if (desc.produced()) {
      auto check = [&](BranchID const& branchID) {
        auto iter = trueBranchIDToKeptBranchDesc.find(branchID);
        if (iter != trueBranchIDToKeptBranchDesc.end()) {
          throw edm::Exception(errors::Configuration, "Duplicate Output Selection")
              << "Two (or more) equivalent branches have been selected for output.\n"
              << "#1: " << BranchKey(desc) << "\n"
              << "#2: " << BranchKey(*iter->second) << "\n"
              << "Please drop at least one of them.\n";
        }
      };
      BranchID const& trueBranchID = desc.originalBranchID();
      check(trueBranchID);
      // In case of SwitchProducer, we have to check also the
      // aliased-for BranchID for the case that the chosen case is an EDAlias
      if (desc.isSwitchAlias()) {
        check(desc.switchAliasForBranchID());
      }

      trueBranchIDToKeptBranchDesc.insert(std::make_pair(trueBranchID, &desc));
    }
  }

void edm::ProductSelector::fillDroppedToKept ( ProductRegistry const &  preg, std::map< BranchID, BranchDescription const * > const &  trueBranchIDToKeptBranchDesc, std::map< BranchID::value_type, BranchID::value_type > &  droppedBranchIDToKeptBranchID_  )

static

Definition at line 99 of file ProductSelector.cc.

References edm::BranchDescription::branchID(), edm::BranchID::id(), edm::BranchDescription::isAlias(), edm::BranchDescription::produced(), and edm::ProductRegistry::productList().

Referenced by initialized(), edm::SubProcess::selectProducts(), edm::OutputModule::selectProducts(), edm::global::OutputModuleBase::selectProducts(), edm::limited::OutputModuleBase::selectProducts(), and edm::one::OutputModuleBase::selectProducts().

                                                                                      {
    for (auto const& it : preg.productList()) {
      BranchDescription const& desc = it.second;
      if (!desc.produced() || desc.isAlias())
        continue;
      BranchID const& branchID = desc.branchID();
      std::map<BranchID, BranchDescription const*>::const_iterator iter = trueBranchIDToKeptBranchDesc.find(branchID);
      if (iter != trueBranchIDToKeptBranchDesc.end()) {
        // This branch, produced in this process, or an alias of it, was persisted.
        BranchID const& keptBranchID = iter->second->branchID();
        if (keptBranchID != branchID) {
          // An EDAlias branch was persisted.
          droppedBranchIDToKeptBranchID_.insert(std::make_pair(branchID.id(), keptBranchID.id()));
        }
      }
    }
  }

void edm::ProductSelector::initialize	(	ProductSelectorRules const &	rules,
		std::vector< BranchDescription const * > const &	branchDescriptions
	)

Definition at line 20 of file ProductSelector.cc.

References edm::ProductSelectorRules::applyToAll(), end, initialized_, productsToSelect_, and edm::sort_all().

Referenced by edm::RootFile::dropOnInput(), edm::SubProcess::selectProducts(), edm::OutputModule::selectProducts(), edm::global::OutputModuleBase::selectProducts(), edm::limited::OutputModuleBase::selectProducts(), edm::one::OutputModuleBase::selectProducts(), and ShallowTree::ShallowTree().

                                                                                                     {
    typedef ProductSelectorRules::BranchSelectState BranchSelectState;

    // Get a BranchSelectState for each branch, containing the branch
    // name, with its 'select bit' set to false.
    std::vector<BranchSelectState> branchstates;
    {
      branchstates.reserve(branchDescriptions.size());

      VCBDP::const_iterator it = branchDescriptions.begin();
      VCBDP::const_iterator end = branchDescriptions.end();
      for (; it != end; ++it)
        branchstates.emplace_back(*it);
    }

    // Now  apply the rules to  the branchstates, in order.  Each rule
    // can override any previous rule, or all previous rules.
    rules.applyToAll(branchstates);

    // For each of the BranchSelectStates that indicates the branch is
    // to be selected, remember the branch name.  The list of branch
    // names must be sorted, for the implementation of 'selected' to
    // work.
    {
      std::vector<BranchSelectState>::const_iterator it = branchstates.begin();
      std::vector<BranchSelectState>::const_iterator end = branchstates.end();
      for (; it != end; ++it) {
        if (it->selectMe)
          productsToSelect_.push_back(it->desc->branchName());
      }
      sort_all(productsToSelect_);
    }
    initialized_ = true;
  }

bool edm::ProductSelector::initialized ( ) const

inline

Definition at line 38 of file ProductSelector.h.

References checkForDuplicateKeptBranch(), fillDroppedToKept(), and initialized_.

Referenced by edm::SubProcess::selectProducts(), edm::OutputModule::selectProducts(), edm::global::OutputModuleBase::selectProducts(), edm::limited::OutputModuleBase::selectProducts(), and edm::one::OutputModuleBase::selectProducts().

{ return initialized_; }

void edm::ProductSelector::print

(

std::ostream &

os

)

const

Definition at line 65 of file ProductSelector.cc.

References edm::copy_all(), and productsToSelect_.

Referenced by edm::operator<<().

                                                  {
    os << "ProductSelector at: " << static_cast<void const*>(this) << " has " << productsToSelect_.size()
       << " products to select:\n";
    copy_all(productsToSelect_, std::ostream_iterator<std::string>(os, "\n"));
  }

bool edm::ProductSelector::selected

(

BranchDescription const &

desc

)

const

Definition at line 55 of file ProductSelector.cc.

References edm::binary_search_all(), edm::BranchDescription::branchName(), Exception, initialized_, edm::errors::LogicError, and productsToSelect_.

Referenced by edm::RootFile::dropOnInput(), edm::OutputModule::selected(), edm::global::OutputModuleBase::selected(), edm::limited::OutputModuleBase::selected(), edm::one::OutputModuleBase::selected(), edm::SubProcess::selectProducts(), and ShallowTree::ShallowTree().

                                                                    {
    if (!initialized_) {
      throw edm::Exception(edm::errors::LogicError) << "ProductSelector::selected() called prematurely\n"
                                                    << "before the product registry has been frozen.\n";
    }
    // We are to select this 'branch' if its name is one of the ones we
    // have been told to select.
    return binary_search_all(productsToSelect_, desc.branchName());
  }

Member Data Documentation

bool edm::ProductSelector::initialized_

private

Definition at line 58 of file ProductSelector.h.

Referenced by initialize(), initialized(), and selected().

std::vector<std::string> edm::ProductSelector::productsToSelect_

private

Definition at line 57 of file ProductSelector.h.

Referenced by initialize(), print(), and selected().