HepMcWriterTool Class Reference

#include <HepMcWriterTool.h>

Inheritance diagram for HepMcWriterTool:

Collaboration diagram for HepMcWriterTool:

Public Member Functions
	HepMcWriterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~HepMcWriterTool ()
	Destructor:
StatusCode	initialize ()
	Athena Algorithm's Hooks.
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	write (const HepMC::GenEvent *evt)
	Process the HepMC::GenEvent through the I/O backend.

Protected Member Functions
	HepMcWriterTool ()
	Default constructor:
void	setupBackend (Gaudi::Details::PropertyBase &ioBackendURL)
	Method to configure the back-end to write out the HepMC::GenEvent.

Protected Attributes
StringProperty	m_ioBackendURL
	URL of the I/O back-end (only "ASCII" for now...) glued with the name of the output file name.
StringProperty	m_mcEventsName
	Location of the McEventCollection to be written out If there is more than 1 HepMC::GenEvent in the McEventCollection we will send warning messages, and just write the first one.
std::shared_ptr< HepMC3::Writer >	m_ioBackend {nullptr}
	Abstract base class for the back-end.

Detailed Description

Definition at line 25 of file HepMcWriterTool.h.

Constructor & Destructor Documentation

HepMcWriterTool() [1/2]

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

Constructor with parameters:

Constructors.

Definition at line 27 of file HepMcWriterTool.cxx.

                                                                                                            : 
  base_class( type, name, parent ),
  m_ioBackend( nullptr )
{
  //
  // Property declaration
  // 
 
  declareProperty( "Output",  m_ioBackendURL = "ascii:hepmc.genevent.txt", "Name of the back-end we'll use to write out the HepMC::GenEvent.\nEx: ascii:hepmc.genevent.txt" );
  m_ioBackendURL.declareUpdateHandler( &HepMcWriterTool::setupBackend, this );
  declareProperty( "McEvents", m_mcEventsName = "GEN_EVENT", "Input location of the McEventCollection to write out" );
}

~HepMcWriterTool()

HepMcWriterTool::~HepMcWriterTool ( )

virtual

Destructor:

Destructor.

Definition at line 42 of file HepMcWriterTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
}

HepMcWriterTool() [2/2]

HepMcWriterTool::HepMcWriterTool ( )

protected

Default constructor:

Member Function Documentation

execute()

StatusCode HepMcWriterTool::execute

(

)

Definition at line 73 of file HepMcWriterTool.cxx.

{
  // retrieve the McEventCollection
  const McEventCollection * mcEvts = nullptr;
  if ( evtStore()->retrieve( mcEvts, m_mcEventsName ).isFailure() || nullptr == mcEvts ) {
    ATH_MSG_ERROR("Could not retrieve a McEventCollection at ["  << m_mcEventsName << "] !!");
    return StatusCode::FAILURE;
  }
 
  if ( mcEvts->empty() ) {
    ATH_MSG_WARNING("McEventCollection at ["<<m_mcEventsName<<"] is EMPTY !!");
    return StatusCode::FAILURE;
  }
 
  const HepMC::GenEvent * evt = mcEvts->front();
  if ( !evt ) {
    ATH_MSG_ERROR("Retrieved NULL pointer to HepMC::GenEvent !!");
    return StatusCode::FAILURE;
  }
 
  return write(evt);
}

finalize()

StatusCode HepMcWriterTool::finalize

(

)

Definition at line 67 of file HepMcWriterTool.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode HepMcWriterTool::initialize

(

)

Athena Algorithm's Hooks.

Definition at line 49 of file HepMcWriterTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  // Get pointer to StoreGateSvc and cache it :
  if ( !evtStore().retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Unable to retrieve pointer to StoreGateSvc");
    return StatusCode::FAILURE;
  }
 
  // setup backend
  if (!m_ioBackend ) {
    setupBackend(m_ioBackendURL);
  }
 
  return StatusCode::SUCCESS;
}

setupBackend()

void HepMcWriterTool::setupBackend ( Gaudi::Details::PropertyBase & ioBackendURL )

protected

Method to configure the back-end to write out the HepMC::GenEvent.

Definition at line 106 of file HepMcWriterTool.cxx.

{
  // defaults
  std::string protocol = "asciiv3";
  std::string fileName = "hepmc.genevent.txt";
 
  // reset internal state
  m_ioBackend = nullptr;
 
  // caching URL
  const std::string& url = m_ioBackendURL.value();
  
  std::string::size_type protocolPos = url.find(s_protocolSep);
 
  if ( std::string::npos != protocolPos ) {
    protocol = url.substr( 0, protocolPos );
    fileName = url.substr( protocolPos + 1, std::string::npos );
  } else {
    fileName = url;
  }
 
  // get the protocol name in lower cases
  std::transform( protocol.begin(), protocol.end(), protocol.begin(), [](unsigned char c){ return std::tolower(c); } );
  if ( "ascii" == protocol ) {
    m_ioBackend = std::make_shared<HepMC3::WriterAsciiHepMC2>( fileName.c_str());
  } else  if ( "asciiv3" == protocol ) {
    m_ioBackend = std::make_shared<HepMC3::WriterAscii>( fileName.c_str());
  } else {
    ATH_MSG_WARNING("UNKNOWN protocol [" << protocol << "] !!" << endmsg  << "Will use [ascii] instead...");
    protocol = "asciiv3";
    m_ioBackend = std::make_shared<HepMC3::WriterAscii>( fileName.c_str());
  }    
  ATH_MSG_DEBUG("Using protocol [" << protocol << "] and write to ["<< fileName << "]");
}

write()

StatusCode HepMcWriterTool::write

(

const HepMC::GenEvent *

evt

)

Process the HepMC::GenEvent through the I/O backend.

Non-const methods:

Definition at line 100 of file HepMcWriterTool.cxx.

{
  m_ioBackend->write_event(*evt);
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_ioBackend

std::shared_ptr<HepMC3::Writer> HepMcWriterTool::m_ioBackend {nullptr}

protected

Abstract base class for the back-end.

Definition at line 73 of file HepMcWriterTool.h.

{nullptr};

m_ioBackendURL

StringProperty HepMcWriterTool::m_ioBackendURL

protected

URL of the I/O back-end (only "ASCII" for now...) glued with the name of the output file name.

Ex: "ascii:/home/foo/hepmc.txt" If no protocol separator ':' is found, fallback is "ASCII"

Definition at line 63 of file HepMcWriterTool.h.

m_mcEventsName

StringProperty HepMcWriterTool::m_mcEventsName

protected

Location of the McEventCollection to be written out If there is more than 1 HepMC::GenEvent in the McEventCollection we will send warning messages, and just write the first one.

Definition at line 69 of file HepMcWriterTool.h.

---

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

• HepMcWriterTool.h
• HepMcWriterTool.cxx