art::InputTag Class Reference

#include "InputTag.h"

Public Member Functions
	~InputTag ()
	InputTag ()
	InputTag (std::string const &label, std::string const &instance, std::string const &processName={})
	InputTag (char const *label, char const *instance, char const *processName="")
	InputTag (std::string const &)
	InputTag (char const *)
	InputTag (InputTag const &)
	InputTag (InputTag &&)
InputTag &	operator= (InputTag const &)
InputTag &	operator= (InputTag &&)
bool	operator== (InputTag const &) const noexcept
bool	empty () const noexcept
std::string const &	label () const noexcept
std::string const &	instance () const noexcept
std::string const &	process () const noexcept
std::string	encode () const

Private Attributes
std::string	label_ {}
std::string	instance_ {}
std::string	process_ {}

Detailed Description

Definition at line 12 of file InputTag.h.

Constructor & Destructor Documentation

art::InputTag::~InputTag ( )

default

art::InputTag::InputTag ( )

default

Referenced by InputTag().

art::InputTag::InputTag	(	std::string const &	label,
		std::string const &	instance,
		std::string const &	processName = {}
	)

Definition at line 21 of file InputTag.cc.

References instance(), instance_, and process_.

    : label_{label}, instance_{instance}, process_{processName}
  {}

art::InputTag::InputTag	(	char const *	label,
		char const *	instance,
		char const *	processName = ""
	)

Definition at line 27 of file InputTag.cc.

References instance(), instance_, and process_.

    : label_{label}, instance_{instance}, process_{processName}
  {}

art::InputTag::InputTag

(

std::string const &

s

)

Definition at line 33 of file InputTag.cc.

References art::errors::Configuration, instance_, label_, and process_.

  {
    vector<string> tokens;
    boost::split(tokens, s, boost::is_any_of(":"), boost::token_compress_off);
    auto const nwords = tokens.size();
    if (nwords > 3u) {
      throw Exception(errors::Configuration,
                      "An error occurred while creating an input tag.\n")
        << "The string '" << s
        << "' has more than three colon-delimited tokens.\n"
           "The supported syntax is '<module_label>:<optional instance "
           "name>:<optional process name>'.";
    }
    if (nwords > 0) {
      label_ = tokens[0];
    }
    if (nwords > 1) {
      instance_ = tokens[1];
    }
    if (nwords > 2) {
      process_ = tokens[2];
    }
  }

art::InputTag::InputTag

(

char const *

s

)

Definition at line 57 of file InputTag.cc.

References InputTag(), and operator=().

: InputTag{string{s}} {}

art::InputTag::InputTag ( InputTag const &  )

default

art::InputTag::InputTag ( InputTag &&  )

default

Member Function Documentation

bool art::InputTag::empty ( ) const

noexcept

Definition at line 73 of file InputTag.cc.

References instance_, label_, and process_.

Referenced by DUNE::NeutrinoShowerEff::checkCNNtrkshw(), and nnet::WaveformRoiFinder::WaveformRoiFinder().

  {
    return label_.empty() && instance_.empty() && process_.empty();
  }

string art::InputTag::encode

(

)

const

Definition at line 97 of file InputTag.cc.

References instance_, label_, and process_.

Referenced by recob::DumpVertices::analyze(), sim::DumpSimChannels::analyze(), sim::DumpOpDetBacktrackerRecords::analyze(), pid::DumpParticleIDs::analyze(), sim::DumpSimPhotonsLite::analyze(), recob::DumpChargedSpacePoints::analyze(), ophit::DumpOpHits::analyze(), recob::DumpPCAxes::analyze(), recob::DumpSeeds::analyze(), recob::DumpSpacePoints::analyze(), hit::DumpHits::analyze(), recob::DumpClusters::analyze(), sim::DumpMCParticles::analyze(), sim::DumpMCTracks::analyze(), sim::DumpSimEnergyDeposits::analyze(), ophit::DumpOpFlashes::analyze(), sim::DumpMCShowers::analyze(), caldata::DumpWires::analyze(), detsim::DumpRawDigits::analyze(), sim::DumpSimPhotons::analyze(), recob::DumpPFParticles::analyze(), recob::DumpTracks::analyze(), evdb_tool::DrawLArVoxel3D::Draw(), sim::DumpMCParticles::DumpMCParticle(), sim::POTaccumulator::endSubRun(), evdb_tool::DrawWireHist::Fill(), detinfo::g4ref_time_for_event(), anab::FVectorWriter< 4 >::initOutputs(), evd::SimulationDrawer::MCTruthOrtho(), DUNE::NeutrinoShowerEff::processEff(), shower::EMShower::produce(), anab::FVectorWriter< 4 >::setDataTag(), and detinfo::trigger_times_for_event().

  {
    static string const separator{":"};
    string result = label_;
    if (!instance_.empty() || !process_.empty()) {
      result += separator + instance_;
    }
    if (!process_.empty()) {
      result += separator + process_;
    }
    return result;
  }

string const & art::InputTag::instance ( ) const

noexcept

Definition at line 85 of file InputTag.cc.

References instance_.

Referenced by art::MixHelper::declareMixOp(), art::InputTagListSelector::doMatch(), art::ConsumesCollector::emplace_back(), anab::FVectorReader< T, N >::FVectorReader(), art::ProductRetriever::getByLabel_(), art::ProductRetriever::getView(), InputTag(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), and art::operator<<().

  {
    return instance_;
  }

string const & art::InputTag::label ( ) const

noexcept

Definition at line 79 of file InputTag.cc.

References label_.

Referenced by cluster::ClusterTrackAna::analyze(), larg4::ISCalcAna::beginJob(), larg4::IonAndScint::beginJob(), art::InputTagListSelector::doMatch(), sim::DumpMCParticles::DumpMCParticle(), art::ConsumesCollector::emplace_back(), nnet::EmTrack< N >::EmTrack(), nnet::EmTrackClusterId::EmTrackClusterId(), nnet::EmTrackClusterId2out::EmTrackClusterId2out(), nnet::EmTrackMichelId::EmTrackMichelId(), cluster::ClusterTrackAna::endJob(), anab::FVectorReader< T, N >::FVectorReader(), art::ProductRetriever::getByLabel_(), reco::shower::ShowerElementHolder::GetFindManyP(), reco::shower::ShowerElementHolder::GetFindOneP(), art::ProductRetriever::getView(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), evd::SimulationDrawer::MCTruth3D(), sim::MergeSimSources::MergeSimSources(), art::operator<<(), cluster::TrajCluster::produce(), sim::MergeSimSources::produce(), and nnet::TrainingDataAlg::TrainingDataAlg().

  {
    return label_;
  }

InputTag & art::InputTag::operator= ( InputTag const &  )

default

Referenced by InputTag().

InputTag & art::InputTag::operator= ( InputTag &&  )

default

bool art::InputTag::operator== ( InputTag const &  tag ) const

noexcept

Definition at line 66 of file InputTag.cc.

References instance_, label_, and process_.

  {
    return (label_ == tag.label_) && (instance_ == tag.instance_) &&
           (process_ == tag.process_);
  }

string const & art::InputTag::process ( ) const

noexcept

Definition at line 91 of file InputTag.cc.

References process_.

Referenced by art::InputTagListSelector::doMatch(), art::ConsumesCollector::emplace_back(), anab::FVectorReader< T, N >::FVectorReader(), art::ProductRetriever::getByLabel_(), art::ProductRetriever::getView(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), and art::operator<<().

  {
    return process_;
  }

Member Data Documentation

std::string art::InputTag::instance_ {}

private

Definition at line 47 of file InputTag.h.

Referenced by empty(), encode(), InputTag(), instance(), and operator==().

std::string art::InputTag::label_ {}

private

Definition at line 46 of file InputTag.h.

Referenced by empty(), encode(), InputTag(), label(), and operator==().

std::string art::InputTag::process_ {}

private

Definition at line 48 of file InputTag.h.

Referenced by empty(), encode(), InputTag(), operator==(), and process().

---

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

• canvas/Utilities/InputTag.h
• canvas/Utilities/InputTag.cc