Loading [MathJax]/extensions/tex2jax.js
ATLAS Offline Software
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
IMetaDataTool.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef ATHENAKERNEL_IMETADATATOOL_H
6 #define ATHENAKERNEL_IMETADATATOOL_H
7 
13 #include "GaudiKernel/IAlgTool.h"
14 #include "AthenaKernel/SourceID.h"
16 
20 class IMetaDataTool : virtual public IAlgTool {
21 
22 public: // Non-static members
24 
26  virtual StatusCode beginInputFile(const SG::SourceID& sid = "Serial") = 0;
27 
30  virtual StatusCode endInputFile(const SG::SourceID& sid = "Serial") = 0;
31 
33  virtual StatusCode metaDataStop() = 0;
34 };
35 
36 #endif
IMetaDataTool::metaDataStop
virtual StatusCode metaDataStop()=0
Function called when the tool should prepare to write its metadata.
ILockableTool.h
Provide an interface for locking and unlocking a tool externally.
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
IMetaDataTool::endInputFile
virtual StatusCode endInputFile(const SG::SourceID &sid="Serial")=0
Function called when the currently open input file got completely processed.
IMetaDataTool::beginInputFile
virtual StatusCode beginInputFile(const SG::SourceID &sid="Serial")=0
Function called when a new input file is opened.
SourceID.h
Type used to identify a metadata source.
IMetaDataTool::DeclareInterfaceID
DeclareInterfaceID(IMetaDataTool, 1, 0)
SG::SourceID
std::string SourceID
Definition: AthenaKernel/AthenaKernel/SourceID.h:25
IMetaDataTool
This class provides the interface for MetaDataTools.
Definition: IMetaDataTool.h:20