EPIC::WriterHepMC3 Class Reference

Event writer based on HepMC3. More...

#include <WriterHepMC3.h>

Inheritance diagram for EPIC::WriterHepMC3:

Public Member Functions
	WriterHepMC3 (const std::string &className)
	WriterHepMC3 (const WriterHepMC3 &other)
virtual	~WriterHepMC3 ()
virtual WriterHepMC3 *	clone () const
virtual void	configure (const ElemUtils::Parameters &parameters)
virtual void	open ()
virtual void	saveGenerationInformation (const GenerationInformation &generationInformation)
virtual void	close ()
virtual void	write (const Event &event)
virtual void	write (const std::vector< Event > &events)
WriterHepMC3Type::Type	getWriterHepMC3Type () const
void	setWriterHepMC3Type (WriterHepMC3Type::Type writerHepMc3Type)
Public Member Functions inherited from EPIC::WriterModule
	WriterModule (const std::string &className)
	WriterModule (const WriterModule &other)
virtual	~WriterModule ()
virtual void	configure (const ElemUtils::Parameters &parameters)
virtual bool	runTest () const
virtual void	open ()=0
virtual void	saveGenerationInformation (const GenerationInformation &generationInformation)=0
virtual void	close ()=0
virtual void	write (const Event &event)=0
virtual void	write (const std::vector< Event > &events)=0
const std::string &	getPath () const
void	setPath (const std::string &path)
Public Member Functions inherited from EPIC::EpicModuleObject
virtual	~EpicModuleObject ()
virtual bool	runTest () const =0
size_t	getSeed () const

Static Public Attributes
static const std::string	PARAMETER_NAME_HEPMC3_WRITER_TYPE
static const unsigned int	classId
	WriterHepMC3::configure(). More...
Static Public Attributes inherited from EPIC::WriterModule
static const std::string	WRITER_MODULE_CLASS_NAME
	Class name used in parsing XML.
static const std::string	PARAMETER_NAME_PATH

Additional Inherited Members
Protected Member Functions inherited from EPIC::WriterModule
virtual void	initModule ()
virtual void	isModuleWellConfigured ()
Protected Member Functions inherited from EPIC::EpicModuleObject
	EpicModuleObject (const std::string &className, PARTONS::ChannelType::Type channelType)
	EpicModuleObject (const EpicModuleObject &other)
Protected Attributes inherited from EPIC::WriterModule
std::string	m_path
	Path to output file.
Protected Attributes inherited from EPIC::EpicModuleObject
size_t	m_seed
	Random seed.

Detailed Description

Event writer based on HepMC3.

Module dedicated to writing events. It is based on HepMC3 library.

Constructor & Destructor Documentation

WriterHepMC3() [1/2]

EPIC::WriterHepMC3::WriterHepMC3

(

const std::string &

className

)

Default constructor.

WriterHepMC3() [2/2]

EPIC::WriterHepMC3::WriterHepMC3

(

const WriterHepMC3 &

other

)

Copy constructor.

~WriterHepMC3()

virtual EPIC::WriterHepMC3::~WriterHepMC3 ( )

virtual

Destructor.

Member Function Documentation

close()

virtual void EPIC::WriterHepMC3::close ( )

virtual

Close file.

Implements EPIC::WriterModule.

configure()

virtual void EPIC::WriterHepMC3::configure ( const ElemUtils::Parameters &  parameters )

virtual

Reimplemented from EPIC::WriterModule.

getWriterHepMC3Type()

WriterHepMC3Type::Type EPIC::WriterHepMC3::getWriterHepMC3Type

(

)

const

Get HepMC3 writer type.

open()

virtual void EPIC::WriterHepMC3::open ( )

virtual

Open file.

Implements EPIC::WriterModule.

saveGenerationInformation()

virtual void EPIC::WriterHepMC3::saveGenerationInformation ( const GenerationInformation &  generationInformation )

virtual

Save run information.

Implements EPIC::WriterModule.

setWriterHepMC3Type()

void EPIC::WriterHepMC3::setWriterHepMC3Type

(

WriterHepMC3Type::Type

writerHepMc3Type

)

Set HepMC3 writer type.

write() [1/2]

virtual void EPIC::WriterHepMC3::write ( const Event &  event )

virtual

Write single event (file must be open).

Implements EPIC::WriterModule.

write() [2/2]

virtual void EPIC::WriterHepMC3::write ( const std::vector< Event > &  events )

virtual

Write vector of events (file must be open).

Implements EPIC::WriterModule.

Member Data Documentation

classId

const unsigned int EPIC::WriterHepMC3::classId

static

WriterHepMC3::configure().

Unique ID to automatically register the class in the registry.

PARAMETER_NAME_HEPMC3_WRITER_TYPE

const std::string EPIC::WriterHepMC3::PARAMETER_NAME_HEPMC3_WRITER_TYPE

static

String used to set HepMC3 writer type through

---

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

• /Users/pawel/projects/epic/NEW2/epic/include/modules/writer/WriterHepMC3.h