ATLAS Offline Software
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-2022 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  ReadHandleKey (const std::string& key = "",
51  const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
52 
53 
67  template <class OWNER,
69  ReadHandleKey( OWNER* owner,
70  const std::string& name,
71  const std::string& key = {},
72  const std::string& doc = "");
73 
74 
83  ReadHandleKey& operator= (const std::string& sgkey);
84 
85 
86 protected:
97  const std::string& key,
98  const std::string& storeName);
99 
100 
112  template <class OWNER,
115  OWNER* owner,
116  const std::string& name,
117  const std::string& key,
118  const std::string& doc);
119 };
120 
121 
130 template <class T>
132  : public ReadHandleKey<T>
133 {
134 public:
144  InitializedReadHandleKey (const std::string& key = "",
145  const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
146 };
147 
148 
149 } // namespace SG
150 
151 
153 
154 
155 #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
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:221
SG::VarHandleKey::clid
CLID clid() const
Return the class ID for the referenced object.
Definition: StoreGate/src/VarHandleKey.cxx:177
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:133
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
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