![]() |
ATLAS Offline Software
|
Tool taking care of copying the trigger configuration from file to file. More...
#include <TriggerMenuMetaDataTool.h>
Public Types | |
Definition of the StoreGate-like object's definition | |
| typedef ServiceHandle< StoreGateSvc > | MetaStore_t |
| Type of the metadata store object in Athena. | |
| typedef const ServiceHandle< StoreGateSvc > & | MetaStorePtr_t |
| Type of the metadata store pointer in standalone mode. | |
Public Member Functions | |
| TriggerMenuMetaDataTool (const std::string &name="TriggerMenuMetaDataTool") | |
| Declare the correct constructor for Athena. | |
| virtual StatusCode | initialize () |
| Function initialising the tool. | |
| virtual StatusCode | sysInitialize () |
| Function initialising the tool in the correct way in Athena. | |
| virtual void | print () const |
| Print the state of the tool. | |
| ServiceHandle< StoreGateSvc > & | evtStore () |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. | |
| const ServiceHandle< StoreGateSvc > & | detStore () const |
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. | |
| virtual StatusCode | sysStart () override |
| Handle START transition. | |
| virtual std::vector< Gaudi::DataHandle * > | inputHandles () const override |
| Return this algorithm's input handles. | |
| virtual std::vector< Gaudi::DataHandle * > | outputHandles () const override |
| Return this algorithm's output handles. | |
| Gaudi::Details::PropertyBase & | declareProperty (Gaudi::Property< T, V, H > &t) |
| void | updateVHKA (Gaudi::Details::PropertyBase &) |
| MsgStream & | msg () const |
| bool | msgLvl (const MSG::Level lvl) const |
| DeclareInterfaceID (IMetaDataTool, 1, 0) | |
Functions providing access to the input/output metadata | |
| MetaStorePtr_t | inputMetaStore () const |
| Accessor for the input metadata store. | |
| MetaStorePtr_t | outputMetaStore () const |
| Accessor for the output metadata store. | |
Additional helper functions, not directly mimicking Athena | |
| template<class T> | |
| const T * | getProperty (const std::string &name) const |
| Get one of the tool's properties. | |
| const std::string & | msg_level_name () const __attribute__((deprecated)) |
| A deprecated function for getting the message level's name. | |
| const std::string & | getName (const void *ptr) const |
| Get the name of an object that is / should be in the event store. | |
| SG::sgkey_t | getKey (const void *ptr) const |
| Get the (hashed) key of an object that is in the event store. | |
Protected Member Functions | |
| void | renounceArray (SG::VarHandleKeyArray &handlesArray) |
| remove all handles from I/O resolution | |
| 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. | |
Functions called by the AsgMetadataTool base class | |
| virtual StatusCode | beginInputFile () |
| Function collecting the trigger configuration metadata from the input file. | |
| virtual StatusCode | endInputFile () |
| Function called when the currently open input file got completely processed. | |
| virtual StatusCode | beginEvent () |
| Function used to make sure that file openings are not missed. | |
| virtual StatusCode | metaDataStop () |
| Function writing out the collected metadata. | |
| virtual StatusCode | beginInputFile (const SG::SourceID &) |
| Function collecting the metadata from a new input file. | |
| virtual StatusCode | endInputFile (const SG::SourceID &) |
| Function collecting the metadata from a new input file. | |
| virtual StatusCode | metaDataStop (const SG::SourceID &) |
| Function writing the collected metadata to the output. | |
Callback functions helping in metadata reading/writing | |
| void | setUseIncidents (const bool flag) |
| virtual void | handle (const Incident &inc) |
| Function receiving incidents from IncidentSvc/TEvent. | |
Private Types | |
| typedef ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
| StatusCode | checkxAODTriggerMenu () |
| Perform the R2 data copy from the input metastore to the internal metastore. | |
| StatusCode | endxAODTriggerMenu () |
| Perform the R2 data copy from the internal metastore to the output metastore. | |
| StatusCode | doCopyxAODTriggerMenu (const xAOD::TriggerMenuContainer *copyFrom, xAOD::TriggerMenuContainer *copyTo) |
| Common code to copy and de-duplicate menus from the copyFrom collection into the copyTo collection. | |
| StatusCode | checkxAODTriggerMenuJson () |
| Perform the R3 data copy from the input metastore to the internal metastore. | |
| StatusCode | endxAODTriggerMenuJson () |
| Perform the R3 data copy from the internal metastore to the output metastore. | |
| StatusCode | doCopyxAODTriggerMenuJson (const std::string &inputMetaSGKey, const xAOD::TriggerMenuJsonContainer *copyFrom, xAOD::TriggerMenuJsonContainer *copyTo) |
| Common code to copy and de-duplicate menus from the copyFrom collection into the copyTo collection. | |
| StatusCode | checkCopyJson (const std::string &inputMetaSGKey, std::unique_ptr< xAOD::TriggerMenuJsonContainer > &internalContainer, std::unique_ptr< xAOD::TriggerMenuJsonAuxContainer > &internalAuxContainer) |
| Helper function to do the R3 data copy to the internal store for a given JSON. | |
| StatusCode | checkExportJson (const std::string &outputMetaSGKey, std::unique_ptr< xAOD::TriggerMenuJsonContainer > &internalContainer, std::unique_ptr< xAOD::TriggerMenuJsonAuxContainer > &internalAuxContainer) |
| Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> | |
Static Private Attributes | |
| static std::mutex s_mutex | ATLAS_THREAD_SAFE |
| Global serial protection over writing to the output store for MP. | |
Tool taking care of copying the trigger configuration from file to file.
This tool does the heavy lifting when creating/merging DxAOD files to make sure that the trigger configuration metadata ends up in the output.
Definition at line 42 of file TriggerMenuMetaDataTool.h.
|
inherited |
Type of the metadata store object in Athena.
Definition at line 66 of file AsgMetadataTool.h.
|
inherited |
Type of the metadata store pointer in standalone mode.
Definition at line 68 of file AsgMetadataTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
| xAODMaker::TriggerMenuMetaDataTool::TriggerMenuMetaDataTool | ( | const std::string & | name = "TriggerMenuMetaDataTool" | ) |
Declare the correct constructor for Athena.
Regular AlgTool constructor
Definition at line 25 of file TriggerMenuMetaDataTool.cxx.
|
protectedvirtual |
Function used to make sure that file openings are not missed.
Reimplemented from asg::AsgMetadataTool.
Definition at line 210 of file TriggerMenuMetaDataTool.cxx.
|
protectedvirtual |
Function collecting the trigger configuration metadata from the input file.
Reimplemented from asg::AsgMetadataTool.
Definition at line 83 of file TriggerMenuMetaDataTool.cxx.
|
inlineprotectedvirtual |
Function collecting the metadata from a new input file.
Implements IMetaDataTool.
Definition at line 76 of file TriggerMenuMetaDataTool.h.
|
private |
Helper function to do the R3 data copy to the internal store for a given JSON.
Definition at line 157 of file TriggerMenuMetaDataTool.cxx.
|
private |
Definition at line 274 of file TriggerMenuMetaDataTool.cxx.
|
private |
Perform the R2 data copy from the input metastore to the internal metastore.
Definition at line 91 of file TriggerMenuMetaDataTool.cxx.
|
private |
Perform the R3 data copy from the input metastore to the internal metastore.
Definition at line 147 of file TriggerMenuMetaDataTool.cxx.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
|
inherited |
|
inlineinherited |
Definition at line 145 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition at line 95 of file AthCommonDataStore.h.
|
private |
Common code to copy and de-duplicate menus from the copyFrom collection into the copyTo collection.
Definition at line 118 of file TriggerMenuMetaDataTool.cxx.
|
private |
Common code to copy and de-duplicate menus from the copyFrom collection into the copyTo collection.
Definition at line 183 of file TriggerMenuMetaDataTool.cxx.
|
protectedvirtual |
Function called when the currently open input file got completely processed.
Dummy implementation that can be overridden by the derived tool.
Reimplemented from asg::AsgMetadataTool.
Definition at line 79 of file TriggerMenuMetaDataTool.cxx.
|
inlineprotectedvirtual |
Function collecting the metadata from a new input file.
Implements IMetaDataTool.
Definition at line 79 of file TriggerMenuMetaDataTool.h.
|
private |
Perform the R2 data copy from the internal metastore to the output metastore.
Definition at line 233 of file TriggerMenuMetaDataTool.cxx.
|
private |
Perform the R3 data copy from the internal metastore to the output metastore.
Definition at line 264 of file TriggerMenuMetaDataTool.cxx.
|
inlineinherited |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition at line 85 of file AthCommonDataStore.h.
|
protectedinherited |
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
|
inherited |
Get the (hashed) key of an object that is in the event store.
This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
| ptr | The bare pointer to the object that the event store should know about |
Definition at line 119 of file AsgTool.cxx.
|
inherited |
Get the name of an object that is / should be in the event store.
This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
| ptr | The bare pointer to the object that the event store should know about |
Definition at line 106 of file AsgTool.cxx.
|
inherited |
Get one of the tool's properties.
|
protectedvirtualinherited |
Function receiving incidents from IncidentSvc/TEvent.
Reimplemented in Trig::TrigDecisionTool.
Definition at line 135 of file AsgMetadataTool.cxx.
|
virtual |
Function initialising the tool.
Reimplemented from asg::AsgTool.
Definition at line 51 of file TriggerMenuMetaDataTool.cxx.
|
overridevirtualinherited |
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.
|
inherited |
Accessor for the input metadata store.
Definition at line 93 of file AsgMetadataTool.cxx.
|
protectedvirtual |
Function writing out the collected metadata.
Reimplemented from asg::AsgMetadataTool.
Definition at line 223 of file TriggerMenuMetaDataTool.cxx.
|
inlineprotectedvirtual |
Function writing the collected metadata to the output.
Definition at line 82 of file TriggerMenuMetaDataTool.h.
|
inlineinherited |
Definition at line 24 of file AthCommonMsg.h.
|
inherited |
A deprecated function for getting the message level's name.
Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:
This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.
Definition at line 101 of file AsgTool.cxx.
|
inlineinherited |
Definition at line 30 of file AthCommonMsg.h.
|
overridevirtualinherited |
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.
|
inherited |
Accessor for the output metadata store.
Definition at line 102 of file AsgMetadataTool.cxx.
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.
Definition at line 131 of file AsgTool.cxx.
|
inlineprotectedinherited |
Definition at line 380 of file AthCommonDataStore.h.
|
inlineprotectedinherited |
remove all handles from I/O resolution
Definition at line 364 of file AthCommonDataStore.h.
|
inlineprotectedinherited |
Definition at line 132 of file AsgMetadataTool.h.
|
virtualinherited |
Function initialising the tool in the correct way in Athena.
This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.
Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.
Definition at line 115 of file AsgMetadataTool.cxx.
|
overridevirtualinherited |
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
|
inlineinherited |
Definition at line 308 of file AthCommonDataStore.h.
|
staticprivate |
Global serial protection over writing to the output store for MP.
Definition at line 178 of file TriggerMenuMetaDataTool.h.
|
private |
Internal status flag showing whether a BeginInputFile incident was seen already.
Definition at line 175 of file TriggerMenuMetaDataTool.h.
|
privateinherited |
Flag helping to discover when the tool misses the opening of the first input file.
Definition at line 126 of file AsgMetadataTool.h.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
private |
The key of the trigger menu in the input file.
Definition at line 121 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 150 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 135 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 138 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 144 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 141 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 147 of file TriggerMenuMetaDataTool.h.
|
privateinherited |
Object accessing the input metadata store.
Definition at line 119 of file AsgMetadataTool.h.
|
private |
The merged trigger menu container.
Definition at line 126 of file TriggerMenuMetaDataTool.h.
|
private |
The merged trigger menu auxiliary container.
Definition at line 128 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 168 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 169 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 153 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 154 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 156 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 157 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 162 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 163 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 159 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 160 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 165 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 166 of file TriggerMenuMetaDataTool.h.
|
private |
The key of the trigger menu for the output file.
Definition at line 123 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 151 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 136 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 139 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 145 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 142 of file TriggerMenuMetaDataTool.h.
|
private |
Definition at line 148 of file TriggerMenuMetaDataTool.h.
|
privateinherited |
Object accessing the output metadata store.
Definition at line 121 of file AsgMetadataTool.h.
|
privateinherited |
Definition at line 128 of file AsgMetadataTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.