ATLAS Offline Software
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
TBXMLWriter Class Reference

#include <TBXMLWriter.h>

Inheritance diagram for TBXMLWriter:
Collaboration diagram for TBXMLWriter:

Public Member Functions

 TBXMLWriter (const std::string &name, ISvcLocator *pSvcLocator)
 Algorithm constructor.
virtual ~TBXMLWriter ()
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) override
 Execute method.
virtual StatusCode finalize () override
const std::string & getFileDir () const
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
bool filterPassed (const EventContext &ctx) const
void setFilterPassed (bool state, const EventContext &ctx) const
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
const EventContext & getContext () const
 Deprecated methods (use the ones with EventContext).
bool filterPassed () const
void setFilterPassed (bool state) const

Protected Member Functions

virtual bool isReEntrant () const override final
 Legacy algorithms are not thread-safe.
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.

Private Types

typedef ServiceHandle< StoreGateSvc > StoreGateSvc_t

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

unsigned int m_outputFrequency
unsigned int m_eventCounter
std::vector< std::string > m_writerToolNames
std::string m_topDirectory
std::vector< TBXMLWriterToolBase * > m_writerTools
std::map< std::string, unsigned int > m_toolAccept
std::map< std::string, unsigned int > m_toolReject
std::map< std::string, unsigned int > m_toolInvoke
DataObjIDColl m_extendedExtraObjects
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default).
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * > m_vhka
bool m_varHandleArraysDeclared

Detailed Description

Definition at line 23 of file TBXMLWriter.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TBXMLWriter()

TBXMLWriter::TBXMLWriter ( const std::string & name,
ISvcLocator * pSvcLocator )

Algorithm constructor.

Definition at line 22 of file TBXMLWriter.cxx.

24 : AthAlgorithm(name,pSvcLocator)
25 , m_outputFrequency(1)
26 , m_eventCounter(0)
27{
28 declareProperty("OutputFrequency",m_outputFrequency);
29 declareProperty("WriteTools",m_writerToolNames);
30 declareProperty("FileTopDirectory",m_topDirectory);
31}
AthAlgorithm::AthAlgorithm
AthAlgorithm(const std::string &name, ISvcLocator *pSvcLocator)
Constructor with parameters:
Definition AthAlgorithm.cxx:21
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
Definition AthCommonDataStore.h:145
TBXMLWriter::m_writerToolNames
std::vector< std::string > m_writerToolNames
Definition TBXMLWriter.h:56
TBXMLWriter::m_topDirectory
std::string m_topDirectory
Definition TBXMLWriter.h:58
TBXMLWriter::m_outputFrequency
unsigned int m_outputFrequency
Definition TBXMLWriter.h:53
TBXMLWriter::m_eventCounter
unsigned int m_eventCounter
Definition TBXMLWriter.h:54

◆ ~TBXMLWriter()

TBXMLWriter::~TBXMLWriter ( )
virtual

Definition at line 33 of file TBXMLWriter.cxx.

34{ }

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl,
const SG::VarHandleKeyType &  )
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158 {
159 return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160 hndl.value(),
161 hndl.documentation());
162
163 }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
147 return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
148 }
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition AthCommonDataStore.h:156

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

◆ execute()

StatusCode TBXMLWriter::execute ( const EventContext & ctx)
overridevirtual

Execute method.

Provides access to the EventContext if needed but is non-const as opposed to AthReentrantAlgorithm.

Implements AthAlgorithm.

Definition at line 98 of file TBXMLWriter.cxx.

99{
100
102 // Check Tools //
104
106 // Output Frequency Control //
108
109 m_eventCounter++;
110 if ( m_eventCounter > 1 && m_eventCounter % m_outputFrequency != 0 )
111 {
112 return StatusCode::SUCCESS;
113 }
114
116 // XML Files //
118
119 // run info
120 // if ( m_geomWriter > 0 && thisRun != m_oldRun )
121 // {
122 // m_oldRun = thisRun;
123 // this->writeRunInfo();
124 // }
125
126 // construct directory and file name
127 std::ostringstream thisFileName;
128 thisFileName << m_topDirectory << "/evnt."
129 << std::setw(6) << std::setfill('0')
130 << ctx.eventID().run_number() << "." << std::setfill('0')
131 << std::setw(6)
132 << ctx.eventID().event_number() << ".xml" << std::ends;
133
134 std::ofstream thisFileStream((thisFileName.str()).c_str());
135
137 // Loop Tools //
139
140 for (TBXMLWriterToolBase* tool : m_writerTools)
141 {
142 StatusCode checkOut = tool->writeOut(thisFileStream);
143 m_toolInvoke[tool->name()]++;
144 if ( checkOut.isFailure() )
145 {
146 m_toolReject[tool->name()]++;
147 }
148 else
149 {
150 m_toolAccept[tool->name()]++;
151 }
152 }
153
154 // finalize the stream
155 ATH_CHECK((*(m_writerTools.begin()))->finalize(thisFileStream));
156 thisFileStream.close();
157
158 return StatusCode::SUCCESS;
159}
ATH_CHECK
#define ATH_CHECK
Evaluate an expression and check for errors.
Definition AthCheckMacros.h:40
TBXMLWriter::m_toolReject
std::map< std::string, unsigned int > m_toolReject
Definition TBXMLWriter.h:67
TBXMLWriter::m_toolInvoke
std::map< std::string, unsigned int > m_toolInvoke
Definition TBXMLWriter.h:68
TBXMLWriter::m_writerTools
std::vector< TBXMLWriterToolBase * > m_writerTools
Definition TBXMLWriter.h:60
TBXMLWriter::m_toolAccept
std::map< std::string, unsigned int > m_toolAccept
Definition TBXMLWriter.h:66
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps)
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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

51{
52 // If we didn't find any symlinks to add, just return the collection
53 // from the base class. Otherwise, return the extended collection.
54 if (!m_extendedExtraObjects.empty()) {
55 return m_extendedExtraObjects;
56 }
57 return Algorithm::extraOutputDeps();
58}
AthAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Definition AthAlgorithm.h:114

◆ filterPassed() [1/2]

bool AthAlgorithm::filterPassed ( ) const
inherited

Definition at line 94 of file AthAlgorithm.cxx.

94 {
95 return filterPassed( Gaudi::Hive::currentContext() );
96}
AthAlgorithm::filterPassed
bool filterPassed() const
Definition AthAlgorithm.cxx:94

◆ filterPassed() [2/2]

bool AthAlgorithm::filterPassed ( const EventContext & ctx) const
inherited

Definition at line 98 of file AthAlgorithm.cxx.

98 {
99 return execState( ctx ).filterPassed();
100}

◆ finalize()

StatusCode TBXMLWriter::finalize ( )
overridevirtual

Definition at line 162 of file TBXMLWriter.cxx.

163{
164 return StatusCode::SUCCESS;
165}

◆ getContext()

const EventContext & AthAlgorithm::getContext ( ) const
inherited

Deprecated methods (use the ones with EventContext).

Definition at line 90 of file AthAlgorithm.cxx.

90 {
91 return Gaudi::Hive::currentContext();
92}

◆ getFileDir()

const std::string & TBXMLWriter::getFileDir ( ) const
inline

Definition at line 44 of file TBXMLWriter.h.

44{ return m_topDirectory; }

◆ initialize()

StatusCode TBXMLWriter::initialize ( )
overridevirtual

Definition at line 40 of file TBXMLWriter.cxx.

41{
42 // loop all writers
43 for (const std::string& toolName : m_writerToolNames)
44 {
45 IAlgTool* algToolPtr;
46 Gaudi::Utils::TypeNameString writerAlgoTool(toolName);
47
48 // pick up tool
49 StatusCode checkOut = toolSvc()->retrieveTool(writerAlgoTool.type(),
50 writerAlgoTool.name(),
51 algToolPtr,
52 this);
53 // not found
54 if ( checkOut.isFailure() )
55 {
56 ATH_MSG_ERROR
57 ( "failed to pick up tool of type \042"
58 << writerAlgoTool.type()
59 << "\042 with name <"
60 << writerAlgoTool.name()
61 << ">"
62 );
63 return StatusCode::FAILURE;
64 }
65
66 // store pointer to tool if right type
67 TBXMLWriterToolBase* thisTool =
68 dynamic_cast< TBXMLWriterToolBase* >(algToolPtr);
69 if ( thisTool != 0 )
70 {
71 m_writerTools.push_back(thisTool);
72 }
73
74 }
75
76 // check tools
77 if ( m_writerTools.size() == 0 )
78 {
79 ATH_MSG_ERROR ( "no tools found!" );
80 return StatusCode::FAILURE;
81 }
82
83 for (TBXMLWriterToolBase* tool : m_writerTools)
84 {
85 // reset statistics
86 m_toolInvoke[tool->name()] = 0;
87 m_toolReject[tool->name()] = 0;
88 m_toolAccept[tool->name()] = 0;
89 }
90
91 return StatusCode::SUCCESS;
92}
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition AthMsgStreamMacros.h:33

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const
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.

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const
inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 111 of file AthAlgorithm.h.

111{ return false; }

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const
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.

◆ renounce()

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 > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381 {
382 h.renounce();
383 PBASE::renounce (h);
384 }
AthCommonDataStore::renounce
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)
Definition AthCommonDataStore.h:380

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
365 handlesArray.renounce();
366 }

◆ setFilterPassed() [1/2]

void AthAlgorithm::setFilterPassed ( bool state) const
inherited

Definition at line 102 of file AthAlgorithm.cxx.

102 {
103 setFilterPassed( state, Gaudi::Hive::currentContext() );
104}
AthAlgorithm::setFilterPassed
void setFilterPassed(bool state) const
Definition AthAlgorithm.cxx:102

◆ setFilterPassed() [2/2]

void AthAlgorithm::setFilterPassed ( bool state,
const EventContext & ctx ) const
inherited

Definition at line 106 of file AthAlgorithm.cxx.

106 {
107 execState( ctx ).setFilterPassed(state);
108}

◆ sysInitialize()

StatusCode AthAlgorithm::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 AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

66 {
67 StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
68
69 if (sc.isFailure()) {
70 return sc;
71 }
72 ServiceHandle<ICondSvc> cs("CondSvc",name());
73 for (auto h : outputHandles()) {
74 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
75 // do this inside the loop so we don't create the CondSvc until needed
76 if ( cs.retrieve().isFailure() ) {
77 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
78 return StatusCode::SUCCESS;
79 }
80 if (cs->regHandle(this,*h).isFailure()) {
81 sc = StatusCode::FAILURE;
82 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
83 << " with CondSvc");
84 }
85 }
86 }
87 return sc;
88}
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition AthMsgStreamMacros.h:32
sc
static Double_t sc
Definition LArPhysWaveHECTool.cxx:37
AthAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition AthAlgorithm.cxx:66
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::AthCommonDataStore
AthCommonDataStore(const std::string &name, T... args)
Definition AthCommonDataStore.h:55
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
312 std::vector<SG::VarHandleKey*> keys = a->keys();
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventCounter

unsigned int TBXMLWriter::m_eventCounter
private

Definition at line 54 of file TBXMLWriter.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects
privateinherited

Definition at line 114 of file AthAlgorithm.h.

◆ m_outputFrequency

unsigned int TBXMLWriter::m_outputFrequency
private

Definition at line 53 of file TBXMLWriter.h.

◆ m_toolAccept

std::map<std::string,unsigned int> TBXMLWriter::m_toolAccept
private

Definition at line 66 of file TBXMLWriter.h.

◆ m_toolInvoke

std::map<std::string,unsigned int> TBXMLWriter::m_toolInvoke
private

Definition at line 68 of file TBXMLWriter.h.

◆ m_toolReject

std::map<std::string,unsigned int> TBXMLWriter::m_toolReject
private

Definition at line 67 of file TBXMLWriter.h.

◆ m_topDirectory

std::string TBXMLWriter::m_topDirectory
private

Definition at line 58 of file TBXMLWriter.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writerToolNames

std::vector<std::string> TBXMLWriter::m_writerToolNames
private

Definition at line 56 of file TBXMLWriter.h.

◆ m_writerTools

std::vector<TBXMLWriterToolBase*> TBXMLWriter::m_writerTools
private

Definition at line 60 of file TBXMLWriter.h.

The documentation for this class was generated from the following files:
Generated on for ATLAS Offline Software by doxygen 1.16.1