BaseHolder

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
#ifndef DataFormats_Common_BaseHolder_h
#define DataFormats_Common_BaseHolder_h

#include "DataFormats/Common/interface/CMS_CLASS_VERSION.h"
#include "DataFormats/Common/interface/EDProductGetter.h"

#include <memory>

namespace edm {
  class ProductID;

  namespace reftobase {
    class RefHolderBase;
    template <typename T>
    class BaseVectorHolder;
    class RefVectorHolderBase;

    //------------------------------------------------------------------
    // Class template BaseHolder<T>
    //
    // BaseHolder<T> is an abstract base class that manages a single
    // edm::Ref to an element of type T in a collection in the Event;
    // the purpose of this abstraction is to hide the type of the
    // collection from code that can not know about that type.
    //
    //------------------------------------------------------------------
    template <typename T>
    class BaseHolder {
    public:
      BaseHolder();
      virtual ~BaseHolder();
      virtual BaseHolder<T>* clone() const = 0;

      void swap(BaseHolder&);

      // Return the address of the element to which the hidden Ref
      // refers.
      virtual T const* getPtr() const = 0;

      // Return the ProductID of the collection to which the hidden
      // Ref refers.
      virtual ProductID id() const = 0;
      virtual size_t key() const = 0;
      // Check to see if the Ref hidden in 'rhs' is equal to the Ref
      // hidden in 'this'. They can not be equal if they are of
      // different types. Note that the equality test also returns
      // false if dynamic type of 'rhs' is different from the dynamic
      // type of 'this', *even when the hiddens Refs are actually
      // equivalent*.
      virtual bool isEqualTo(BaseHolder<T> const& rhs) const = 0;

      virtual std::unique_ptr<RefHolderBase> holder() const = 0;

      virtual std::unique_ptr<BaseVectorHolder<T> > makeVectorHolder() const = 0;

      virtual EDProductGetter const* productGetter() const = 0;

      /// Checks if product collection is in memory or available
      /// in the Event. No type checking is done.
      virtual bool isAvailable() const = 0;

      virtual bool isTransient() const = 0;

      //Used by ROOT storage
      CMS_CLASS_VERSION(10)

    protected:
      // We want the following called only by derived classes.
      BaseHolder(BaseHolder const& other);
      BaseHolder& operator=(BaseHolder const& rhs);

    private:
    };

    //------------------------------------------------------------------
    // Implementation of BaseHolder<T>
    //------------------------------------------------------------------

    template <typename T>
    BaseHolder<T>::BaseHolder() {}

    template <typename T>
    BaseHolder<T>::BaseHolder(BaseHolder const& /*other*/) {
      // Nothing to do.
    }

    template <typename T>
    BaseHolder<T>& BaseHolder<T>::operator=(BaseHolder<T> const& /*other*/) {
      // No data to assign.
      return *this;
    }

    template <typename T>
    BaseHolder<T>::~BaseHolder() {
      // nothing to do.
    }

    template <typename T>
    void BaseHolder<T>::swap(BaseHolder<T>& /*other*/) {
      // nothing to do.
    }

    // Free swap function
    template <typename T>
    inline void swap(BaseHolder<T>& lhs, BaseHolder<T>& rhs) {
      lhs.swap(rhs);
    }
  }  // namespace reftobase
}  // namespace edm

#endif