Control/AthenaKernel/AthenaKernel/CLASS_DEF.h File Reference

macros to associate a CLID to a type More...

#include "AthenaKernel/ClassID_traits.h"
#include "CxxUtils/checker_macros.h"

Include dependency graph for Control/AthenaKernel/AthenaKernel/CLASS_DEF.h:

Go to the source code of this file.

Macros
#define	CLIDREGISTRY_ADDENTRY(CID, NAME)
#define	CLIDREGISTRY_ADDENTRY2(CID, ARG1, ARG2)
#define	CLASS_DEF(NAME, CID, VERSION)
	associate a clid and a version to a type eg More...
#define	CLASS_DEF2(ARG1, ARG2, CID, VERSION)
	hack to use instead of CLASS_DEF when type name contains a comma ',' eg More...

Detailed Description

macros to associate a CLID to a type

Author

Paolo Calafiura pcala.nosp@m.fiur.nosp@m.a@lbl.nosp@m..gov

Definition in file Control/AthenaKernel/AthenaKernel/CLASS_DEF.h.

Macro Definition Documentation

CLASS_DEF

#define CLASS_DEF	(		NAME,
			CID,
			VERSION
	)

Value:

  template <>                                                           \
  struct ClassID_traits< NAME > {                                       \
    typedef std::is_base_of<DataObject, NAME> isDObj_t;                 \
    static const bool s_isDataObject = isDObj_t::value;                 \
    typedef std::integral_constant<bool, s_isDataObject> is_DataObject_tag; \
    typedef std::true_type has_classID_tag;                             \
    static const CLID& ID ATLAS_CHECK_THREAD_SAFETY () { static const CLID c(CID); return  c; }    \
    static const char* typeNameString ATLAS_CHECK_THREAD_SAFETY () {    \
      return #NAME;                                                     \
    }                                   \
    static const std::string& typeName ATLAS_CHECK_THREAD_SAFETY () {   \
      static const std::string name = typeNameString();                 \
      return name;                          \
    }                                   \
    static const std::type_info& typeInfo() {               \
      return typeid (NAME);                     \
    }                                   \
    typedef std::true_type has_version_tag;                             \
    static const int s_version = VERSION;                               \
    static const bool s_isConst = false;                                \
  };                                    \
  CLIDREGISTRY_ADDENTRY(CID, NAME)

associate a clid and a version to a type eg

CLASS_DEF(std::vector<Track*>,8901, 1)

Parameters

NAME	type name
CID	clid
VERSION	not yet used

Definition at line 65 of file Control/AthenaKernel/AthenaKernel/CLASS_DEF.h.

CLASS_DEF2

#define CLASS_DEF2	(		ARG1,
			ARG2,
			CID,
			VERSION
	)

Value:

  template <>                   \
  struct ClassID_traits< ARG1,ARG2 > {                  \
    typedef std::is_base_of<DataObject, ARG1, ARG2 > isDObj_t;          \
    static const bool s_isDataObject = isDObj_t::value;                 \
    typedef std::integral_constant<bool, s_isDataObject> is_DataObject_tag; \
    typedef std::true_type has_classID_tag;                             \
    static const CLID& ID ATLAS_CHECK_THREAD_SAFETY () {                \
      static const CLID c(CID); return  c;                              \
    }                                   \
    static const char* typeNameString ATLAS_CHECK_THREAD_SAFETY () {    \
      return #ARG1 "," #ARG2;                                           \
    }                                   \
    static const std::string& typeName ATLAS_CHECK_THREAD_SAFETY () {   \
      static const std::string name = typeNameString();                 \
      return name;                          \
    }                                   \
    static const std::type_info& typeInfo() {               \
      return typeid (ARG1,ARG2);                    \
    }                                   \
    typedef std::true_type has_version_tag;                             \
    static const int s_version = VERSION;                               \
    static const bool s_isConst = false;                                \
  };                                    \
  CLIDREGISTRY_ADDENTRY2(CID, ARG1, ARG2)

hack to use instead of CLASS_DEF when type name contains a comma ',' eg

CLASS_DEF2(map<int,string>,8900, 1)

Parameters

ARG1	type name (1st part)
ARG2	type name (2nd part)
CID	clid
VERSION	not yet used

Definition at line 101 of file Control/AthenaKernel/AthenaKernel/CLASS_DEF.h.

CLIDREGISTRY_ADDENTRY

#define CLIDREGISTRY_ADDENTRY	(		CID,
			NAME
	)

Value:

  namespace detail {                            \
    [[maybe_unused]]                                                    \
    const bool clidEntry_ ## CID =                                      \
      CLIDRegistry::addEntry<CID>(typeid(NAME),                         \
                                  ClassID_traits< NAME >::typeNameString(), \
                                  ClassName< NAME >::name());       \
  }

Definition at line 36 of file Control/AthenaKernel/AthenaKernel/CLASS_DEF.h.

CLIDREGISTRY_ADDENTRY2

#define CLIDREGISTRY_ADDENTRY2	(		CID,
			ARG1,
			ARG2
	)

Value:

  namespace detail {                            \
    [[maybe_unused]]                                                    \
    const bool clidEntry_ ## CID =                                      \
      CLIDRegistry::addEntry<CID>                                       \
      (typeid(ARG1,ARG2),                                               \
       ClassID_traits< ARG1,ARG2 >::typeNameString(),                   \
       ClassName< ARG1,ARG2 >::name());                 \
  }

Definition at line 44 of file Control/AthenaKernel/AthenaKernel/CLASS_DEF.h.