art::ProductProvenance Class Reference

#include "ProductProvenance.h"

Classes
struct	Transients

Public Member Functions
	ProductProvenance ()=default
	ProductProvenance (ProductID pid)
	ProductProvenance (ProductID pid, ProductStatus status)
	ProductProvenance (ProductID pid, ProductStatus status, std::shared_ptr< Parentage > parentagePtr)
	ProductProvenance (ProductID pid, ProductStatus status, ParentageID const &id)
	ProductProvenance (ProductID pid, ProductStatus status, std::vector< ProductID > const &parents)
void	write (std::ostream &os) const
ProductID	productID () const
ProductStatus const &	productStatus () const
ParentageID const &	parentageID () const
Parentage const &	parentage () const
void	setStatus (ProductStatus status) const
void	setPresent () const
void	setNotPresent () const
bool	noParentage () const

Private Member Functions
std::shared_ptr< Parentage > &	parentagePtr () const

Private Attributes
ProductID	productID_ {}
ProductStatus	productStatus_ {productstatus::uninitialized()}
ParentageID	parentageID_ {}
Transient< Transients >	transients_ {}

Detailed Description

Definition at line 31 of file ProductProvenance.h.

Constructor & Destructor Documentation

art::ProductProvenance::ProductProvenance ( )

default

art::ProductProvenance::ProductProvenance ( ProductID  pid )

explicit

Definition at line 10 of file ProductProvenance.cc.

: productID_{pid} {}

art::ProductProvenance::ProductProvenance	(	ProductID	pid,
		ProductStatus	status
	)

Definition at line 12 of file ProductProvenance.cc.

References productStatus_.

    : productID_{pid}, productStatus_{status}
  {}

art::ProductProvenance::ProductProvenance	(	ProductID	pid,
		ProductStatus	status,
		std::shared_ptr< Parentage >	parentagePtr
	)

Definition at line 23 of file ProductProvenance.cc.

References art::thread_safe_registry_via_id< K, M >::emplace(), parentageID_, parentagePtr(), and productStatus_.

    : productID_{pid}, productStatus_{status}, parentageID_{pPtr->id()}
  {
    parentagePtr() = pPtr;
    ParentageRegistry::emplace(parentageID_, *pPtr);
  }

art::ProductProvenance::ProductProvenance	(	ProductID	pid,
		ProductStatus	status,
		ParentageID const &	id
	)

Definition at line 17 of file ProductProvenance.cc.

References parentageID_, and productStatus_.

    : productID_{pid}, productStatus_{status}, parentageID_{edid}
  {}

art::ProductProvenance::ProductProvenance	(	ProductID	pid,
		ProductStatus	status,
		std::vector< ProductID > const &	parents
	)

Definition at line 32 of file ProductProvenance.cc.

References art::thread_safe_registry_via_id< K, M >::emplace(), parentageID_, parentagePtr(), and productStatus_.

    : productID_{pid}, productStatus_{status}
  {
    parentagePtr() = std::make_shared<Parentage>();
    parentagePtr()->parents() = parents;
    parentageID_ = parentagePtr()->id();
    ParentageRegistry::emplace(parentageID_, *parentagePtr());
  }

Member Function Documentation

bool art::ProductProvenance::noParentage ( ) const

inline

Definition at line 77 of file ProductProvenance.h.

References transients_.

Referenced by art::operator==(), and write().

  {
    return transients_.get().noParentage_;
  }

Parentage const & art::ProductProvenance::parentage

(

)

const

Definition at line 44 of file ProductProvenance.cc.

References art::thread_safe_registry_via_id< K, M >::get(), parentageID_, and parentagePtr().

Referenced by art::detail::KeptProvenance::insertAncestors(), art::markAncestors(), art::Provenance::parentage(), and parentageID().

  {
    if (!parentagePtr()) {
      parentagePtr() = std::make_shared<Parentage>();
      ParentageRegistry::get(
        parentageID_, *parentagePtr()); // Filled only if successful retrieval
    }
    return *parentagePtr();
  }

ParentageID const& art::ProductProvenance::parentageID ( ) const

inline

Definition at line 63 of file ProductProvenance.h.

References parentage(), and parentageID_.

Referenced by art::operator==(), and write().

  {
    return parentageID_;
  }

std::shared_ptr<Parentage>& art::ProductProvenance::parentagePtr ( ) const

inlineprivate

Definition at line 90 of file ProductProvenance.h.

References transients_.

Referenced by parentage(), and ProductProvenance().

  {
    return transients_.get().parentagePtr_;
  }

ProductID art::ProductProvenance::productID ( ) const

inline

Definition at line 53 of file ProductProvenance.h.

References productID_.

Referenced by art::operator<(), art::operator==(), art::detail::KeptProvenance::setStatus(), and write().

  {
    return productID_;
  }

ProductStatus const& art::ProductProvenance::productStatus ( ) const

inline

Definition at line 58 of file ProductProvenance.h.

References productStatus_.

Referenced by art::operator==(), art::Provenance::productStatus(), setNotPresent(), setPresent(), and write().

  {
    return productStatus_;
  }

void art::ProductProvenance::setNotPresent

(

)

const

Definition at line 64 of file ProductProvenance.cc.

References art::productstatus::dropped(), art::productstatus::neverCreated(), productStatus(), setStatus(), and art::productstatus::unknown().

Referenced by setStatus().

  {
    if (productstatus::neverCreated(productStatus()))
      return;
    if (productstatus::dropped(productStatus()))
      return;
    assert(productstatus::unknown(productStatus()));
    setStatus(productstatus::neverCreated());
  }

void art::ProductProvenance::setPresent

(

)

const

Definition at line 55 of file ProductProvenance.cc.

References art::productstatus::present(), productStatus(), setStatus(), and art::productstatus::unknown().

Referenced by setStatus().

  {
    if (productstatus::present(productStatus()))
      return;
    assert(productstatus::unknown(productStatus()));
    setStatus(productstatus::present());
  }

void art::ProductProvenance::setStatus ( ProductStatus  status ) const

inline

Definition at line 69 of file ProductProvenance.h.

References productStatus_, setNotPresent(), and setPresent().

Referenced by setNotPresent(), and setPresent().

  {
    productStatus_ = status;
  }

void art::ProductProvenance::write

(

std::ostream &

os

)

const

Definition at line 75 of file ProductProvenance.cc.

References noParentage(), parentageID(), productID(), and productStatus().

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

  {
    os << "product ID = " << productID() << '\n';
    os << "product status = " << static_cast<int>(productStatus()) << '\n';
    if (!noParentage()) {
      os << "entry description ID = " << parentageID() << '\n';
    }
  }

Member Data Documentation

ParentageID art::ProductProvenance::parentageID_ {}

private

Definition at line 97 of file ProductProvenance.h.

Referenced by parentage(), parentageID(), and ProductProvenance().

ProductID art::ProductProvenance::productID_ {}

private

Definition at line 95 of file ProductProvenance.h.

Referenced by productID().

ProductStatus art::ProductProvenance::productStatus_ {productstatus::uninitialized()}

mutableprivate

Definition at line 96 of file ProductProvenance.h.

Referenced by ProductProvenance(), productStatus(), and setStatus().

Transient<Transients> art::ProductProvenance::transients_ {}

mutableprivate

Definition at line 98 of file ProductProvenance.h.

Referenced by noParentage(), and parentagePtr().

---

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

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