|
ATLAS Offline Software
|
#include <CacheCreator.h>
|
| CacheCreator (const std::string &name, ISvcLocator *pSvcLocator) |
|
virtual | ~CacheCreator () |
|
virtual StatusCode | initialize () override |
|
virtual StatusCode | execute (const EventContext &ctx) const override |
|
virtual StatusCode | sysInitialize () override |
| Override sysInitialize. More...
|
|
virtual bool | isClonable () const override |
| Specify if the algorithm is clonable. More...
|
|
virtual unsigned int | cardinality () const override |
| Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
|
|
virtual StatusCode | sysExecute (const EventContext &ctx) override |
| Execute an algorithm. More...
|
|
virtual const DataObjIDColl & | extraOutputDeps () const override |
| Return the list of extra output dependencies. More...
|
|
virtual bool | filterPassed (const EventContext &ctx) const |
|
virtual void | setFilterPassed (bool state, const EventContext &ctx) const |
|
ServiceHandle< StoreGateSvc > & | evtStore () |
| The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
const ServiceHandle< StoreGateSvc > & | evtStore () const |
| The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
const ServiceHandle< StoreGateSvc > & | detStore () const |
| The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
virtual StatusCode | sysStart () override |
| Handle START transition. More...
|
|
virtual std::vector< Gaudi::DataHandle * > | inputHandles () const override |
| Return this algorithm's input handles. More...
|
|
virtual std::vector< Gaudi::DataHandle * > | outputHandles () const override |
| Return this algorithm's output handles. More...
|
|
Gaudi::Details::PropertyBase & | declareProperty (Gaudi::Property< T > &t) |
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &) |
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc="none") |
| Declare a new Gaudi property. More...
|
|
void | updateVHKA (Gaudi::Details::PropertyBase &) |
|
MsgStream & | msg () const |
|
MsgStream & | msg (const MSG::Level lvl) const |
|
bool | msgLvl (const MSG::Level lvl) const |
|
|
template<bool checkKey = true, typename T > |
StatusCode | createContainer (const SG::WriteHandleKey< T > &, long unsigned int, const EventContext &) const |
|
template<bool checkKey = true, typename T , typename X > |
StatusCode | createValueContainer (const SG::WriteHandleKey< T > &, long unsigned int, const EventContext &, const X &defaultValue) const |
|
bool | isInsideView (const EventContext &) const |
|
StatusCode | checkInsideViewOnce (const EventContext &) const |
|
void | renounceArray (SG::VarHandleKeyArray &handlesArray) |
| remove all handles from I/O resolution More...
|
|
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > | renounce (T &h) |
|
void | extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps) |
| Add StoreName to extra input/output deps as needed. More...
|
|
|
const TRT_ID * | m_pTRTHelper |
|
const PixelID * | m_pix_idHelper |
|
const SCT_ID * | m_sct_idHelper |
|
SG::WriteHandleKey< InDet::TRT_DriftCircleContainerCache > | m_rioContainerCacheKey {this, "TRT_DriftCircleKey", ""} |
|
SG::WriteHandleKey< SCT_ClusterContainerCache > | m_SCTclusterContainerCacheKey {this, "SCT_ClusterKey", ""} |
|
SG::WriteHandleKey< InDet::PixelClusterContainerCache > | m_PIXclusterContainerCacheKey {this,"Pixel_ClusterKey", ""} |
|
SG::WriteHandleKey< SpacePointCache > | m_PIXSpacePointCacheKey {this, "SpacePointCachePix", ""} |
|
SG::WriteHandleKey< SpacePointCache > | m_SCTSpacePointCacheKey {this, "SpacePointCacheSCT", ""} |
|
SG::WriteHandleKey< SCT_RDO_Cache > | m_SCTRDOCacheKey {this, "SCTRDOCacheKey", ""} |
|
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > | m_SCTBSErrCacheKey {this, "SCTBSErrCacheKey", ""} |
|
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > | m_SCTFlaggedCondCacheKey {this, "SCTFlaggedCondCacheKey", ""} |
|
SG::WriteHandleKey< PixelRDO_Cache > | m_PixRDOCacheKey {this, "PixRDOCacheKey", ""} |
|
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > | m_PixBSErrCacheKey {this, "PixBSErrCacheKey", ""} |
|
SG::WriteHandleKey< TRT_RDO_Cache > | m_TRTRDOCacheKey {this, "TRTRDOCacheKey", ""} |
|
BooleanProperty | m_disableTRT {this, "disableTRT", false} |
|
BooleanProperty | m_disableWarning {this, "DisableViewWarning", false} |
|
std::atomic_flag m_disableWarningCheck | ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT |
|
◆ StoreGateSvc_t
◆ CacheCreator()
InDet::CacheCreator::CacheCreator |
( |
const std::string & |
name, |
|
|
ISvcLocator * |
pSvcLocator |
|
) |
| |
◆ ~CacheCreator()
InDet::CacheCreator::~CacheCreator |
( |
| ) |
|
|
virtualdefault |
◆ cardinality()
unsigned int AthReentrantAlgorithm::cardinality |
( |
| ) |
const |
|
overridevirtualinherited |
Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
Override this to return 0 for reentrant algorithms.
Override this to return 0 for reentrant algorithms.
Definition at line 55 of file AthReentrantAlgorithm.cxx.
◆ checkInsideViewOnce()
StatusCode IDCCacheCreatorBase::checkInsideViewOnce |
( |
const EventContext & |
ctx | ) |
const |
|
protectedinherited |
Definition at line 21 of file IDCCacheCreatorBase.cxx.
23 if(!m_disableWarningCheck.test_and_set(std::memory_order_relaxed)){
25 ATH_MSG_ERROR(
"CacheCreator is running inside a view, this is probably a misconfiguration");
26 return StatusCode::FAILURE;
29 return StatusCode::SUCCESS;
◆ createContainer()
template<bool checkKey, typename T >
StatusCode IDCCacheCreatorBase::createContainer |
( |
const SG::WriteHandleKey< T > & |
containerKey, |
|
|
long unsigned int |
size, |
|
|
const EventContext & |
ctx |
|
) |
| const |
|
protectedinherited |
Definition at line 31 of file IDCCacheCreatorBase.h.
33 if constexpr (checkKey){
34 if(containerKey.
key().empty()){
35 ATH_MSG_DEBUG(
"Creation of container "<< containerKey.
key() <<
" is disabled (no name specified)");
36 return StatusCode::SUCCESS;
42 return StatusCode::SUCCESS;
◆ createValueContainer()
template<bool checkKey, typename T , typename X >
StatusCode IDCCacheCreatorBase::createValueContainer |
( |
const SG::WriteHandleKey< T > & |
containerKey, |
|
|
long unsigned int |
size, |
|
|
const EventContext & |
ctx, |
|
|
const X & |
defaultValue |
|
) |
| const |
|
protectedinherited |
Definition at line 46 of file IDCCacheCreatorBase.h.
48 if constexpr (checkKey){
49 if(containerKey.
key().empty()){
50 ATH_MSG_DEBUG(
"Creation of container "<< containerKey.
key() <<
" is disabled (no name specified)");
51 return StatusCode::SUCCESS;
55 ATH_CHECK( ContainerCacheKey.recordNonConst ( std::make_unique<T>(
size, defaultValue) ));
57 return StatusCode::SUCCESS;
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleBase
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 245 of file AthCommonDataStore.h.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleKey
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 221 of file AthCommonDataStore.h.
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This is the generic version, for types that do not derive from SG::VarHandleKey
. It just forwards to the base class version of declareProperty
.
Definition at line 333 of file AthCommonDataStore.h.
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This dispatches to either the generic declareProperty
or the one for VarHandle/Key/KeyArray.
Definition at line 352 of file AthCommonDataStore.h.
◆ declareProperty() [6/6]
◆ detStore()
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ execute()
StatusCode InDet::CacheCreator::execute |
( |
const EventContext & |
ctx | ) |
const |
|
overridevirtual |
◆ extraDeps_update_handler()
Add StoreName to extra input/output deps as needed.
use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given
◆ extraOutputDeps()
const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps |
( |
| ) |
const |
|
overridevirtualinherited |
Return the list of extra output dependencies.
This list is extended to include symlinks implied by inheritance relations.
Definition at line 79 of file AthReentrantAlgorithm.cxx.
86 return Algorithm::extraOutputDeps();
◆ filterPassed()
virtual bool AthReentrantAlgorithm::filterPassed |
( |
const EventContext & |
ctx | ) |
const |
|
inlinevirtualinherited |
◆ initialize()
StatusCode InDet::CacheCreator::initialize |
( |
| ) |
|
|
overridevirtual |
◆ inputHandles()
Return this algorithm's input handles.
We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.
◆ isClonable()
bool AthReentrantAlgorithm::isClonable |
( |
| ) |
const |
|
overridevirtualinherited |
Specify if the algorithm is clonable.
Reentrant algorithms are clonable.
Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, InDet::SiSPGNNTrackMaker, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.
Definition at line 44 of file AthReentrantAlgorithm.cxx.
◆ isInsideView()
bool IDCCacheCreatorBase::isInsideView |
( |
const EventContext & |
context | ) |
const |
|
protectedinherited |
◆ msg() [1/2]
◆ msg() [2/2]
◆ msgLvl()
◆ outputHandles()
Return this algorithm's output handles.
We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.
◆ renounce()
◆ renounceArray()
◆ setFilterPassed()
virtual void AthReentrantAlgorithm::setFilterPassed |
( |
bool |
state, |
|
|
const EventContext & |
ctx |
|
) |
| const |
|
inlinevirtualinherited |
◆ sysExecute()
StatusCode AthReentrantAlgorithm::sysExecute |
( |
const EventContext & |
ctx | ) |
|
|
overridevirtualinherited |
Execute an algorithm.
We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.
Definition at line 67 of file AthReentrantAlgorithm.cxx.
69 return Gaudi::Algorithm::sysExecute (ctx);
◆ sysInitialize()
StatusCode AthReentrantAlgorithm::sysInitialize |
( |
| ) |
|
|
overridevirtualinherited |
Override sysInitialize.
Override sysInitialize from the base class.
Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc
Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc
Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.
Reimplemented in InputMakerBase, and HypoBase.
Definition at line 96 of file AthReentrantAlgorithm.cxx.
107 if ( cs.retrieve().isFailure() ) {
109 return StatusCode::SUCCESS;
111 if (cs->regHandle(
this,*
h).isFailure()) {
112 sc = StatusCode::FAILURE;
113 ATH_MSG_ERROR(
"unable to register WriteCondHandle " <<
h->fullKey()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ ATLAS_THREAD_SAFE
std::atomic_flag m_disableWarningCheck IDCCacheCreatorBase::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT |
|
mutableprotectedinherited |
◆ m_detStore
◆ m_disableTRT
BooleanProperty InDet::CacheCreator::m_disableTRT {this, "disableTRT", false} |
|
protected |
◆ m_disableWarning
BooleanProperty InDet::CacheCreator::m_disableWarning {this, "DisableViewWarning", false} |
|
protected |
◆ m_evtStore
◆ m_extendedExtraObjects
DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects |
|
privateinherited |
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Empty if no symlinks were found.
Definition at line 153 of file AthReentrantAlgorithm.h.
◆ m_pix_idHelper
◆ m_PixBSErrCacheKey
◆ m_PIXclusterContainerCacheKey
◆ m_PixRDOCacheKey
◆ m_PIXSpacePointCacheKey
◆ m_pTRTHelper
◆ m_rioContainerCacheKey
◆ m_sct_idHelper
◆ m_SCTBSErrCacheKey
◆ m_SCTclusterContainerCacheKey
◆ m_SCTFlaggedCondCacheKey
◆ m_SCTRDOCacheKey
◆ m_SCTSpacePointCacheKey
◆ m_TRTRDOCacheKey
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
def retrieve(aClass, aKey=None)
BooleanProperty m_disableTRT
StatusCode createContainer(const SG::WriteHandleKey< T > &, long unsigned int, const EventContext &) const
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > m_SCTBSErrCacheKey
SG::WriteHandleKey< SCT_ClusterContainerCache > m_SCTclusterContainerCacheKey
SG::WriteHandleKey< SpacePointCache > m_SCTSpacePointCacheKey
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
SG::WriteHandleKey< InDet::PixelClusterContainerCache > m_PIXclusterContainerCacheKey
size_type straw_layer_hash_max(void) const
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce(T &h)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
StatusCode checkInsideViewOnce(const EventContext &) const
const std::string & key() const
Return the StoreGate ID for the referenced object.
SG::WriteHandleKey< SpacePointCache > m_PIXSpacePointCacheKey
const ServiceHandle< StoreGateSvc > & detStore() const
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual void setOwner(IDataHandleHolder *o)=0
StatusCode createValueContainer(const SG::WriteHandleKey< T > &, long unsigned int, const EventContext &, const X &defaultValue) const
const ExtendedEventContext & getExtendedEventContext(const EventContext &ctx)
Retrieve an extended context from a context object.
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > m_SCTFlaggedCondCacheKey
::StatusCode StatusCode
StatusCode definition for legacy code.
const SCT_ID * m_sct_idHelper
const TRT_ID * m_pTRTHelper
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
DataObjIDColl m_extendedExtraObjects
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
const PixelID * m_pix_idHelper
size_type wafer_hash_max(void) const
SG::WriteHandleKey< TRT_RDO_Cache > m_TRTRDOCacheKey
virtual StatusCode sysInitialize() override
Override sysInitialize.
IDCCacheCreatorBase(const std::string &name, ISvcLocator *pSvcLocator)
Constructor.
size_type wafer_hash_max(void) const
SG::WriteHandleKey< InDet::TRT_DriftCircleContainerCache > m_rioContainerCacheKey
#define ATH_MSG_WARNING(x)
SG::WriteHandleKey< IDCInDetBSErrContainer_Cache > m_PixBSErrCacheKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
BooleanProperty m_disableWarning
SG::WriteHandleKey< SCT_RDO_Cache > m_SCTRDOCacheKey
SG::WriteHandleKey< PixelRDO_Cache > m_PixRDOCacheKey
This is a "hash" representation of an Identifier. This encodes a 32 bit index which can be used to lo...
This class is to provide an event wide MT container for concurrent storing of basic types,...
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
bool isInsideView(const EventContext &) const