art::InputTag Class Reference

#include "InputTag.h"

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

Private Member Functions
void	set_from_string_ (std::string const &s)

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

Detailed Description

Definition at line 18 of file InputTag.h.

Constructor & Destructor Documentation

art::InputTag::InputTag ( )

default

art::InputTag::InputTag ( std::string const &  s )

inline

Definition at line 96 of file InputTag.h.

References set_from_string_().

{
  set_from_string_(s);
}

art::InputTag::InputTag ( char const *  s )

inline

Definition at line 101 of file InputTag.h.

References set_from_string_().

{
  set_from_string_(s);
}

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

inline

Definition at line 84 of file InputTag.h.

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

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

inline

Definition at line 90 of file InputTag.h.

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

Member Function Documentation

bool art::InputTag::empty ( void  ) const

inlinenoexcept

Definition at line 49 of file InputTag.h.

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

std::string art::InputTag::encode

(

)

const

Definition at line 36 of file InputTag.cc.

References instance_, label_, and process_.

Referenced by recob::DumpVertices::analyze(), sim::DumpOpDetBacktrackerRecords::analyze(), sim::DumpSimChannels::analyze(), sim::DumpSimPhotons::analyze(), recob::DumpPCAxes::analyze(), sim::DumpSimPhotonsLite::analyze(), recob::DumpSpacePoints::analyze(), recob::DumpChargedSpacePoints::analyze(), recob::DumpSeeds::analyze(), recob::DumpClusters::analyze(), hit::DumpHits::analyze(), sim::DumpMCParticles::analyze(), sim::DumpMCTracks::analyze(), caldata::DumpWires::analyze(), detsim::DumpRawDigits::analyze(), sim::DumpMCShowers::analyze(), recob::DumpPFParticles::analyze(), recob::DumpTracks::analyze(), sim::DumpMCParticles::DumpMCParticle(), evd::RecoBaseDrawer::GetBezierTracks(), anab::FVectorWriter< 4 >::initOutputs(), DUNE::NeutrinoShowerEff::processEff(), shower::EMShower::produce(), lar::example::RemoveIsolatedSpacePoints::produce(), lar::example::TotallyCheatTracker::produce(), anab::FVectorWriter< 4 >::setDataTag(), and detinfo::setDetectorClocksStandardTriggersFromEvent().

  {
    // NOTE: since the encoding gets used to form the configuration hash I did
    // not want
    // to change it so that not specifying a process would cause two colons to
    // appear in the encoding and thus not being backwards compatible
    static std::string const separator(":");
    std::string result = label_;
    if (!instance_.empty() || !process_.empty()) {
      result += separator + instance_;
    }
    if (!process_.empty()) {
      result += separator + process_;
    }
    return result;
  }

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

inlinenoexcept

Definition at line 60 of file InputTag.h.

Referenced by art::Consumer::consumes(), art::Consumer::consumesView(), art::MixHelper::declareMixOp(), art::RootBranchInfoList::findBranchInfo(), anab::FVectorReader< T, N >::FVectorReader(), art::DataViewImpl::getByLabel(), art::DataViewImpl::getView(), art::Consumer::mayConsume(), art::Consumer::mayConsumeView(), and art::operator<<().

  {
    return instance_;
  }

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

inlinenoexcept

Definition at line 55 of file InputTag.h.

Referenced by art::Consumer::consumes(), art::Consumer::consumesView(), sim::DumpMCParticles::DumpMCParticle(), art::RootBranchInfoList::findBranchInfo(), anab::FVectorReader< T, N >::FVectorReader(), art::DataViewImpl::getByLabel(), art::DataViewImpl::getView(), art::Consumer::mayConsume(), art::Consumer::mayConsumeView(), art::operator<<(), cluster::TrajCluster::produce(), nnet::TrainingDataAlg::TrainingDataAlg(), and evd::RecoBaseDrawer::VertexOrtho().

  {
    return label_;
  }

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

inlinenoexcept

Definition at line 107 of file InputTag.h.

References instance_, label_, and process_.

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

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

inlinenoexcept

an empty string means find the most recently produced product with the label and instance

Definition at line 67 of file InputTag.h.

References geo::details::operator==().

Referenced by art::Consumer::consumes(), art::Consumer::consumesView(), art::RootBranchInfoList::findBranchInfo(), anab::FVectorReader< T, N >::FVectorReader(), art::DataViewImpl::getByLabel(), art::DataViewImpl::getView(), art::Consumer::mayConsume(), art::Consumer::mayConsumeView(), art::operator<<(), and evd::RecoBaseDrawer::VertexOrtho().

  {
    return process_;
  }

void art::InputTag::set_from_string_ ( std::string const &  s )

private

Definition at line 15 of file InputTag.cc.

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

Referenced by InputTag().

  {
    // string is delimited by colons
    std::vector<std::string> tokens;
    // cet::split(s, ':', std::back_inserter(tokens));
    boost::split(tokens, s, boost::is_any_of(":"), boost::token_compress_off);

    int nwords = tokens.size();
    if (nwords > 3) {
      throw art::Exception(errors::Configuration, "InputTag")
        << "Input tag " << s << " has " << nwords << " tokens";
    }
    if (nwords > 0)
      label_ = tokens[0];
    if (nwords > 1)
      instance_ = tokens[1];
    if (nwords > 2)
      process_ = tokens[2];
  }

Member Data Documentation

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

private

Definition at line 76 of file InputTag.h.

Referenced by encode(), operator==(), and set_from_string_().

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

private

Definition at line 75 of file InputTag.h.

Referenced by encode(), operator==(), and set_from_string_().

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

private

Definition at line 77 of file InputTag.h.

Referenced by encode(), operator==(), and set_from_string_().

---

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

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