DoNotRecordParents

DoNotSortUponInsertion

Other

has_fillView

has_fillView

has_fillView

has_fillView

has_fillView

has_fillView

has_setPtr

has_setPtr

has_setPtr

has_setPtr

has_setPtr

has_setPtr

key_traits

key_traits

key_traits

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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
#ifndef DataFormats_Common_traits_h
#define DataFormats_Common_traits_h

/*----------------------------------------------------------------------

Definition of traits templates used in the EDM.  


----------------------------------------------------------------------*/

#include <deque>
#include <limits>
#include <list>
#include <set>
#include <string>
#include <utility>
#include <vector>

namespace edm {
  //------------------------------------------------------------
  //
  // The trait struct template key_traits<K> is used to carry
  // information relevant to the type K when used as a 'key' in
  // RefVector and its related classes and templates.
  //
  // The general case works only for integral types K; for more
  // 'esoteric' types, one must introduce an explicit specialization.
  // That specialization must initialize the static data member
  // 'value'.

  template <class K>
  struct key_traits {
    typedef K key_type;
    static const key_type value;
  };

  template <class K>
  typename key_traits<K>::key_type const key_traits<K>::value =
      std::numeric_limits<typename key_traits<K>::key_type>::max();

  // Partial specialization for std::pair

  template <class U, class V>
  struct key_traits<std::pair<U, V> > {
    typedef std::pair<U, V> key_type;
    static const key_type value;
  };

  template <class U, class V>
  typename key_traits<std::pair<U, V> >::key_type const key_traits<std::pair<U, V> >::value =
      std::make_pair(key_traits<U>::value, key_traits<V>::value);

  // If we ever need to support instantiations of std::basic_string
  // other than std::string, this is the place to do it.

  // For value, we make a 1-character long string that contains an
  // unprintable character; we are hoping nobody ever uses such a
  // string as a legal key.
  template <>
  struct key_traits<std::string> {
    typedef std::string key_type;
    static const key_type value;
  };

  //------------------------------------------------------------
  //
  // DoNotSortUponInsertion is a base class. Derive your own class X
  // from DoNotSortUponInsertion when:
  //
  // 1. You want to use DetSetVector<X> as an EDProduct, but
  //
  // 2. You do *not* want the Event::put member template to cause the
  // DetSet<X> instances within the DetSetVector<X> to be sorted.
  //
  // DoNotSortUponInsertion has no behavior; it is used at compile
  // time to influence the behavior of Event::put.
  //
  // Usage:
  //    class MyClass : public edm::DoNotSortUponInsertion { ... }
  //
  struct DoNotSortUponInsertion {};

  //------------------------------------------------------------
  //
  // DoNotRecordParents is a base class. Derive your own (EDProduct)
  // class X from DoNotRecordParents when your class already keeps all
  // data that are relevant to parentage internally, and the
  // information kept by the event model would thus be redundant.
  //
  // DoNotRecordParents has no behavior; it is used at compile time to
  // influence the behavior of Event::put.
  //
  // Usage:
  //    class MyClass : public edm::DoNotRecordParents { ... }
  struct DoNotRecordParents {};

  // Other is a base class. NEVER USE IT. It is for the
  // core of the event model only.
  struct Other {};

  //------------------------------------------------------------
  //
  // The trait struct template has_fillView<T> is used to
  // indicate whether or not the type T has a member function
  //
  //      void T::fillView(std::vector<void const*>&) const
  //
  // We assume the 'general case' for T is to not support fillView.
  // Classes which do support fillView must specialize this trait.
  //
  //------------------------------------------------------------

  template <class T>
  struct has_fillView {
    static bool const value = false;
  };

  template <class T, class A>
  struct has_fillView<std::vector<T, A> > {
    static bool const value = true;
  };

  template <class A>
  struct has_fillView<std::vector<bool, A> > {
    static bool const value = false;
  };

  template <class T, class A>
  struct has_fillView<std::list<T, A> > {
    static bool const value = true;
  };

  template <class T, class A>
  struct has_fillView<std::deque<T, A> > {
    static bool const value = true;
  };

  template <class T, class A>
  struct has_fillView<std::set<T, A> > {
    static bool const value = true;
  };

  //------------------------------------------------------------
  //
  // The trait struct template has_setPtr<T> is used to
  // indicate whether or not the type T has a member function
  //
  //      void T::setPtr(const std::type_info&, void const*&) const
  //
  // We assume the 'general case' for T is to not support setPtr.
  // Classes which do support setPtr must specialize this trait.
  //
  //------------------------------------------------------------

  template <class T>
  struct has_setPtr {
    static bool const value = false;
  };

  template <class T, class A>
  struct has_setPtr<std::vector<T, A> > {
    static bool const value = true;
  };

  template <class A>
  struct has_setPtr<std::vector<bool, A> > {
    static bool const value = false;
  };

  template <class T, class A>
  struct has_setPtr<std::list<T, A> > {
    static bool const value = true;
  };

  template <class T, class A>
  struct has_setPtr<std::deque<T, A> > {
    static bool const value = true;
  };

  template <class T, class A>
  struct has_setPtr<std::set<T, A> > {
    static bool const value = true;
  };
}  // namespace edm

#endif