HepMcReaderTool Class Reference

#include <HepMcReaderTool.h>

Inheritance diagram for HepMcReaderTool:

Collaboration diagram for HepMcReaderTool:

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

Protected Member Functions
	HepMcReaderTool ()
	Default constructor:
void	setupFrontend (Gaudi::Details::PropertyBase &ioFrontendURL)
	Method to configure the front-end to read out the HepMC::GenEvent.

Protected Attributes
StringProperty	m_ioFrontendURL
	URL of the I/O front-end (only "ASCII" for now...) glued with the name of the input file name.
StringProperty	m_mcEventsOutputName
	Location of the McEventCollection to be read out.
std::shared_ptr< HepMC3::Reader >	m_ioFrontend {nullptr}
	Abstract base class for the back-end.

Detailed Description

Definition at line 27 of file HepMcReaderTool.h.

Constructor & Destructor Documentation

HepMcReaderTool() [1/2]

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

Constructor with parameters:

Constructors.

Definition at line 29 of file HepMcReaderTool.cxx.

                                                                                                         : 
  base_class( type, name, parent )
{
  //
  // Property declaration
  // 
 
  declareProperty( "Input", m_ioFrontendURL = "auto:hepmc.genevent.txt", "Name of the front-end we'll use to read in the HepMC::GenEvent.\nEx: ascii:hepmc.genevent.txt" );
  m_ioFrontendURL.declareUpdateHandler( &HepMcReaderTool::setupFrontend, this );
  declareProperty( "McEventsOutput", m_mcEventsOutputName = "GEN_EVENT", "Output location of the McEventCollection to read out" );
}

~HepMcReaderTool()

HepMcReaderTool::~HepMcReaderTool ( )

virtual

Destructor:

Destructor.

Definition at line 43 of file HepMcReaderTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
}

HepMcReaderTool() [2/2]

HepMcReaderTool::HepMcReaderTool ( )

protected

Default constructor:

Member Function Documentation

execute()

StatusCode HepMcReaderTool::execute

(

)

Definition at line 73 of file HepMcReaderTool.cxx.

{
  // create a new McEventCollection and put it into StoreGate
  McEventCollection * mcEvts = new McEventCollection;
  if ( evtStore()->record( mcEvts, m_mcEventsOutputName ).isFailure() ) {
    ATH_MSG_ERROR("Could not record a McEventCollection at ["<< m_mcEventsOutputName << "] !!");
    return StatusCode::FAILURE;
  }
  
  if ( evtStore()->setConst( mcEvts ).isFailure() ) {
    ATH_MSG_WARNING("Could not setConst McEventCollection at ["<< m_mcEventsOutputName << "] !!");
  }
 
  HepMC::GenEvent * evt = new HepMC::GenEvent;
  mcEvts->push_back(evt);
 
  return read(evt);
}

finalize()

StatusCode HepMcReaderTool::finalize

(

)

Definition at line 67 of file HepMcReaderTool.cxx.

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

initialize()

StatusCode HepMcReaderTool::initialize

(

)

Athena Algorithm's Hooks.

Definition at line 50 of file HepMcReaderTool.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 frontend
  if ( !m_ioFrontend ) {
    setupFrontend(m_ioFrontendURL);
  }
 
  return StatusCode::SUCCESS;
}

read()

StatusCode HepMcReaderTool::read

(

HepMC::GenEvent *

evt

)

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

Definition at line 92 of file HepMcReaderTool.cxx.

{
  m_ioFrontend->read_event(*evt);
  return StatusCode::SUCCESS;
}

setupFrontend()

void HepMcReaderTool::setupFrontend ( Gaudi::Details::PropertyBase & ioFrontendURL )

protected

Method to configure the front-end to read out the HepMC::GenEvent.

Definition at line 98 of file HepMcReaderTool.cxx.

{
  // defaults
  std::string protocol = "auto";
  std::string fileName = "hepmc.genevent.txt";
 
  // reset internal state
  m_ioFrontend = nullptr;
 
  // caching URL
  const std::string& url = m_ioFrontendURL.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 ( "auto" == protocol ) {
    m_ioFrontend = HepMC3::deduce_reader( fileName.c_str());
  } else if ( "ascii" == protocol ) {
    m_ioFrontend = std::make_shared<HepMC3::ReaderAsciiHepMC2>( fileName.c_str());
  } else {
    msg(MSG::WARNING) << "UNKNOWN protocol [" << protocol << "] !!" << endmsg<< "Will use [ascii] instead..."<< endmsg;
    protocol = "ascii";
    m_ioFrontend = std::make_shared<HepMC3::ReaderAsciiHepMC2>( fileName.c_str());
  }    
  ATH_MSG_DEBUG("Using protocol [" << protocol << "] and write to ["<< fileName << "]");
}

Member Data Documentation

m_ioFrontend

std::shared_ptr<HepMC3::Reader> HepMcReaderTool::m_ioFrontend {nullptr}

protected

Abstract base class for the back-end.

Definition at line 73 of file HepMcReaderTool.h.

{nullptr};

m_ioFrontendURL

StringProperty HepMcReaderTool::m_ioFrontendURL

protected

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

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

Definition at line 65 of file HepMcReaderTool.h.

m_mcEventsOutputName

StringProperty HepMcReaderTool::m_mcEventsOutputName

protected

Location of the McEventCollection to be read out.

Definition at line 69 of file HepMcReaderTool.h.

---

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

• HepMcReaderTool.h
• HepMcReaderTool.cxx