Loading [MathJax]/extensions/tex2jax.js
ATLAS Offline Software
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
StoreGate/StoreGate/ReadHandleKey.h
Go to the documentation of this file.
1 // This file's extension implies that it's C, but it's really -*- C++ -*-.
2 
3 /*
4  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
5 */
14 #ifndef STOREGATE_READHANDLEKEY_H
15 #define STOREGATE_READHANDLEKEY_H
16 
17 
18 #include "StoreGate/VarHandleKey.h"
19 #include "StoreGate/exceptions.h"
20 #include "AthenaKernel/CLASS_DEF.h"
21 
22 
23 namespace SG {
24 
25 
36 template <class T>
38  : public VarHandleKey
39 {
40 public:
50  explicit
51  ReadHandleKey (const std::string& key = "",
52  const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
53 
54 
68  template <class OWNER,
70  ReadHandleKey( OWNER* owner,
71  const std::string& name,
72  const std::string& key = {},
73  const std::string& doc = "");
74 
75 
84  ReadHandleKey& operator= (const std::string& sgkey);
85 
86 
87 protected:
98  const std::string& key,
99  const std::string& storeName);
100 
101 
113  template <class OWNER,
116  OWNER* owner,
117  const std::string& name,
118  const std::string& key,
119  const std::string& doc);
120 };
121 
122 
131 template <class T>
133  : public ReadHandleKey<T>
134 {
135 public:
145  InitializedReadHandleKey (const std::string& key = "",
146  const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
147 };
148 
149 
150 } // namespace SG
151 
152 
154 
155 
156 #endif // not STOREGATE_READHANDLEKEY_H
common.sgkey
def sgkey(tool)
Definition: common.py:1028
SG::ReadHandleKey::ReadHandleKey
ReadHandleKey(CLID clid, const std::string &key, const std::string &storeName)
Constructor with explicit CLID.
VarHandleKey.h
A property holding a SG store/key/clid from which a VarHandle is made.
SG
Forward declaration.
Definition: CaloCellPacker_400_500.h:32
SG::ReadHandleKey::ReadHandleKey
ReadHandleKey(CLID clid, OWNER *owner, const std::string &name, const std::string &key, const std::string &doc)
Auto-declaring constructor with explicit CLID.
ReadHandleKey.icc
athena.value
value
Definition: athena.py:124
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
SG::ReadHandleKey
Property holding a SG store/key/clid from which a ReadHandle is made.
Definition: StoreGate/StoreGate/ReadHandleKey.h:39
python.CaloAddPedShiftConfig.type
type
Definition: CaloAddPedShiftConfig.py:42
SG::ReadHandleKey::ReadHandleKey
ReadHandleKey(const std::string &key="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
Constructor.
SG::ReadHandleKey::ReadHandleKey
ReadHandleKey(OWNER *owner, const std::string &name, const std::string &key={}, const std::string &doc="")
Auto-declaring Property constructor.
exceptions.h
Exceptions that can be thrown from StoreGate.
SG::InitializedReadHandleKey::InitializedReadHandleKey
InitializedReadHandleKey(const std::string &key="", const std::string &storeName=StoreID::storeName(StoreID::EVENT_STORE))
Constructor.
CLID
uint32_t CLID
The Class ID type.
Definition: Event/xAOD/xAODCore/xAODCore/ClassID_traits.h:47
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
SG::VarHandleKey::clid
CLID clid() const
Return the class ID for the referenced object.
Definition: StoreGate/src/VarHandleKey.cxx:185
SG::VarHandleKey
A property holding a SG store/key/clid from which a VarHandle is made.
Definition: StoreGate/StoreGate/VarHandleKey.h:62
SG::InitializedReadHandleKey
ReadHandleKey that initializes during construction.
Definition: StoreGate/StoreGate/ReadHandleKey.h:134
SG::ReadHandleKey::operator=
ReadHandleKey & operator=(const std::string &sgkey)
Change the key of the object to which we're referring.
StoreID::EVENT_STORE
@ EVENT_STORE
Definition: StoreID.h:26
CLASS_DEF.h
macros to associate a CLID to a type
StoreID::storeName
static const std::string & storeName(const StoreID::type &s)
Definition: StoreID.cxx:77