PtrVectorBase.h

Go to the documentation of this file.

#ifndef DataFormats_Common_PtrVectorBase_h
#define DataFormats_Common_PtrVectorBase_h
// -*- C++ -*-
//
// Package:     Common
// Class  :     PtrVectorBase
//
//
// Original Author:  Chris Jones
//         Created:  Wed Oct 24 15:26:45 EDT 2007
//

// user include files
#include "DataFormats/Common/interface/RefCore.h"

// system include files
#include <typeinfo>
#include <vector>
#include <cassert>

// forward declarations

namespace edm {
  class PtrVectorBase {
  public:
    typedef unsigned long key_type;
    typedef key_type size_type;

    explicit PtrVectorBase(ProductID const& productID,
                           void const* prodPtr = nullptr,
                           EDProductGetter const* prodGetter = nullptr)
        : core_(productID, prodPtr, prodGetter, false), indicies_(), cachedItems_(nullptr) {}

    PtrVectorBase(const PtrVectorBase&);

    PtrVectorBase& operator=(const PtrVectorBase&) = delete;

    virtual ~PtrVectorBase();

    // ---------- const member functions ---------------------
    bool isNull() const { return !isNonnull(); }

    //bool isNonnull() const {return id().isValid(); }
    bool isNonnull() const { return core_.isNonnull(); }

    bool operator!() const { return isNull(); }

    ProductID id() const { return core_.id(); }

    EDProductGetter const* productGetter() const { return core_.productGetter(); }

    bool hasCache() const { return cachedItems_; }

    bool isAvailable() const;

    bool empty() const { return indicies_.empty(); }

    size_type size() const { return indicies_.size(); }

    size_type capacity() const { return indicies_.capacity(); }

    void clear() {
      core_ = RefCore();
      indicies_.clear();
      if (cachedItems_) {
        delete cachedItems_.load();
        cachedItems_.store(nullptr);
      }
    }

    bool operator==(PtrVectorBase const& iRHS) const;
    // ---------- static member functions --------------------

    // ---------- member functions ---------------------------
    void reserve(size_type n) {
      indicies_.reserve(n);
      if (cachedItems_) {
        (*cachedItems_).reserve(n);
      }
    }

    void setProductGetter(EDProductGetter* iGetter) const { core_.setProductGetter(iGetter); }

    bool isTransient() const { return core_.isTransient(); }

    void const* product() const { return nullptr; }

  protected:
    PtrVectorBase();

    void swap(PtrVectorBase& other);

    void push_back_base(RefCore const& core, key_type iKey, void const* iData);

    std::vector<void const*>::const_iterator void_begin() const {
      getProduct_();
      if (not checkCachedItems()) {
        return emptyCache().begin();
      }
      return (*cachedItems_).begin();
    }
    std::vector<void const*>::const_iterator void_end() const {
      getProduct_();
      if (not checkCachedItems()) {
        return emptyCache().end();
      }
      return (*cachedItems_).end();
    }

    template <typename TPtr>
    TPtr makePtr(unsigned long iIndex) const {
      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 makePtr(std::vector<void const*>::const_iterator const iIt) const {
      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());
    }

  private:
    void getProduct_() const;
    //virtual std::type_info const& typeInfo() const = 0;
    virtual std::type_info const& typeInfo() const {
      assert(false);
      return typeid(void);
    }

    //returns false if the cache is not yet set
    bool checkCachedItems() const;

    //Used when we need an iterator but cache is not yet set
    static const std::vector<void const*>& emptyCache();

    // ---------- member data --------------------------------
    RefCore core_;
    std::vector<key_type> indicies_;
    mutable std::atomic<std::vector<void const*>*> cachedItems_;  
  };
}  // namespace edm

#endif