util::RegexDataProductSelector Class Reference

Matches products by regex on process, module label and instance name. More...

#include <ArtDataProductSelectors.h>

Inheritance diagram for util::RegexDataProductSelector:

Classes
struct	ProductRegex
	A pattern on a input tag (empty matches everything). More...

Public Member Functions
	RegexDataProductSelector (std::vector< ProductRegex > patterns)
	Initializes the selector with all the supported patterns. More...
template<typename SpecColl >
auto	makePatterns (SpecColl const &specs) -> std::vector< ProductRegex >

Static Public Member Functions
static ProductRegex	makePattern (art::InputTag const &spec)
	Parses a input tag to create a single data product pattern. More...
template<typename SpecColl >
static std::vector< ProductRegex >	makePatterns (SpecColl const &specs)
	Parses a sequence of input tags to create data product patterns. More...

Private Member Functions
virtual bool	doMatch (art::BranchDescription const &brDescr) const override
	Returns whether data product described by brDescr matches. More...
virtual std::string	doPrint (std::string const &indent) const override
	Part of the message used when no data product matches. More...
bool	matchPattern (art::InputTag const &tag, ProductRegex const &ptn) const
	Returns whether the input tag matches the pattern ptn. More...

Private Attributes
std::vector< ProductRegex >	fPatterns
	All the selection patterns. More...

Detailed Description

Matches products by regex on process, module label and instance name.

A pattern is matched if all specified subpatterns (process, module, instance) match. Any component of the pattern may be unspecified. A product is selected if it matches any of the configured patterns.

Patterns are matched with std::regex_match(), i.e. the whole string must match.

The patterns may be created from one or a sequence of input-tag-like objects using makePattern() and makePatterns() static functions, respectively.

Definition at line 38 of file ArtDataProductSelectors.h.

Constructor & Destructor Documentation

util::RegexDataProductSelector::RegexDataProductSelector

(

std::vector< ProductRegex >

patterns

)

Initializes the selector with all the supported patterns.

Definition at line 24 of file ArtDataProductSelectors.cxx.

  : fPatterns(std::move(patterns))
{}

Member Function Documentation

bool util::RegexDataProductSelector::doMatch ( art::BranchDescription const &  brDescr ) const

overrideprivatevirtual

Returns whether data product described by brDescr matches.

Definition at line 48 of file ArtDataProductSelectors.cxx.

{
  art::InputTag const& tag = brDescr.inputTag();
  for (ProductRegex const& pattern: fPatterns)
    if (matchPattern(tag, pattern)) return true;
  return false;
} // util::RegexDataProductSelector::doMatch()

std::string util::RegexDataProductSelector::doPrint ( std::string const &  indent ) const

overrideprivatevirtual

Part of the message used when no data product matches.

Definition at line 59 of file ArtDataProductSelectors.cxx.

{
  return indent
    + "any of " + std::to_string(fPatterns.size()) + " patterns";
} // util::RegexDataProductSelector::doPrint()

auto util::RegexDataProductSelector::makePattern ( art::InputTag const &  spec )

static

Parses a input tag to create a single data product pattern.

Parameters

spec	pattern specification

Returns

a pattern object

A specification is in the form of an art::InputTag, but each element is a regex pattern rather than a standard name.

If the input tag is created from a string, in the usual form <processName>:<moduleLabel>:<instanceName> (with the usual omissions), each element can't contain a : character (no escaping is supported).

An empty tag matches everything.

Definition at line 31 of file ArtDataProductSelectors.cxx.

{
  
  auto const regexIfNotEmpty = [](std::string const& ptn)
    { return ptn.empty()? std::nullopt: std::optional{ std::regex{ ptn }}; };
  
  return {
      regexIfNotEmpty(spec.process())   // process
    , regexIfNotEmpty(spec.label())     // module
    , regexIfNotEmpty(spec.instance())  // instance
    };
  
} // util::RegexDataProductSelector::makePattern()

template<typename SpecColl >

static std::vector<ProductRegex> util::RegexDataProductSelector::makePatterns ( SpecColl const &  specs )

static

Parses a sequence of input tags to create data product patterns.

Template Parameters

SpecColl

type of collection of specifications

Parameters

specs

sequence of pattern specifications

Returns

a sequence of pattern objects, one per input specification

Each specification in specs is converted into a pattern via makePattern(). The specification is explicitly converted into an input tag.

template<typename SpecColl >

auto util::RegexDataProductSelector::makePatterns

(

SpecColl const &

specs

)

-> std::vector<ProductRegex>

Definition at line 106 of file ArtDataProductSelectors.h.

{
  using std::size;
  std::vector<ProductRegex> ptns;
  ptns.reserve(size(specs));
  for (auto const& spec: specs)
    ptns.push_back(makePattern(art::InputTag{ spec }));
  return ptns;
} // util::RegexDataProductSelector::makePatterns()

bool util::RegexDataProductSelector::matchPattern ( art::InputTag const &  tag, ProductRegex const &  ptn  ) const

private

Returns whether the input tag matches the pattern ptn.

Definition at line 68 of file ArtDataProductSelectors.cxx.

{
  if (ptn.process  && !std::regex_match(tag.process(),  *(ptn.process) ))
    return false;
  if (ptn.module   && !std::regex_match(tag.label(),    *(ptn.module)  ))
    return false;
  if (ptn.instance && !std::regex_match(tag.instance(), *(ptn.instance)))
    return false;
  return true;
} // util::RegexDataProductSelector::matchPattern()

Member Data Documentation

std::vector<ProductRegex> util::RegexDataProductSelector::fPatterns

private

All the selection patterns.

Definition at line 84 of file ArtDataProductSelectors.h.

---

The documentation for this class was generated from the following files:

• ArtDataProductSelectors.h
• ArtDataProductSelectors.cxx