ATLAS Offline Software
IFormatTool.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef JIVEXML__IFORMATTOOL_H
6 #define JIVEXML__IFORMATTOOL_H
7 
8 #include "GaudiKernel/IAlgTool.h"
9 #include "JiveXML/DataType.h"
10 
11 namespace JiveXML {
12 
14  static const InterfaceID IID_IFormatTool("IFormatTool", 1, 0);
15 
23  class IFormatTool : virtual public IAlgTool {
24 
25  public:
27  static const InterfaceID& interfaceID();
28 
30  virtual StatusCode initialize() = 0;
31  virtual StatusCode finalize() = 0;
32 
34  virtual StatusCode SetTag( const TagType tag ) = 0;
35 
37  virtual StatusCode StartEvent( const unsigned long EventNumber, const unsigned int RunNumber,
38  const std::string& DateTime,
39  const unsigned int lumiBlock,
40  const std::string& eventProperty,
41  const std::string& geometryVersion ) = 0 ;
42 
44  virtual StatusCode EndEvent() = 0 ;
45 
47  virtual StatusCode AddToEvent( const std::string& component,
48  const std::string& key,
49  const DataMap* aMap) = 0 ;
50 
52  virtual const std::ostringstream* getFormattedEvent() const = 0;
53 
54  };
55 
56  inline const InterfaceID& IFormatTool::interfaceID()
57  {
58  return IID_IFormatTool;
59  }
60 
61 } //namespace
62 
63 #endif
64 
DataType.h
JiveXML::IFormatTool::initialize
virtual StatusCode initialize()=0
Pure virtual interface functions.
jetMakeRefSamples.geometryVersion
string geometryVersion
Definition: jetMakeRefSamples.py:68
JiveXML::IFormatTool::finalize
virtual StatusCode finalize()=0
JiveXML::IFormatTool::AddToEvent
virtual StatusCode AddToEvent(const std::string &component, const std::string &key, const DataMap *aMap)=0
Append a formatted version of one event component.
JiveXML::IFormatTool::StartEvent
virtual StatusCode StartEvent(const unsigned long EventNumber, const unsigned int RunNumber, const std::string &DateTime, const unsigned int lumiBlock, const std::string &eventProperty, const std::string &geometryVersion)=0
Start a new event.
JiveXML::IFormatTool
Abstract interface to event data formatting classes.
Definition: IFormatTool.h:23
sct_calib_tf.EventNumber
int EventNumber
Definition: sct_calib_tf.py:29
JiveXML::DataMap
std::map< std::string, DataVect > DataMap
Definition: DataType.h:59
JiveXML::IFormatTool::interfaceID
static const InterfaceID & interfaceID()
The interface identifier.
Definition: IFormatTool.h:56
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
JiveXML::IFormatTool::EndEvent
virtual StatusCode EndEvent()=0
Finialize this event.
JiveXML
This header is shared inbetween the C-style server thread and the C++ Athena ServerSvc.
Definition: BadLArRetriever.cxx:21
EventInfoWrite.RunNumber
RunNumber
Definition: EventInfoWrite.py:50
JiveXML::IFormatTool::getFormattedEvent
virtual const std::ostringstream * getFormattedEvent() const =0
Return the formated string.
JiveXML::TagType
std::pair< std::string, std::string > TagType
Defines a tag as a pair of strings.
Definition: DataType.h:62
CaloCondBlobAlgs_fillNoiseFromASCII.tag
string tag
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:24
JiveXML::IFormatTool::SetTag
virtual StatusCode SetTag(const TagType tag)=0
Set additional tags.
xAOD::lumiBlock
setTeId lumiBlock
Definition: L2StandAloneMuon_v1.cxx:327
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37