edm::RefToBase< T > Class Template Reference

#include <AssociativeIterator.h>

Public Types
typedef T	value_type

Public Member Functions
REF	castTo () const
value_type const *	get () const
std::unique_ptr< reftobase::RefHolderBase >	holder () const
ProductID	id () const
bool	isAvailable () const
bool	isNonnull () const
	Checks for non-null. More...
bool	isNull () const
	Checks for null. More...
bool	isTransient () const
size_t	key () const
bool	operator! () const
	Checks for null. More...
bool	operator!= (RefToBase const &rhs) const
value_type const &	operator* () const
value_type const *	operator-> () const
RefToBase &	operator= (RefToBase &&other) noexcept
RefToBase &	operator= (RefToBase const &rhs)
bool	operator== (RefToBase const &rhs) const
EDProductGetter const *	productGetter () const
	RefToBase ()
	RefToBase (RefToBase const &other)
	RefToBase (RefToBase &&other) noexcept
template<typename C1 , typename T1 , typename F1 >
	RefToBase (Ref< C1, T1, F1 > const &r)
template<typename C >
	RefToBase (RefProd< C > const &r)
	RefToBase (RefToBaseProd< T > const &r, size_t i)
	RefToBase (Handle< View< T >> const &handle, size_t i)
template<typename T1 >
	RefToBase (RefToBase< T1 > const &r)
	RefToBase (std::unique_ptr< reftobase::BaseHolder< value_type >>)
	RefToBase (std::shared_ptr< reftobase::RefHolderBase > p)
template<class T>
	RefToBase (std::unique_ptr< reftobase::BaseHolder< value_type >> p)
void	swap (RefToBase &other)
	~RefToBase () noexcept

Static Public Member Functions
static short	Class_Version ()

Public Attributes
template<class REF >
requires	requires

Private Member Functions
value_type const *	getPtrImpl () const

Private Attributes
reftobase::BaseHolder< value_type > *	holder_

Friends
template<typename B >
class	RefToBase
class	RefToBaseProd< T >
class	RefToBaseVector< T >

Detailed Description

template<class T>
class edm::RefToBase< T >

Definition at line 54 of file AssociativeIterator.h.

Member Typedef Documentation

value_type

template<class T>

typedef T edm::RefToBase< T >::value_type

Definition at line 72 of file RefToBase.h.

Constructor & Destructor Documentation

RefToBase() [1/11]

template<class T >

RefToBase::RefToBase ( )

inline

Definition at line 146 of file RefToBase.h.

: holder_(nullptr) {}

RefToBase() [2/11]

template<class T >

RefToBase::RefToBase ( RefToBase< T > const &  other )

inline

Definition at line 149 of file RefToBase.h.

: holder_(other.holder_ ? other.holder_->clone() : nullptr) {}

RefToBase() [3/11]

template<class T >

RefToBase::RefToBase ( RefToBase< T > &&  other )

inlinenoexcept

Definition at line 152 of file RefToBase.h.

                                                           : holder_(other.holder_) {
    other.holder_ = nullptr;
  }

RefToBase() [4/11]

template<class T >

template<typename C1 , typename T1 , typename F1 >

RefToBase::RefToBase ( Ref< C1, T1, F1 > const &  r )

inlineexplicit

Definition at line 166 of file RefToBase.h.

      : holder_(new reftobase::Holder<T, Ref<C1, T1, F1>>(iRef)) {}

RefToBase() [5/11]

template<class T >

template<typename C >

RefToBase::RefToBase ( RefProd< C > const &  r )

inlineexplicit

Definition at line 171 of file RefToBase.h.

: holder_(new reftobase::Holder<T, RefProd<C>>(iRef)) {}

RefToBase() [6/11]

template<class T>

RefToBase::RefToBase ( RefToBaseProd< T > const &  r, size_t  i  )

inline

Definition at line 343 of file RefToBase.h.

      : holder_(r.operator->()->refAt(i).holder_->clone()) {}

RefToBase() [7/11]

template<typename T>

RefToBase::RefToBase ( Handle< View< T >> const &  handle, size_t  i  )

inline

Definition at line 347 of file RefToBase.h.

      : holder_(handle.operator->()->refAt(i).holder_->clone()) {}

RefToBase() [8/11]

template<class T >

template<typename T1 >

RefToBase::RefToBase ( RefToBase< T1 > const &  r )

inlineexplicit

Definition at line 175 of file RefToBase.h.

      : holder_(
            new reftobase::IndirectHolder<T>(std::shared_ptr<edm::reftobase::RefHolderBase>(iRef.holder().release()))) {
    // OUT: holder_( new reftobase::Holder<T,RefToBase<T1> >(iRef ) )  {
    // Forcing the conversion through IndirectHolder,
    //   as Holder<T,RefToBase<T1>> would need dictionaries we will never have.
    // In this way we only need the IndirectHolder<T> and the RefHolder of the real type of the item
    // This might cause a small performance penalty.
    static_assert(std::is_base_of<T, T1>::value, "RefToBase::RefToBase T not base of T1");
  }

RefToBase() [9/11]

template<class T>

edm::RefToBase< T >::RefToBase

(

)

RefToBase() [10/11]

template<class T>

RefToBase::RefToBase ( std::shared_ptr< reftobase::RefHolderBase >  p )

inline

Definition at line 190 of file RefToBase.h.

      : holder_(new reftobase::IndirectHolder<T>(p)) {}

~RefToBase()

template<class T >

RefToBase::~RefToBase ( )

inlinenoexcept

Definition at line 194 of file RefToBase.h.

                                           {
    delete holder_;
  }

RefToBase() [11/11]

template<class T>

template<class T>

edm::RefToBase< T >::RefToBase ( std::unique_ptr< reftobase::BaseHolder< value_type >>  p )

inline

Definition at line 187 of file RefToBase.h.

: holder_(p.release()) {}

Member Function Documentation

castTo()

template<class T>

REF RefToBase::castTo

(

)

const

Definition at line 243 of file RefToBase.h.

Referenced by ElectronMcSignalValidator::analyze(), ConversionProducer::buildCollection(), MuonTrajectoryCleaner::clean(), HLTElectronPixelMatchFilter::getNrOfMatches(), pat::PATJetUpdater::produce(), ConversionTrackProducer::produce(), MuMuForEmbeddingSelector::produce(), NuclearTrackCorrector::produce(), EgammaHLTPixelMatchVarProducer::produce(), EgammaHLTExtraProducer::setSeeds(), reco::PFTau::sourceCandidatePtr(), edmtest::ViewAnalyzer::testProductWithBaseClass(), and edmtest::ViewAnalyzer::testRefVector().

                                 {
    if (!holder_) {
      Exception::throwThis(errors::InvalidReference,
                           "attempting to cast a null RefToBase;\n"
                           "You should check for nullity before casting.");
    }

    // If REF is type edm::Ref<C,T,F>, then it is impossible to
    // check the container type C here. We just have to assume
    // that the caller provided the correct type.

    EDProductGetter const* getter = productGetter();
    if (getter) {
      return REF(id(), key(), getter);
    }

    T const* value = get();
    if (value == nullptr) {
      return REF(id());
    }
    typename REF::value_type const* newValue;
    if constexpr (std::is_same_v<T, typename REF::value_type> or std::is_base_of_v<typename REF::value_type, T>) {
      newValue = value;
    } else {
      newValue = dynamic_cast<typename REF::value_type const*>(value);
    }
    if (newValue) {
      return REF(id(), newValue, key(), isTransient());
    }

    Exception::throwThis(errors::InvalidReference,
                         "RefToBase<T>::castTo Error attempting to cast mismatched types\n"
                         "casting from RefToBase with T: ",
                         typeid(T).name(),
                         "\ncasting to: ",
                         typeid(REF).name());
    return REF();
  }

Class_Version()

template<class T>

static short edm::RefToBase< T >::Class_Version ( )

inlinestatic

Definition at line 131 of file RefToBase.h.

:
    value_type const* getPtrImpl() const;

get()

template<class T >

T const * RefToBase::get ( ) const

inline

Definition at line 216 of file RefToBase.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), TkConvValidator::analyze(), TestOutliers::analyze(), PhotonValidator::analyze(), IsolatedTracksNxN::analyze(), PFElecTkProducer::applySelection(), ConversionProducer::buildCollection(), FWPFTauProxyBuilder::buildViewType(), util.rrapi.RRApi::columns(), rrapi.RRApi::columns(), PFMEtSignInterfaceBase::compResolution(), edm::helper::RefConverter< RefToBase< T >, Ptr< T > >::convert(), util.rrapi.RRApi::count(), rrapi.RRApi::count(), rrapi.RRApi::data(), util.rrapi.RRApi::data(), PFElecTkProducer::findPfRef(), reco::GenJet::genParticle(), reco::Candidate::get(), reco::LeafCandidate::get(), L6SLBCorrectorImpl::getBTagInfoIndex(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), PFElecTkProducer::isSameEgSC(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), reco::makeSpecific(), TemplatedSecondaryVertexProducer< IPTI, VTX >::matchSubjets(), pat::MET::MET(), pat::TriggerObject::origObjCand(), ConversionTrackProducer::produce(), pat::PATJetProducer::produce(), rrapi.RRApi::report(), util.rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), rrapi.RRApi::tables(), util.rrapi.RRApi::tables(), rrapi.RRApi::tags(), util.rrapi.RRApi::tags(), rrapi.RRApi::templates(), util.rrapi.RRApi::templates(), reco::ConversionTrack::track(), pat::VertexAssociation::track(), rrapi.RRApi::workspaces(), and util.rrapi.RRApi::workspaces().

                                          {
    return getPtrImpl();
  }

getPtrImpl()

template<class T >

T const * RefToBase::getPtrImpl ( ) const

inlineprivate

Definition at line 321 of file RefToBase.h.

                                                 {
    return holder_ ? holder_->getPtr() : nullptr;
  }

holder()

template<class T >

std::unique_ptr< reftobase::RefHolderBase > RefToBase::holder

(

)

const

Definition at line 326 of file RefToBase.h.

Referenced by edm::RefToBase< TrajectorySeed >::holder().

                                                                   {
    return holder_ ? holder_->holder() : std::unique_ptr<reftobase::RefHolderBase>();
  }

id()

template<class T >

ProductID RefToBase::id ( ) const

inline

Definition at line 221 of file RefToBase.h.

Referenced by VertexAssociatorByTracks::associateSimToReco(), edm::helper::RefConverter< RefToBase< T >, Ptr< T > >::convert(), equals(), pat::PATMuonProducer::fillMuon(), edm::RefToBaseVector< reco::Track >::fillView(), BTagPerformanceAnalyzerMC::getJetWithFlavour(), BTagPerformanceAnalyzerOnData::jetRefCompare(), edm::makeRefToBaseProdFrom(), LowPtConversion::match(), ConversionTools::matchesConversion(), TemplatedSecondaryVertexProducer< IPTI, VTX >::matchSubjets(), MatchJet::operator()(), TagAndProbeBtagTriggerMonitor::JetRefCompare::operator()(), BTagPerformanceAnalyzerMC::JetRefCompare::operator()(), TopMonitor::JetRefCompare::operator()(), HLTBTagPerformanceAnalyzer::JetRefCompare::operator()(), BTagAndProbe::JetRefCompare::operator()(), and pat::helper::TriggerMatchHelper::triggerMatchObject().

                                          {
    return holder_ ? holder_->id() : ProductID();
  }

isAvailable()

template<class T>

bool edm::RefToBase< T >::isAvailable ( ) const

inline

Checks if collection is in memory or available in the Event. No type checking is done. This function is potentially costly as it might cause a disk read (note that it does not cause the data to be cached locally)

Definition at line 126 of file RefToBase.h.

Referenced by edm::helper::RefConverter< RefToBase< T >, Ptr< T > >::convert(), and LowPtConversion::match().

{ return holder_ ? holder_->isAvailable() : false; }

isNonnull()

template<class T >

bool RefToBase::isNonnull ( ) const

inline

Checks for non-null.

Definition at line 290 of file RefToBase.h.

Referenced by LowPtConversion::addUserVars(), VertexClassifier::evaluate(), TrackClassifier::evaluate(), PFElecTkProducer::isSameEgSC(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), LowPtConversion::match(), RecoTracktoTP::matched(), TPtoRecoTrack::matchedA(), TPtoRecoTrack::matchedB(), reco::tau::RecoTauPiZeroStripPlugin2::operator()(), reco::tau::RecoTauPiZeroStripPlugin3::operator()(), SoftLepton::refineJetAxis(), RecoTracktoTP::RT(), TPtoRecoTrack::RTA(), TPtoRecoTrack::RTB(), and edmtest::ViewAnalyzer::testProduct().

                                            {
    return !isNull();
  }

isNull()

template<class T >

bool RefToBase::isNull ( ) const

inline

Checks for null.

Definition at line 284 of file RefToBase.h.

Referenced by pat::helper::VertexingHelper::associate(), reco::tau::RecoTauVertexAssociator::associatedVertex(), edm::RefToBaseVector< reco::Track >::fillView(), BTagPerformanceAnalyzerMC::getJetWithFlavour(), pat::VertexAssociation::hasTrack(), LowPtConversion::match(), ConversionTools::matchesConversion(), HLTMuonTrackMassFilter::pairMatched(), and RecoTauProducer::produce().

                                         {
    return !id().isValid();
  }

isTransient()

template<class T>

bool edm::RefToBase< T >::isTransient ( ) const

inline

Definition at line 128 of file RefToBase.h.

{ return holder_ ? holder_->isTransient() : false; }

key()

template<class T >

size_t RefToBase::key ( ) const

inline

Definition at line 226 of file RefToBase.h.

Referenced by MuonTrackValidator::analyze(), MuonToTrackingParticleAssociatorByHitsImpl::associateMuons(), VertexAssociatorByTracks::associateSimToReco(), PFDisplacedVertexFinder::commonTracks(), edm::helper::RefConverter< RefToBase< T >, Ptr< T > >::convert(), equals(), edm::RefToBaseVector< reco::Track >::fillView(), BTagPerformanceAnalyzerOnData::jetRefCompare(), PFDisplacedVertexCandidateFinder::link(), LowPtConversion::match(), ConversionTools::matchesConversion(), TemplatedSecondaryVertexProducer< IPTI, VTX >::matchSubjets(), TagAndProbeBtagTriggerMonitor::JetRefCompare::operator()(), BTagPerformanceAnalyzerMC::JetRefCompare::operator()(), TopMonitor::JetRefCompare::operator()(), HLTBTagPerformanceAnalyzer::JetRefCompare::operator()(), BTagAndProbe::JetRefCompare::operator()(), PFDisplacedTrackerVertexProducer::produce(), Onia2MuMuPAT::produce(), and pat::helper::TriggerMatchHelper::triggerMatchObject().

                                        {
    if (holder_ == nullptr) {
      Exception::throwThis(errors::InvalidReference,
                           "attempting get key from  null RefToBase;\n"
                           "You should check for nullity before calling key().");
      return 0;
    }
    return holder_->key();
  }

operator!()

template<class T >

bool RefToBase::operator! ( ) const

inline

Checks for null.

Definition at line 296 of file RefToBase.h.

                                            {
    return isNull();
  }

operator!=()

template<class T>

bool RefToBase::operator!= ( RefToBase< T > const &  rhs ) const

inline

Definition at line 306 of file RefToBase.h.

                                                                    {
    return !(*this == rhs);
  }

operator*()

template<class T >

T const & RefToBase::operator* ( ) const

inline

Definition at line 206 of file RefToBase.h.

                                                {
    return *getPtrImpl();
  }

operator->()

template<class T >

T const * RefToBase::operator-> ( ) const

inline

Definition at line 211 of file RefToBase.h.

                                                 {
    return getPtrImpl();
  }

operator=() [1/2]

template<class T >

RefToBase< T > & RefToBase::operator= ( RefToBase< T > &&  other )

inlinenoexcept

Definition at line 157 of file RefToBase.h.

                                                                         {
    delete holder_;
    holder_ = other.holder_;
    other.holder_ = nullptr;
    return *this;
  }

operator=() [2/2]

template<class T>

RefToBase& edm::RefToBase< T >::operator=

(

RefToBase< T > const &

rhs

)

operator==()

template<class T>

bool RefToBase::operator== ( RefToBase< T > const &  rhs ) const

inline

Definition at line 301 of file RefToBase.h.

                                                                    {
    return holder_ ? holder_->isEqualTo(*rhs.holder_) : holder_ == rhs.holder_;
  }

productGetter()

template<class T >

EDProductGetter const * RefToBase::productGetter ( ) const

inline

Definition at line 316 of file RefToBase.h.

                                                                  {
    return holder_ ? holder_->productGetter() : nullptr;
  }

swap()

template<class T>

void RefToBase::swap ( RefToBase< T > &  other )

inline

Definition at line 311 of file RefToBase.h.

                                                    {
    std::swap(holder_, other.holder_);
  }

Friends And Related Function Documentation

RefToBase

template<class T>

template<typename B >

friend class RefToBase

friend

Definition at line 138 of file RefToBase.h.

RefToBaseProd< T >

template<class T>

friend class RefToBaseProd< T >

friend

Definition at line 136 of file RefToBase.h.

RefToBaseVector< T >

template<class T>

friend class RefToBaseVector< T >

friend

Definition at line 135 of file RefToBase.h.

Member Data Documentation

holder_

template<class T>

reftobase::BaseHolder<value_type>* edm::RefToBase< T >::holder_

private

Definition at line 134 of file RefToBase.h.

Referenced by edm::RefToBase< TrajectorySeed >::isAvailable(), edm::RefToBase< TrajectorySeed >::isTransient(), and edm::RefToBase< TrajectorySeed >::operator==().

requires

template<class T>

template<class REF >

requires edm::RefToBase< T >::requires

Initial value:

{
        typename REF::value_type

Definition at line 102 of file RefToBase.h.