edm::PtrVectorBase Class Reference

#include <PtrVectorBase.h>

Inheritance diagram for edm::PtrVectorBase:

Public Types
typedef unsigned long	key_type
typedef key_type	size_type

Public Member Functions
size_type	capacity () const
	Capacity of the RefVector. More...
void	clear ()
	Clear the PtrVector. More...
bool	empty () const
	Is the RefVector empty. More...
bool	hasCache () const
ProductID	id () const
	Accessor for product ID. More...
bool	isAvailable () const
bool	isNonnull () const
	Checks for non-null. More...
bool	isNull () const
	Checks for null. More...
bool	isTransient () const
bool	operator! () const
	Checks for null. More...
bool	operator== (PtrVectorBase const &iRHS) const
void const *	product () const
EDProductGetter const *	productGetter () const
	Accessor for product getter. More...
	PtrVectorBase (ProductID const &productID, void const *prodPtr=0, EDProductGetter const *prodGetter=0)
void	reserve (size_type n)
	Reserve space for RefVector. More...
void	setProductGetter (EDProductGetter *iGetter) const
size_type	size () const
	Size of the RefVector. More...
virtual	~PtrVectorBase ()

Protected Member Functions
template<typename TPtr >
TPtr	makePtr (unsigned long iIndex) const
template<typename TPtr >
TPtr	makePtr (std::vector< void const * >::const_iterator const iIt) const
	PtrVectorBase ()
void	push_back_base (RefCore const &core, key_type iKey, void const *iData)
void	swap (PtrVectorBase &other)
	swap More...
std::vector< void const * > ::const_iterator	void_begin () const
std::vector< void const * > ::const_iterator	void_end () const

Private Member Functions
void	checkCachedItems () const
void	getProduct_ () const
virtual std::type_info const &	typeInfo () const

Private Attributes
std::vector< void const * >	cachedItems_
RefCore	core_
std::vector< key_type >	indicies_

Detailed Description

Description: Base class for PtrVector

Usage: This class defines the common behavior for the PtrVector template class instances

Definition at line 32 of file PtrVectorBase.h.

Member Typedef Documentation

typedef unsigned long edm::PtrVectorBase::key_type

Definition at line 35 of file PtrVectorBase.h.

typedef key_type edm::PtrVectorBase::size_type

Definition at line 36 of file PtrVectorBase.h.

Constructor & Destructor Documentation

edm::PtrVectorBase::PtrVectorBase ( ProductID const &  productID, void const *  prodPtr = 0, EDProductGetter const *  prodGetter = 0  )

inlineexplicit

Definition at line 38 of file PtrVectorBase.h.

                                                                  :
      core_(productID, prodPtr, prodGetter, false), indicies_() {}

edm::PtrVectorBase::~PtrVectorBase ( )

virtual

Definition at line 37 of file PtrVectorBase.cc.

                                {
  }

edm::PtrVectorBase::PtrVectorBase ( )

protected

Definition at line 34 of file PtrVectorBase.cc.

                               {
  }

Member Function Documentation

size_type edm::PtrVectorBase::capacity ( ) const

inline

Capacity of the RefVector.

Definition at line 74 of file PtrVectorBase.h.

References indicies_.

{return indicies_.capacity();}

void edm::PtrVectorBase::checkCachedItems ( ) const

private

Definition at line 129 of file PtrVectorBase.cc.

References cachedItems_, edm::hlt::Exception, id(), and edm::errors::InvalidReference.

Referenced by void_begin(), and void_end().

                                        {
    for(auto item : cachedItems_) {
      if(item == nullptr) {
        throw Exception(errors::InvalidReference) << "Asked for data from a PtrVector which refers to a non-existent product with ProductID "
                                                  << id() << "\n";
      }
    }
  }

void edm::PtrVectorBase::clear ( void  )

inline

Clear the PtrVector.

Definition at line 77 of file PtrVectorBase.h.

References cachedItems_, core_, and indicies_.

Referenced by ConvertedPhotonProducer::buildCollections(), Vispa.Views.WidgetView.WidgetView::closeEvent(), Vispa.Views.BoxDecayView.BoxDecayView::closeEvent(), Vispa.Share.FindAlgorithm.FindAlgorithm::findUsingFindDialog(), BremRecoveryClusterAlgo::makeIslandSuperClusters(), HiBremRecoveryClusterAlgo::makeIslandSuperClusters(), Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), ReducedEGProducer::produce(), Vispa.Views.LineDecayView.LineDecayView::setDataObjects(), Vispa.Views.WidgetView.WidgetView::setDataObjects(), BeautifulSoup.Tag::setString(), Vispa.Views.TreeView.TreeView::updateContent(), Vispa.Views.TableView.TableView::updateContent(), Vispa.Views.BoxDecayView.BoxDecayView::updateContent(), and Vispa.Views.PropertyView.PropertyView::updateContent().

{ core_ = RefCore(); indicies_.clear(); cachedItems_.clear(); }

bool edm::PtrVectorBase::empty ( ) const

inline

Is the RefVector empty.

Definition at line 68 of file PtrVectorBase.h.

References indicies_.

Referenced by Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), Vispa.Gui.VispaWidget.TextField::setAutosizeFont(), Vispa.Gui.VispaWidget.TextField::setAutotruncate(), and pat::PATObject< ObjectType >::setOverlaps().

{return indicies_.empty();}

void edm::PtrVectorBase::getProduct_ ( ) const

private

Definition at line 95 of file PtrVectorBase.cc.

References assert(), cachedItems_, edm::hlt::Exception, edm::WrapperBase::fillPtrVector(), edm::EDProductGetter::getIt(), edm::EDProductGetter::getThinnedProducts(), hasCache(), indicies_, relval_steps::k, edm::errors::LogicError, product(), productGetter(), and typeInfo().

Referenced by isAvailable(), void_begin(), and void_end().

                                   {
    if(hasCache()) {
      return;
    }
    if(indicies_.size() == 0) {
      return;
    }
    if(0 == productGetter()) {
      throw Exception(errors::LogicError) << "Tried to get data for a PtrVector which has no EDProductGetter\n";
    }
    WrapperBase const* product = productGetter()->getIt(id());

    if(product != nullptr) {
      product->fillPtrVector(typeInfo(), indicies_, cachedItems_);
      return;
    }

    cachedItems_.resize(indicies_.size(), nullptr);

    std::vector<unsigned int> thinnedKeys;
    thinnedKeys.assign(indicies_.begin(), indicies_.end());
    std::vector<WrapperBase const*> wrappers(indicies_.size(), nullptr);
    productGetter()->getThinnedProducts(id(), wrappers, thinnedKeys);
    unsigned int nWrappers = wrappers.size();
    assert(wrappers.size() == indicies_.size());
    assert(wrappers.size() == cachedItems_.size());
    for(unsigned k = 0; k < nWrappers; ++k) {
      if (wrappers[k] != nullptr) {
        wrappers[k]->setPtr(typeInfo(), thinnedKeys[k], cachedItems_[k]);
      }
    }
  }

bool edm::PtrVectorBase::hasCache ( ) const

inline

Definition at line 61 of file PtrVectorBase.h.

References cachedItems_.

Referenced by getProduct_(), isAvailable(), and makePtr().

{ return !cachedItems_.empty(); }

ProductID edm::PtrVectorBase::id ( void  ) const

inline

Accessor for product ID.

Definition at line 56 of file PtrVectorBase.h.

References core_, and edm::RefCore::id().

Referenced by checkCachedItems(), pf2pat::TopProjectorAlgo< Top, Bottom >::printAncestors(), and pf2pat::TopProjectorAlgo< Top, Bottom >::processCollection().

{return core_.id();}

bool edm::PtrVectorBase::isAvailable

(

)

const

True if the data is in memory or is available in the Event No type checking is done.

Definition at line 73 of file PtrVectorBase.cc.

References cachedItems_, core_, getProduct_(), hasCache(), indicies_, edm::RefCore::isAvailable(), and productGetter().

                                   {
    if(indicies_.empty()) {
      return core_.isAvailable();
    }
    if(!hasCache()) {
      if(!id().isValid() || productGetter() == nullptr) {
        return false;
      }
      getProduct_();
    }
    for(auto ptr : cachedItems_) {
      if(ptr == nullptr) {
        return false;
      }
    }
    return true;
  }

bool edm::PtrVectorBase::isNonnull ( ) const

inline

Checks for non-null.

Definition at line 50 of file PtrVectorBase.h.

References core_, and edm::RefCore::isNonnull().

Referenced by isNull().

{ return core_.isNonnull(); }

bool edm::PtrVectorBase::isNull ( ) const

inline

Checks for null.

Definition at line 46 of file PtrVectorBase.h.

References isNonnull().

Referenced by operator!().

{return !isNonnull(); }

bool edm::PtrVectorBase::isTransient ( ) const

inline

Definition at line 88 of file PtrVectorBase.h.

References core_, and edm::RefCore::isTransient().

Referenced by makePtr().

{return core_.isTransient();}

template<typename TPtr >

TPtr edm::PtrVectorBase::makePtr ( unsigned long  iIndex ) const

inlineprotected

Definition at line 114 of file PtrVectorBase.h.

References cachedItems_, hasCache(), indicies_, isTransient(), and productGetter().

                                             {
      if (isTransient()) {
        return TPtr(reinterpret_cast<typename TPtr::value_type const*>(cachedItems_[iIndex]),
                  indicies_[iIndex]);
      }
      if (hasCache() && (cachedItems_[iIndex] != nullptr || productGetter() == nullptr)) {
        return TPtr(this->id(),
                  reinterpret_cast<typename TPtr::value_type const*>(cachedItems_[iIndex]),
                  indicies_[iIndex]);
      }
      return TPtr(this->id(), indicies_[iIndex], productGetter());
    }

template<typename TPtr >

TPtr edm::PtrVectorBase::makePtr ( std::vector< void const * >::const_iterator const  iIt ) const

inlineprotected

Definition at line 128 of file PtrVectorBase.h.

References cachedItems_, hasCache(), indicies_, isTransient(), and productGetter().

                                                                       {
      if (isTransient()) {
        return TPtr(reinterpret_cast<typename TPtr::value_type const*>(*iIt),
                  indicies_[iIt - cachedItems_.begin()]);
      }
      if (hasCache() && (*iIt != nullptr || productGetter() == nullptr)) {
        return TPtr(this->id(),
                  reinterpret_cast<typename TPtr::value_type const*>(*iIt),
                  indicies_[iIt - cachedItems_.begin()]);
      }
      return TPtr(this->id(), indicies_[iIt - cachedItems_.begin()], productGetter());
    }

bool edm::PtrVectorBase::operator! ( ) const

inline

Checks for null.

Definition at line 53 of file PtrVectorBase.h.

References isNull().

{return isNull();}

bool edm::PtrVectorBase::operator==

(

PtrVectorBase const &

iRHS

)

const

Definition at line 139 of file PtrVectorBase.cc.

References core_, cond::serialization::equal(), and indicies_.

                                                           {
    if(core_ != iRHS.core_) {
      return false;
    }
    if(indicies_.size() != iRHS.indicies_.size()){
      return false;
    }
    return std::equal(indicies_.begin(),
                      indicies_.end(),
                      iRHS.indicies_.begin());
  }

void const* edm::PtrVectorBase::product ( ) const

inline

Definition at line 90 of file PtrVectorBase.h.

Referenced by getProduct_().

                                {
      return 0;
    }

EDProductGetter const* edm::PtrVectorBase::productGetter ( ) const

inline

Accessor for product getter.

Definition at line 59 of file PtrVectorBase.h.

References core_, and edm::RefCore::productGetter().

Referenced by getProduct_(), isAvailable(), and makePtr().

{return core_.productGetter();}

void edm::PtrVectorBase::push_back_base ( RefCore const &  core, key_type  iKey, void const *  iData  )

protected

Definition at line 57 of file PtrVectorBase.cc.

References cachedItems_, core_, indicies_, and edm::RefCore::pushBackItem().

Referenced by edm::PtrVector< reco::FFTJPTJet >::push_back().

                                                                                     {
    core_.pushBackItem(core, false);
    //Did we already push a 'non-cached' Ptr into the container or is this a 'non-cached' Ptr?
    if(indicies_.size() == cachedItems_.size()) {
      if(iData) {
        cachedItems_.push_back(iData);
      } else if(key_traits<key_type>::value == iKey) {
        cachedItems_.push_back(0);
      } else {
        cachedItems_.clear();
      }
    }
    indicies_.push_back(iKey);
  }

void edm::PtrVectorBase::reserve ( size_type  n )

inline

Reserve space for RefVector.

Definition at line 84 of file PtrVectorBase.h.

References cachedItems_, and indicies_.

{indicies_.reserve(n); cachedItems_.reserve(n);}

void edm::PtrVectorBase::setProductGetter ( EDProductGetter *  iGetter ) const

inline

Definition at line 86 of file PtrVectorBase.h.

References core_, and edm::RefCore::setProductGetter().

{ core_.setProductGetter(iGetter); }

size_type edm::PtrVectorBase::size ( void  ) const

inline

Size of the RefVector.

Definition at line 71 of file PtrVectorBase.h.

References indicies_.

Referenced by reco::PFMETProducerMVA::chargedEnFrac(), reco::SuperCluster::clustersSize(), NamedCandCombinerBase::combine(), reco::Conversion::EoverP(), reco::Conversion::EoverPrefittedTracks(), edm::helpers::ViewFiller< PtrVector< T > >::fill(), main(), Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), HybridClusterAlgo::makeSuperClusters(), pf2pat::TopProjectorAlgo< Top, Bottom >::maskAncestors(), reco::SuperCluster::preshowerClustersSize(), pf2pat::TopProjectorAlgo< Top, Bottom >::printAncestors(), and ReducedEGProducer::produce().

{return indicies_.size();}

void edm::PtrVectorBase::swap ( PtrVectorBase &  other )

protected

swap

Definition at line 50 of file PtrVectorBase.cc.

References cachedItems_, core_, indicies_, and edm::RefCore::swap().

Referenced by edm::PtrVector< reco::FFTJPTJet >::swap().

                                          {
    core_.swap(other.core_);
    indicies_.swap(other.indicies_);
    cachedItems_.swap(other.cachedItems_);
  }

virtual std::type_info const& edm::PtrVectorBase::typeInfo ( ) const

inlineprivatevirtual

Reimplemented in edm::PtrVector< T >, edm::PtrVector< reco::FFTCaloJet >, edm::PtrVector< reco::JetID >, edm::PtrVector< reco::GenJet >, edm::PtrVector< reco::Jet >, edm::PtrVector< CaloTower >, edm::PtrVector< reco::PFCandidate >, edm::PtrVector< reco::BaseTau >, edm::PtrVector< reco::CastorJetID >, edm::PtrVector< reco::PFClusterJet >, edm::PtrVector< reco::JPTJet >, edm::PtrVector< CaloCluster >, edm::PtrVector< reco::FFTTrackJet >, edm::PtrVector< reco::FFTGenJet >, edm::PtrVector< reco::MET >, edm::PtrVector< reco::Photon >, edm::PtrVector< reco::BasicJet >, edm::PtrVector< reco::Candidate >, edm::PtrVector< reco::FFTBasicJet >, edm::PtrVector< Candidate >, edm::PtrVector< reco::PFTau >, edm::PtrVector< reco::TrackJet >, edm::PtrVector< reco::FFTPFJet >, edm::PtrVector< reco::GsfElectron >, edm::PtrVector< reco::CaloJet >, edm::PtrVector< reco::reco::PFCluster >, edm::PtrVector< reco::CaloCluster >, edm::PtrVector< reco::Muon >, edm::PtrVector< reco::PFJet >, and edm::PtrVector< reco::FFTJPTJet >.

Definition at line 144 of file PtrVectorBase.h.

References assert().

Referenced by getProduct_().

                                                 {
      assert(false);
      return *reinterpret_cast<const std::type_info*>(0);
    }

std::vector<void const*>::const_iterator edm::PtrVectorBase::void_begin ( ) const

inlineprotected

Definition at line 102 of file PtrVectorBase.h.

References cachedItems_, checkCachedItems(), and getProduct_().

Referenced by edm::PtrVector< reco::FFTJPTJet >::begin().

                                                            {
      getProduct_();
      checkCachedItems();
      return cachedItems_.begin();
    }

std::vector<void const*>::const_iterator edm::PtrVectorBase::void_end ( ) const

inlineprotected

Definition at line 107 of file PtrVectorBase.h.

References cachedItems_, checkCachedItems(), and getProduct_().

Referenced by edm::PtrVector< reco::FFTJPTJet >::end().

                                                          {
      getProduct_();
      checkCachedItems();
      return cachedItems_.end();
    }

Member Data Documentation

std::vector<void const*> edm::PtrVectorBase::cachedItems_

mutableprivate

Definition at line 154 of file PtrVectorBase.h.

Referenced by checkCachedItems(), clear(), getProduct_(), hasCache(), isAvailable(), makePtr(), push_back_base(), reserve(), swap(), void_begin(), and void_end().

RefCore edm::PtrVectorBase::core_

private

Definition at line 152 of file PtrVectorBase.h.

Referenced by clear(), id(), isAvailable(), isNonnull(), isTransient(), operator==(), productGetter(), push_back_base(), setProductGetter(), and swap().

std::vector<key_type> edm::PtrVectorBase::indicies_

private

Definition at line 153 of file PtrVectorBase.h.

Referenced by capacity(), clear(), empty(), getProduct_(), isAvailable(), makePtr(), operator==(), push_back_base(), reserve(), size(), and swap().