Stream JiveXML event information into a file. More...

#include <StreamToFileTool.h>

Inheritance diagram for JiveXML::StreamToFileTool:

Collaboration diagram for JiveXML::StreamToFileTool:

Public Member Functions
	StreamToFileTool (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual StatusCode	initialize ()
	Initialize.
virtual StatusCode	finalize ()
	Finalize.
virtual StatusCode	StreamEvent (const unsigned long EventNumber, const unsigned int RunNumber, const std::ostringstream *EventBuffer)
	Stream one event.
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
std::string	MakeFileName (const unsigned long EventNumber, const unsigned int RunNumber) const
	Generate a file name.
StatusCode	NewFile (const unsigned long EventNumber, const unsigned int RunNumber, std::ofstream *&outFile) const
	Creates a new output stream to write XML to.
StatusCode	CloseFile (std::ofstream *&outFile) const
	Closes output stream.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< IOnlineEventDisplaysSvc >	m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}
Gaudi::Property< bool >	m_isOnline {this, "IsOnline", false, "If running at point 1"}
std::string	m_FileNamePrefix
	Prefix put in front of JiveXML file name.
std::string	m_FileNameSuffix
	Suffix put at the end of the file name (including type)
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

Stream JiveXML event information into a file.

Currently only one file per event is supported, this will hopefully be changed soon.

Author: Sebastian Boeser

Definition at line 22 of file StreamToFileTool.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

◆ StreamToFileTool()

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

Constructor.

setup message service
initialize properties

The file name prefix

The file name suffix

Definition at line 17 of file StreamToFileTool.cxx.

                                                                                                       :
    AthAlgTool(type,name,p){
 
    //Provide interface
    declareInterface<IStreamTool>(this);
    declareProperty("FileNamePrefix", m_FileNamePrefix = "JiveXML");
    declareProperty("FileNameSuffix", m_FileNameSuffix = ".xml");
 
  }

Member Function Documentation

◆ CloseFile()

StatusCode JiveXML::StreamToFileTool::CloseFile ( std::ofstream *& outFile ) const

private

Closes output stream.

Close the file.

Definition at line 124 of file StreamToFileTool.cxx.

                                                                           {
 
    //Try to close the file
    outputFile->close();
 
    //See if it worked
    if (!outputFile->good()){
      ATH_MSG_WARNING("Unable to close file");
    }
 
    //In any case delete object
    delete outputFile;
 
    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

◆ 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::StreamToFileTool::finalize ( )

virtual

Finalize.

Finalize - called once at the end.

Implements JiveXML::IStreamTool.

Definition at line 46 of file StreamToFileTool.cxx.

                                       {
    return StatusCode::SUCCESS;
  }

◆ initialize()

StatusCode JiveXML::StreamToFileTool::initialize ( )

virtual

Initialize.

Intialize - called once at the beginning.

Implements JiveXML::IStreamTool.

Definition at line 33 of file StreamToFileTool.cxx.

                                         {
    if(m_isOnline){
      if(m_onlineEDsvc.retrieve().isFailure()){
        ATH_MSG_ERROR("Could not locate the online event displays service");
        return StatusCode::FAILURE;
      }
    }
    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::IStreamTool::interfaceID ( )

inlinestaticinherited

The interface identifier.

Definition at line 39 of file IStreamTool.h.

  { 
          return IID_IStreamTool; 
  }

◆ MakeFileName()

std::string JiveXML::StreamToFileTool::MakeFileName	(	const unsigned long	EventNumber,
		const unsigned int	RunNumber ) const

private

Generate a file name.

Generate a file name from the run and event number.

Parameters

EventNumber	the event number
RunNumber	the run number

Definition at line 88 of file StreamToFileTool.cxx.

                                                                                                               {
 
     //Generate a the return string with file prefix
     std::ostringstream name;
 
     //Assemble file name
     name << m_FileNamePrefix << std::setfill('0');
     name << "_" << std::setw(5) << RunNumber;
     name << "_" << std::setw(5) << EventNumber;
     name << m_FileNameSuffix;
     return name.str();
   }

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

◆ NewFile()

StatusCode JiveXML::StreamToFileTool::NewFile	(	const unsigned long	EventNumber,
		const unsigned int	RunNumber,
		std::ofstream *&	outFile ) const

private

Creates a new output stream to write XML to.

Open a new file.

Definition at line 104 of file StreamToFileTool.cxx.

                                                                                                                                       {
 
      // Generate the file name
      std::string filename = MakeFileName(EventNumber,RunNumber);
 
      // create a new output stream
      outputFile = new std::ofstream(filename.c_str());
      ATH_MSG_DEBUG("outputFile "<< filename);
      // check if it worked
      if ( !(outputFile->good()) ){
        ATH_MSG_WARNING("Unable to create output file with name " << filename);
        return StatusCode::FAILURE;
      }
 
      return StatusCode::SUCCESS;
    }

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

◆ StreamEvent()

StatusCode JiveXML::StreamToFileTool::StreamEvent	(	const unsigned long	EventNumber,
		const unsigned int	RunNumber,
		const std::ostringstream *	EventBuffer )

virtual

Stream one event.

Stream one event into a file.

Parameters

EventNumber	the event number
RunNumber	the run number
EventBuffer	the string holding the complete event

Get a pointer to a new file

Stream this event into the file

Check wether we could write the event

Finally close the file

Implements JiveXML::IStreamTool.

Definition at line 56 of file StreamToFileTool.cxx.

                                                                                                                                                {
     if(m_isOnline){
       m_FileNamePrefix = m_onlineEDsvc->getFileNamePrefix();
       ATH_MSG_DEBUG("m_FileNamePrefix: " << m_FileNamePrefix << " EventNumber: " << EventNumber);
     }
     std::ofstream* outFile;
     StatusCode sc = NewFile(EventNumber,RunNumber,outFile);
     if (sc.isFailure()){
       ATH_MSG_WARNING("Could not open file for event " << EventNumber << " from run " << RunNumber);
       return sc;
     }
     (*outFile) << EventBuffer->str();
     outFile->flush();
     if (!outFile->good()){
       ATH_MSG_WARNING("Could not open file for event " << EventNumber << " from run " << RunNumber);
       return StatusCode::FAILURE;
     }
     sc = CloseFile(outFile);
     return sc;
 
   }

◆ 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_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_FileNamePrefix

std::string JiveXML::StreamToFileTool::m_FileNamePrefix

private

Prefix put in front of JiveXML file name.

Definition at line 45 of file StreamToFileTool.h.

◆ m_FileNameSuffix

std::string JiveXML::StreamToFileTool::m_FileNameSuffix

private

Suffix put at the end of the file name (including type)

Definition at line 48 of file StreamToFileTool.h.

◆ m_isOnline

Gaudi::Property<bool> JiveXML::StreamToFileTool::m_isOnline {this, "IsOnline", false, "If running at point 1"}

private

Definition at line 42 of file StreamToFileTool.h.

42{this, "IsOnline", false, "If running at point 1"};

◆ m_onlineEDsvc

ServiceHandle<IOnlineEventDisplaysSvc> JiveXML::StreamToFileTool::m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}

private

Definition at line 40 of file StreamToFileTool.h.

40{this, "OnlineEventDisplaysSvc", "Online Event Displays Service"};

◆ 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

◆ StreamToFileTool()

Member Function Documentation

◆ CloseFile()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ MakeFileName()

◆ msg()

◆ msgLvl()

◆ NewFile()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ StreamEvent()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_FileNamePrefix

◆ m_FileNameSuffix

◆ m_isOnline

◆ m_onlineEDsvc

◆ m_varHandleArraysDeclared

◆ m_vhka