base class for XML writer tools for 2004 event display More...

#include <TBXMLWriterToolBase.h>

Inheritance diagram for TBXMLWriterToolBase:

Collaboration diagram for TBXMLWriterToolBase:

Public Member Functions
virtual	~TBXMLWriterToolBase ()
virtual StatusCode	initialize () override
virtual StatusCode	writeOut (std::ostream &outStream, std::string_view entryTag=" ")
virtual StatusCode	finalize () override
virtual StatusCode	finalize (std::ostream &outStream)
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
	TBXMLWriterToolBase (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	writeRunFiles (const std::string &fileDir, unsigned int runNumber)=0
virtual StatusCode	writeEvent (std::ostream &theFile, std::string_view entryTag)=0
virtual void	openDictionary (std::ostream &outStream, const std::string &dictName, const std::vector< std::string > &listOfElements)
virtual void	openDictionary (std::ostream &outStream, const std::string &dictName)
virtual void	closeDictionary (std::ostream &outStream)
virtual void	addDictElement (std::ostream &outStream, const std::string &theElement, const std::vector< std::string > &listOfElements)
virtual void	addAttributes (std::ostream &outStream, const std::string &theElement, const std::vector< std::string > &listOfAttributes)
virtual void	openElement (std::ostream &outStream, std::string_view theElement, const std::vector< std::string > &listOfAttr, const std::vector< std::string > &listOfValues)
virtual void	closeElement (std::ostream &outStream, const std::string &theElement)
virtual void	closeElement (std::ostream &outStream)
virtual void	closeAllElements (std::ostream &outStream)
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.

Protected Attributes
std::vector< std::string >	m_elementList
std::string	m_dictionary

Static Protected Attributes
static const std::string	m_doubleQuote = "\042"

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

base class for XML writer tools for 2004 event display

Definition at line 17 of file TBXMLWriterToolBase.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TBXMLWriterToolBase()

TBXMLWriterToolBase::TBXMLWriterToolBase	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

inlineprotected

Definition at line 25 of file TBXMLWriterToolBase.h.

27 : AthAlgTool( type, name, parent )

28 { }

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

◆ ~TBXMLWriterToolBase()

virtual TBXMLWriterToolBase::~TBXMLWriterToolBase ( )

inlinevirtual

Definition at line 32 of file TBXMLWriterToolBase.h.

33 { }

Member Function Documentation

◆ addAttributes()

void TBXMLWriterToolBase::addAttributes	(	std::ostream &	outStream,
		const std::string &	theElement,
		const std::vector< std::string > &	listOfAttributes )

protectedvirtual

Definition at line 91 of file TBXMLWriterToolBase.cxx.

{
  outStream << "  <!ATTLIST " << theElement << std::endl;
  for ( unsigned int i=0; i<listOfAttr.size(); i++ )
    {
      outStream << "            " << listOfAttr[i] << std::endl;
    }
  outStream << ">" << std::endl;
}

◆ addDictElement()

void TBXMLWriterToolBase::addDictElement	(	std::ostream &	outStream,
		const std::string &	theElement,
		const std::vector< std::string > &	listOfElements )

protectedvirtual

Definition at line 57 of file TBXMLWriterToolBase.cxx.

{
  outStream << "<!ELEMENT " << theElement;
  // add document as element
  if ( listOfElements.size() == 0 )
    {
      outStream << ">" << std::endl;
    }
  else
    {
      // store elements
      if ( listOfElements[0] == "ANY"   ||
       listOfElements[0] == "EMPTY" ||
       listOfElements[0] == "ALL" )
    {
      outStream << " " << listOfElements[0] << " >" << std::endl;
    }
      else
    {
      outStream << " (" << listOfElements[0];
      for ( unsigned int i=1; i<listOfElements.size(); i++ )
        {
          outStream << "," << listOfElements[i];
        }
      outStream << ") >" << std::endl;
    }
    }
}

◆ closeAllElements()

void TBXMLWriterToolBase::closeAllElements ( std::ostream & outStream )

protectedvirtual

Definition at line 159 of file TBXMLWriterToolBase.cxx.

{
  for ( int i=m_elementList.size()-1; i>=0; i-- ) 
    {
      outStream << "</" << m_elementList[i] << ">" << std::endl;
    }
  m_elementList.clear();
}

◆ closeDictionary()

void TBXMLWriterToolBase::closeDictionary ( std::ostream & outStream )

protectedvirtual

Definition at line 50 of file TBXMLWriterToolBase.cxx.

{
  outStream << "]>" << std::endl;
}

◆ closeElement() [1/2]

void TBXMLWriterToolBase::closeElement ( std::ostream & outStream )

protectedvirtual

Definition at line 130 of file TBXMLWriterToolBase.cxx.

{
  unsigned int thisSize = m_elementList.size() - 1;
  outStream << "</" << m_elementList[thisSize] << ">" << std::endl;
  m_elementList.resize(thisSize);
}

◆ closeElement() [2/2]

void TBXMLWriterToolBase::closeElement	(	std::ostream &	outStream,
		const std::string &	theElement )

protectedvirtual

Definition at line 139 of file TBXMLWriterToolBase.cxx.

{
  std::vector<std::string>::iterator inVec = 
    find( m_elementList.begin(), m_elementList.end(), theElement);
  if ( inVec != m_elementList.end() )
    {
      outStream << "</" << (*inVec) << ">" << std::endl;
      m_elementList.erase(inVec);
    }
  else
    {
      outStream << "<!-- XML Structural Problem! \n\n"
        << "     cannot find an element " << theElement << "!\n\n"
        << "-->" << std::endl;
    }
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ finalize() [1/2]

virtual StatusCode TBXMLWriterToolBase::finalize ( )

inlineoverridevirtual

Definition at line 52 of file TBXMLWriterToolBase.h.

    { 
      return StatusCode::SUCCESS;
    }

◆ finalize() [2/2]

virtual StatusCode TBXMLWriterToolBase::finalize ( std::ostream & outStream )

inlinevirtual

Definition at line 57 of file TBXMLWriterToolBase.h.

   {
     this->closeAllElements(outStream);
     return this->finalize();
   }

◆ initialize()

virtual StatusCode TBXMLWriterToolBase::initialize ( )

inlineoverridevirtual

Reimplemented in TBXMLCaloCellWriterTool.

Definition at line 36 of file TBXMLWriterToolBase.h.

    {
      return StatusCode::SUCCESS;
    }

◆ inputHandles()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ openDictionary() [1/2]

void TBXMLWriterToolBase::openDictionary	(	std::ostream &	outStream,
		const std::string &	dictName )

protectedvirtual

Definition at line 41 of file TBXMLWriterToolBase.cxx.

{
  std::vector<std::string> emptyList;
  this->openDictionary(outStream,dictName, emptyList);
}

◆ openDictionary() [2/2]

void TBXMLWriterToolBase::openDictionary	(	std::ostream &	outStream,
		const std::string &	dictName,
		const std::vector< std::string > &	listOfElements )

protectedvirtual

Definition at line 18 of file TBXMLWriterToolBase.cxx.

{
  // clean up
  m_elementList.clear();
  m_dictionary = dictName;
 
  // write header
  outStream << "<?XML version=" << m_doubleQuote
        << "1" << m_doubleQuote << "?>" << std::endl;
  
  // write begin of dictionary
  outStream << "<!DOCTYPE " << dictName
        << " [" << std::endl;
 
  // add doctype as element
  this->addDictElement(outStream,dictName,listOfElements);
}      

◆ openElement()

void TBXMLWriterToolBase::openElement	(	std::ostream &	outStream,
		std::string_view	theElement,
		const std::vector< std::string > &	listOfAttr,
		const std::vector< std::string > &	listOfValues )

protectedvirtual

Definition at line 106 of file TBXMLWriterToolBase.cxx.

{
  m_elementList.emplace_back(theElement);
  outStream << "<" << theElement;
  if ( listOfAttr.size() > 0 && listOfValues.size() == listOfAttr.size() )
    {
      for ( unsigned int i=0; i<listOfAttr.size(); i++ )
    {
      outStream << " " << listOfAttr[i] << "="
            << m_doubleQuote 
            << listOfValues[i]
            << m_doubleQuote;
    }
    }
  outStream << ">" << std::endl;
}

◆ outputHandles()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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);
      }
    }
  }

◆ writeEvent()

virtual StatusCode TBXMLWriterToolBase::writeEvent	(	std::ostream &	theFile,
		std::string_view	entryTag )

protectedpure virtual

Implemented in TBXMLCaloCellWriterTool, and TBXMLEventWriterTool.

◆ writeOut()

virtual StatusCode TBXMLWriterToolBase::writeOut	(	std::ostream &	outStream,
		std::string_view	entryTag = " " )

inlinevirtual

Definition at line 46 of file TBXMLWriterToolBase.h.

    {
      return this->writeEvent(outStream,entryTag);
    }

◆ writeRunFiles()

virtual StatusCode TBXMLWriterToolBase::writeRunFiles	(	const std::string &	fileDir,
		unsigned int	runNumber )

protectedpure virtual

Implemented in TBXMLCaloCellWriterTool, and TBXMLEventWriterTool.

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_dictionary

std::string TBXMLWriterToolBase::m_dictionary

protected

Definition at line 108 of file TBXMLWriterToolBase.h.

◆ m_doubleQuote

const std::string TBXMLWriterToolBase::m_doubleQuote = "\042"

staticprotected

Definition at line 110 of file TBXMLWriterToolBase.h.

◆ m_elementList

std::vector<std::string> TBXMLWriterToolBase::m_elementList

protected

Definition at line 107 of file TBXMLWriterToolBase.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TBXMLWriterToolBase()

◆ ~TBXMLWriterToolBase()

Member Function Documentation

◆ addAttributes()

◆ addDictElement()

◆ closeAllElements()

◆ closeDictionary()

◆ closeElement() [1/2]

◆ closeElement() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize() [1/2]

◆ finalize() [2/2]

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ openDictionary() [1/2]

◆ openDictionary() [2/2]

◆ openElement()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ writeEvent()

◆ writeOut()

◆ writeRunFiles()

Member Data Documentation

◆ m_detStore

◆ m_dictionary

◆ m_doubleQuote

◆ m_elementList

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka