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 () override
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.
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

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.

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< 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.

  : AthAlgorithm(name,pSvcLocator)
    , m_outputFrequency(1)
    , m_eventCounter(0)
{
  declareProperty("OutputFrequency",m_outputFrequency);
  declareProperty("WriteTools",m_writerToolNames);
  declareProperty("FileTopDirectory",m_topDirectory);
}

~TBXMLWriter()

TBXMLWriter::~TBXMLWriter ( )

virtual

Definition at line 33 of file TBXMLWriter.cxx.

{ }

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< 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.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode TBXMLWriter::execute ( )

overridevirtual

Definition at line 98 of file TBXMLWriter.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();

  // Check Tools //

  // Output Frequency Control //
 
  m_eventCounter++;
  if ( m_eventCounter > 1 && m_eventCounter % m_outputFrequency != 0 )
    {
      return StatusCode::SUCCESS;
    }

  // XML Files //
 
  // run info
  //  if ( m_geomWriter > 0 && thisRun != m_oldRun )
  //    {
  //      m_oldRun = thisRun;
  //      this->writeRunInfo();
  //    }
 
  // construct directory and file name
  std::ostringstream thisFileName;
  thisFileName << m_topDirectory << "/evnt." 
           << std::setw(6)   << std::setfill('0')
           << ctx.eventID().run_number()    << "." << std::setfill('0')
           << std::setw(6)
           << ctx.eventID().event_number()  << ".xml" << std::ends;
 
  std::ofstream thisFileStream((thisFileName.str()).c_str());

  // Loop Tools //
 
  for (TBXMLWriterToolBase* tool : m_writerTools)
    {
      StatusCode checkOut = tool->writeOut(thisFileStream);
      m_toolInvoke[tool->name()]++;
      if ( checkOut.isFailure() )
    {
      m_toolReject[tool->name()]++;
    }
      else
    {
      m_toolAccept[tool->name()]++;
    }
    }
 
  // finalize the stream
  ATH_CHECK((*(m_writerTools.begin()))->finalize(thisFileStream));
  thisFileStream.close();
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

finalize()

StatusCode TBXMLWriter::finalize ( )

overridevirtual

Definition at line 163 of file TBXMLWriter.cxx.

{
  return StatusCode::SUCCESS;
}

getFileDir()

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

inline

Definition at line 44 of file TBXMLWriter.h.

{ return m_topDirectory; }

initialize()

StatusCode TBXMLWriter::initialize ( )

overridevirtual

Definition at line 40 of file TBXMLWriter.cxx.

{
  // loop all writers
  for (const std::string& toolName : m_writerToolNames)
    {
      IAlgTool* algToolPtr;
      Gaudi::Utils::TypeNameString writerAlgoTool(toolName);
 
      // pick up tool
      StatusCode checkOut = toolSvc()->retrieveTool(writerAlgoTool.type(),
                                                    writerAlgoTool.name(),
                                                    algToolPtr,
                                                    this);
      // not found
      if ( checkOut.isFailure() )
    {
      ATH_MSG_ERROR
            ( "failed to pick up tool of type \042"
          << writerAlgoTool.type()
          << "\042 with name <"
          << writerAlgoTool.name()
          << ">"
          );
      return StatusCode::FAILURE;
    }
 
      // store pointer to tool if right type 
      TBXMLWriterToolBase* thisTool = 
    dynamic_cast< TBXMLWriterToolBase* >(algToolPtr);
      if ( thisTool != 0 )
    {
      m_writerTools.push_back(thisTool);
    }
 
    }
 
  // check tools
  if ( m_writerTools.size() == 0 )
    {
      ATH_MSG_ERROR ( "no tools found!" );
      return StatusCode::FAILURE;
    }
 
  for (TBXMLWriterToolBase* tool : m_writerTools)
    {
      // reset statistics
      m_toolInvoke[tool->name()] = 0;
      m_toolReject[tool->name()] = 0;
      m_toolAccept[tool->name()] = 0;
    }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

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< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< 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< 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 79 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< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< 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:

• TBXMLWriter.h
• TBXMLWriter.cxx