art::TypeLabel Class Reference

#include "TypeLabel.h"

Public Member Functions
	TypeLabel (TypeID const &itemtype, std::string const &instanceName, bool const supportsView, bool const transient)
	TypeLabel (TypeID const &itemtype, std::string const &instanceName, bool const supportsView, std::string emulatedModule)
auto const &	typeID () const
std::string	className () const
std::string	friendlyClassName () const
std::string const &	emulatedModule () const
std::string const &	productInstanceName () const
bool	hasEmulatedModule () const
bool	supportsView () const
bool	transient () const

Private Attributes
TypeID	typeID_
std::string	productInstanceName_
bool	supportsView_
bool	transient_ {false}
std::shared_ptr< std::string >	emulatedModule_

Friends
bool	operator< (TypeLabel const &a, TypeLabel const &b)
std::ostream &	operator<< (std::ostream &os, TypeLabel const &tl)

Detailed Description

Definition at line 22 of file TypeLabel.h.

Constructor & Destructor Documentation

art::TypeLabel::TypeLabel	(	TypeID const &	itemtype,
		std::string const &	instanceName,
		bool const	supportsView,
		bool const	transient
	)

Definition at line 10 of file TypeLabel.cc.

References productInstanceName_, supportsView(), supportsView_, and transient_.

    : typeID_{itemtype}
    , productInstanceName_{instanceName}
    , supportsView_{supportsView}
    , transient_{transient}
  {}

art::TypeLabel::TypeLabel	(	TypeID const &	itemtype,
		std::string const &	instanceName,
		bool const	supportsView,
		std::string	emulatedModule
	)

Definition at line 20 of file TypeLabel.cc.

References emulatedModule(), emulatedModule_, productInstanceName_, supportsView(), and supportsView_.

    : typeID_{itemtype}
    , productInstanceName_{instanceName}
    , supportsView_{supportsView}
    , emulatedModule_{std::make_unique<std::string>(std::move(emulatedModule))}
  {}

Member Function Documentation

std::string art::TypeLabel::className ( ) const

inline

Definition at line 40 of file TypeLabel.h.

References art::TypeID::className(), and typeID_.

Referenced by art::operator<(), and art::operator<<().

    {
      return typeID_.className();
    }

std::string const & art::TypeLabel::emulatedModule

(

)

const

Definition at line 31 of file TypeLabel.cc.

References emulatedModule_, and art::errors::NullPointerError.

Referenced by friendlyClassName(), art::operator<<(), and TypeLabel().

  {
    if (!emulatedModule_) {
      throw art::Exception(art::errors::NullPointerError,
                           "TypeLabel::emulatedModule\n")
        << "Attempt to retrieve an emulated module name when one does not "
           "exist.\n";
    }
    return *emulatedModule_;
  }

std::string art::TypeLabel::friendlyClassName ( ) const

inline

Definition at line 45 of file TypeLabel.h.

References emulatedModule(), art::TypeID::friendlyClassName(), and typeID_.

Referenced by art::ProductRegistryHelper::insertOrThrow().

    {
      return typeID_.friendlyClassName();
    }

bool art::TypeLabel::hasEmulatedModule ( ) const

inline

Definition at line 56 of file TypeLabel.h.

References emulatedModule_.

Referenced by art::operator<(), and art::operator<<().

    {
      return static_cast<bool>(emulatedModule_);
    }

std::string const& art::TypeLabel::productInstanceName ( ) const

inline

Definition at line 51 of file TypeLabel.h.

References productInstanceName_.

Referenced by art::ProductRegistryHelper::insertOrThrow(), and art::operator<<().

    {
      return productInstanceName_;
    }

bool art::TypeLabel::supportsView ( ) const

inline

Definition at line 61 of file TypeLabel.h.

References supportsView_.

Referenced by art::operator<<(), and TypeLabel().

    {
      return supportsView_;
    }

bool art::TypeLabel::transient ( ) const

inline

Definition at line 66 of file TypeLabel.h.

References transient_.

Referenced by art::operator<<().

    {
      return transient_;
    }

auto const& art::TypeLabel::typeID ( ) const

inline

Definition at line 35 of file TypeLabel.h.

References typeID_.

    {
      return typeID_;
    }

Friends And Related Function Documentation

bool operator< ( TypeLabel const &  a, TypeLabel const &  b  )

friend

Definition at line 45 of file TypeLabel.cc.

  {
    auto const& a_class_name = a.className();
    auto const& b_class_name = b.className();
    auto const& a_emulated_module =
      a.hasEmulatedModule() ? *a.emulatedModule_ : "<none>";
    auto const& b_emulated_module =
      b.hasEmulatedModule() ? *b.emulatedModule_ : "<none>";
    return std::tie(a_emulated_module, a.productInstanceName_, a_class_name) <
           std::tie(b_emulated_module, b.productInstanceName_, b_class_name);
  }

std::ostream& operator<< ( std::ostream &  os, TypeLabel const &  tl  )

friend

Definition at line 58 of file TypeLabel.cc.

  {
    os << "Emulated module:       '"
       << (tl.hasEmulatedModule() ? tl.emulatedModule() : "<none>") << "'\n"
       << "Product instance name: '" << tl.productInstanceName() << "'\n"
       << "Class name:            '" << tl.className() << "'\n"
       << "Supports views:        '" << std::boolalpha << tl.supportsView()
       << '\n'
       << "Transient:             '" << tl.transient();
    return os;
  }

Member Data Documentation

std::shared_ptr<std::string> art::TypeLabel::emulatedModule_

private

Initial value:

{
      nullptr}

Definition at line 76 of file TypeLabel.h.

Referenced by emulatedModule(), hasEmulatedModule(), art::operator<(), and TypeLabel().

std::string art::TypeLabel::productInstanceName_

private

Definition at line 73 of file TypeLabel.h.

Referenced by art::operator<(), productInstanceName(), and TypeLabel().

bool art::TypeLabel::supportsView_

private

Definition at line 74 of file TypeLabel.h.

Referenced by supportsView(), and TypeLabel().

bool art::TypeLabel::transient_ {false}

private

Definition at line 75 of file TypeLabel.h.

Referenced by transient(), and TypeLabel().

TypeID art::TypeLabel::typeID_

private

Definition at line 72 of file TypeLabel.h.

Referenced by className(), friendlyClassName(), and typeID().

---

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

• canvas/Persistency/Provenance/TypeLabel.h
• canvas/Persistency/Provenance/TypeLabel.cc