Writes data stored in a DataMap into an XML stream in the format required by the Atlantis event display. More...

#include <XMLFormatTool.h>

Inheritance diagram for JiveXML::XMLFormatTool:

Collaboration diagram for JiveXML::XMLFormatTool:

Public Member Functions
	XMLFormatTool (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual StatusCode	initialize () override
	Initialize.
virtual StatusCode	finalize () override
	Finalize.
virtual StatusCode	SetTag (const TagType tag) override
	Set additional tags.
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) override
	Start a new event.
virtual StatusCode	EndEvent () override
	Finialize this event.
virtual StatusCode	AddToEvent (const std::string &component, const std::string &key, const DataMap *aMap) override
	Append a formatted version of one event component.
virtual const std::ostringstream *	getFormattedEvent () const override
	Return the formated stringstream.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	The interface identifier.

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
std::ostringstream *	m_EventBuffer
	the string buffer that will hold the complete event
std::string	m_release
	the release tag
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

Writes data stored in a DataMap into an XML stream in the format required by the Atlantis event display.

Author: J. Couchman; S. Boeser

Definition at line 21 of file XMLFormatTool.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

◆ XMLFormatTool()

JiveXML::XMLFormatTool::XMLFormatTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	p )

Constructor.

setup message service

Definition at line 13 of file XMLFormatTool.cxx.

                                                                                                 :
    AthAlgTool(type,name,p){
    
    //Provide interface
    declareInterface<IFormatTool>(this);
 
    //Intialize data members
    m_EventBuffer = 0;
  }

Member Function Documentation

◆ AddToEvent()

StatusCode JiveXML::XMLFormatTool::AddToEvent	(	const std::string &	component,
		const std::string &	key,
		const DataMap *	aMap )

overridevirtual

Append a formatted version of one event component.

Add data from a certain component with a certain key to the event.

Parameters

component	the component for which we write data
key	the name of the data field we write
aMap	the data that shall be written

Write a closing tag

Implements JiveXML::IFormatTool.

Definition at line 112 of file XMLFormatTool.cxx.

                                                             {
    
    DataMap::const_iterator itr;
 
    //check to see if any data is contained in the map before any formatting takes place
    bool map_is_empty = true;
    for(itr=aMap->begin(); itr!=aMap->end(); ++itr) {
      if (itr->second.size()) {
        map_is_empty = false;
        break;
      }
    }
 
    //return in case of empty map
    if(map_is_empty)  return StatusCode::SUCCESS;
 
    //Open a new tag
    (*m_EventBuffer) << "<" << component ;
 
    //Write number of entries taken from first non-multiple collection
    for (itr=aMap->begin(); itr!=aMap->end(); ++itr) {
      if ((itr->first.find("multiple"))==std::string::npos) {
        //Write out multiplicty and key
        (*m_EventBuffer) <<" count=\""<< itr->second.size()<< "\""
                       <<" storeGateKey=\""<< key<< "\"";
        break ;
      }
    }
 
    //Close the opening tag
    (*m_EventBuffer) << ">" << std::endl << std::endl;
 
    //Now start writing event information
    for(itr=aMap->begin(); itr!=aMap->end() ;++itr) {
 
      // Write first key from map
      (*m_EventBuffer) << "<" << (*itr).first <<">\n";
      
      // Write the elements in groups of 10 per line
      int ii=0;
      for (DataVect::const_iterator itr2 = (*itr).second.begin(); itr2!=(*itr).second.end(); ++itr2){
         ++ii;
         (*m_EventBuffer) << (*itr2);
         if ((*itr).first == "identifier"){
           (*m_EventBuffer) <<"\n";
         }
         else if(ii>=10){
           (*m_EventBuffer) <<"\n";
           ii=0;
         } else {
           (*m_EventBuffer) << " ";
         }
       }
 
       // I don't understand this bit
       int i = (*itr).first.find(' ');
       if (i != int(std::string::npos))
         (*m_EventBuffer) << "\n</" << (*itr).first.substr(0,i) <<">\n";
       else
         (*m_EventBuffer) << "\n</" << (*itr).first <<">\n";
    }
      
    (*m_EventBuffer) << "</" << component << ">\n\n";
 
    return StatusCode::SUCCESS;
  }

◆ 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

◆ EndEvent()

StatusCode JiveXML::XMLFormatTool::EndEvent ( )

overridevirtual

Finialize this event.

Print event footer.

Implements JiveXML::IFormatTool.

Definition at line 97 of file XMLFormatTool.cxx.

                                    {
 
    //Print event close tag
    (*m_EventBuffer) << "</Event>\n";
 
    return StatusCode::SUCCESS;
  }

◆ 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()

StatusCode JiveXML::XMLFormatTool::finalize ( )

overridevirtual

Finalize.

Finalize - called once at the end.

Implements JiveXML::IFormatTool.

Definition at line 34 of file XMLFormatTool.cxx.

                                    {
    
    //Clear the event buffer if it exists
    if (m_EventBuffer) delete m_EventBuffer;
    return StatusCode::SUCCESS;
  }

◆ getFormattedEvent()

const std::ostringstream * JiveXML::XMLFormatTool::getFormattedEvent ( ) const

overridevirtual

Return the formated stringstream.

Return the formatted event.

Implements JiveXML::IFormatTool.

Definition at line 183 of file XMLFormatTool.cxx.

                                                                 {
    return m_EventBuffer;
  }

◆ initialize()

StatusCode JiveXML::XMLFormatTool::initialize ( )

overridevirtual

Initialize.

Intialize - called once at the beginning.

Implements JiveXML::IFormatTool.

Definition at line 26 of file XMLFormatTool.cxx.

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

◆ interfaceID()

const InterfaceID & JiveXML::IFormatTool::interfaceID ( )

inlinestaticinherited

The interface identifier.

Definition at line 56 of file IFormatTool.h.

  { 
          return IID_IFormatTool; 
  }

◆ 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);
  }

◆ 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();
  }

◆ SetTag()

StatusCode JiveXML::XMLFormatTool::SetTag ( const TagType tag )

overridevirtual

Set additional tags.

Set the release tag.

Parameters

tag	the name of the release

Implements JiveXML::IFormatTool.

Definition at line 45 of file XMLFormatTool.cxx.

                                                      {
 
    //Store this as release string
    m_release = tag.second;
    //Format properly
    std::replace(m_release.begin(), m_release.end(), '/', '_');
    return StatusCode::SUCCESS; 
  }

◆ StartEvent()

StatusCode JiveXML::XMLFormatTool::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 )

overridevirtual

Start a new event.

Print the event header information.

Parameters

EventNumber	the event number
RunNumber	the run number
dataTime	a date and time string

Implements JiveXML::IFormatTool.

Definition at line 60 of file XMLFormatTool.cxx.

                                                                           {
 
    
    //Recreate the event buffer if it does not exists
    if (!m_EventBuffer)
      m_EventBuffer = new std::ostringstream();
 
    //Clear the event buffer
    m_EventBuffer->str("");
 
    //Print general XML header information
    (*m_EventBuffer) << "<?xml version=\"1.0\"?>" << std::endl
                     << "<?xml-stylesheet type=\"text/xsl\" href=\"JiveXML_event.xsl\"?>" << std::endl
                     << "<?ATLAS Release: \"" << m_release << "\"?>" << std::endl
                     << "<!DOCTYPE Event SYSTEM \"event.dtd\">"
                     << std::endl << std::endl << std::endl;
 
    //Print event open tag
    (*m_EventBuffer) << "<Event version=\"" << m_release << "\""
                     << " runNumber=\""   << RunNumber << "\""
                     << " eventNumber=\"" << EventNumber << "\""
                     << " lumiBlock=\""   << lumiBlock << "\""
                     << " dateTime=\"" << dateTime << "\""
                     << " geometryVersion=\""   << geometryVersion << "\""
                     << " eventProperty=\"" << eventProperty << "\""
                     << ">" << std::endl << std::endl << std::endl;
 
    return StatusCode::SUCCESS;
  }

◆ 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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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);
      }
    }
  }

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_EventBuffer

std::ostringstream* JiveXML::XMLFormatTool::m_EventBuffer

private

the string buffer that will hold the complete event

Definition at line 59 of file XMLFormatTool.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_release

std::string JiveXML::XMLFormatTool::m_release

private

the release tag

Definition at line 62 of file XMLFormatTool.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ XMLFormatTool()

Member Function Documentation

◆ AddToEvent()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ EndEvent()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getFormattedEvent()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ SetTag()

◆ StartEvent()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_EventBuffer

◆ m_evtStore

◆ m_release

◆ m_varHandleArraysDeclared

◆ m_vhka