RefToBaseVector.h

Go to the documentation of this file.

#ifndef DataFormats_Common_RefToBaseVector_h
#define DataFormats_Common_RefToBaseVector_h

#include "DataFormats/Common/interface/CMS_CLASS_VERSION.h"
#include "DataFormats/Common/interface/FillViewHelperVector.h"
#include "DataFormats/Provenance/interface/ProductID.h"
#include <algorithm>
#include <memory>
#include <utility>
#include <vector>

namespace edm {
  template<typename T> class RefToBase;
  template<typename T> class View;
  template<typename C> class Handle;
  class EDProductGetter;
  namespace reftobase {
    template<typename T> class BaseVectorHolder;
    class RefVectorHolderBase;
  }

  template <class T>
  class RefToBaseVector {
  public:
    typedef RefToBase<T>                         value_type;
    typedef T                                    member_type;
    typedef reftobase::BaseVectorHolder<T>       holder_type;
    typedef typename holder_type::size_type      size_type;
    typedef typename holder_type::const_iterator const_iterator;

    RefToBaseVector();
    RefToBaseVector(RefToBaseVector const& );
    template<class REFV> 
    explicit RefToBaseVector(REFV const& );
    template<typename C>
    explicit RefToBaseVector(Handle<C> const& );
    RefToBaseVector(std::shared_ptr<reftobase::RefVectorHolderBase> p);
    RefToBaseVector& operator=(RefToBaseVector const& iRHS);
    void swap(RefToBaseVector& other);

    ~RefToBaseVector();

    //void reserve(size_type n);
    void clear();

    value_type at(size_type idx) const;
    value_type operator[](size_type idx) const;
    bool isValid() const { return holder_ != nullptr; }
    bool isInvalid() const { return holder_ == nullptr; }
    bool empty() const;
    size_type size() const;
    //size_type capacity() const;
    ProductID id() const;
    EDProductGetter const * productGetter() const;
    const_iterator begin() const;
    const_iterator end() const;

    void push_back( const RefToBase<T> & );

    void fillView(std::vector<void const*>& pointers, FillViewHelperVector& helpers) const;
    std::unique_ptr<reftobase::RefVectorHolderBase> vectorHolder() const;
 
    bool isAvailable() const { return holder_->isAvailable(); }
    
    //Needed for ROOT storage
    CMS_CLASS_VERSION(10)

  private:
    holder_type* holder_;
  };
}

#include "DataFormats/Common/interface/RefToBase.h"
#include "DataFormats/Common/interface/VectorHolder.h"
#include "DataFormats/Common/interface/IndirectVectorHolder.h"
#include "DataFormats/Common/interface/RefVectorHolder.h"
#include "FWCore/Utilities/interface/EDMException.h"
#include "DataFormats/Common/interface/traits.h"

namespace edm {  
  template <class T>
  inline
  void
  swap(RefToBaseVector<T>& a, RefToBaseVector<T>& b) {
    a.swap(b);
  }

  template <class T>
  inline
  bool
  operator== (RefToBaseVector<T> const& a,
          RefToBaseVector<T> const& b)
  {
    if ( a.isInvalid() && b.isInvalid() ) return true;
    if ( a.isInvalid() || b.isInvalid() ) return false;
    return  a.size() == b.size() && std::equal(a.begin(), a.end(), b.begin());
  }

  //--------------------------------------------------------------------
  // Implementation of RefToBaseVector<T>
  //--------------------------------------------------------------------
  
  template <class T>
  inline
  RefToBaseVector<T>::RefToBaseVector() : 
    holder_(nullptr)
  { }

  template <class T>
  template <class REFV>
  inline
  RefToBaseVector<T>::RefToBaseVector(const REFV& iRef) :
    holder_(new reftobase::VectorHolder<T,REFV>(iRef)) 
  { }

  template <class T>
  inline
  RefToBaseVector<T>::RefToBaseVector(const RefToBaseVector<T>& iOther) : 
    holder_(iOther.holder_ ? iOther.holder_->clone() : nullptr)
  { }

  template <class T>
  inline
  RefToBaseVector<T>::RefToBaseVector(std::shared_ptr<reftobase::RefVectorHolderBase> p) : 
    holder_(new reftobase::IndirectVectorHolder<T>(p)) {
  }

  template <class T>
  inline
  RefToBaseVector<T>& 
  RefToBaseVector<T>::operator=(const RefToBaseVector& iRHS) {
    RefToBaseVector temp(iRHS);
    this->swap(temp);
    return *this;
  }

  template <class T>
  inline
  void
  RefToBaseVector<T>::swap(RefToBaseVector& other) {
    std::swap(holder_, other.holder_);
  }

  template <class T>
  inline
  RefToBaseVector<T>::~RefToBaseVector() 
  {
    delete holder_; 
  }

  template <class T>
  inline
  typename RefToBaseVector<T>::value_type
  RefToBaseVector<T>::at(size_type idx) const 
  {
    if ( holder_ == nullptr )
      Exception::throwThis( errors::InvalidReference,
    "Trying to dereference null RefToBaseVector<T> in method: at(",
    idx,
    ")\n");
    return holder_->at( idx );
  }

  template <class T>
  inline
  typename RefToBaseVector<T>::value_type
  RefToBaseVector<T>::operator[](size_type idx) const 
  {
    return at( idx ); 
  }

  template <class T>
  inline
  bool 
  RefToBaseVector<T>::empty() const 
  {
    return holder_ ? holder_->empty() : true;
  }

  template <class T>
  inline
  typename RefToBaseVector<T>::size_type
  RefToBaseVector<T>::size() const 
  {
    return holder_ ? holder_->size() : 0;
  }

  template <class T>
  inline
  void 
  RefToBaseVector<T>::clear()
  {
    if ( holder_ != nullptr )
      holder_->clear();
  }

  template <class T>
  inline
  ProductID
  RefToBaseVector<T>::id() const
  {
    return holder_ ? holder_->id() : ProductID();
  }

  template <class T>
  inline
  EDProductGetter const * 
  RefToBaseVector<T>::productGetter() const
  {
    return holder_ ? holder_->productGetter() : nullptr;
  }

  template <class T>
  inline
  typename RefToBaseVector<T>::const_iterator
  RefToBaseVector<T>::begin() const
  {
    return holder_ ? holder_->begin() : const_iterator();
  }

  template <class T>
  inline
  typename RefToBaseVector<T>::const_iterator
  RefToBaseVector<T>::end() const
  {
    return  holder_ ? holder_->end() : const_iterator();
  }

  template <typename T>
  void
  RefToBaseVector<T>::fillView(std::vector<void const*>& pointers, FillViewHelperVector& helpers) const
  {
    pointers.reserve(this->size());
    helpers.reserve(this->size());
    for (const_iterator i=begin(), e=end(); i!=e; ++i) {
      RefToBase<T> ref = * i;
      member_type const * address = ref.isNull() ? 0 : & * ref;
      pointers.push_back(address);
      helpers.push_back(FillViewHelperVector::value_type(ref.id(),ref.key()));
    }
  }

  // NOTE: the following implementation has unusual signature!
  template <typename T>
  inline void fillView(RefToBaseVector<T> const& obj,
                       ProductID const&,
                       std::vector<void const*>& pointers,
                       FillViewHelperVector& helpers) {
    obj.fillView(pointers,helpers);
  }

  template <typename T>
  struct has_fillView<RefToBaseVector<T> > {
    static bool const value = true;
  };

  template <typename T>
  void RefToBaseVector<T>::push_back( const RefToBase<T> & r ) {
    if ( holder_ == nullptr ) {
      std::unique_ptr<reftobase::BaseVectorHolder<T> > p = r.holder_->makeVectorHolder();
      holder_ = p.release();
    }
    holder_->push_back( r.holder_ );
  }

  template <typename T>
  std::unique_ptr<reftobase::RefVectorHolderBase> RefToBaseVector<T>::vectorHolder() const {
    return holder_ ? holder_->vectorHolder() : std::unique_ptr<reftobase::RefVectorHolderBase>();
  }
}

#include "DataFormats/Common/interface/RefVector.h"
#include "DataFormats/Common/interface/Handle.h"

namespace edm {

  template<typename T>
  template<typename C>
  RefToBaseVector<T>::RefToBaseVector(const Handle<C> & h ) :
    holder_(new reftobase::VectorHolder<T, RefVector<C, typename refhelper::ValueTrait<C>::value, 
        typename refhelper::FindTrait<C, T>::value> >(h.id())) {
  }

}
#endif