HepMC3Handler< T > Class Template Reference

Handler for the HepMC3 file output. More...

Inheritance diagram for HepMC3Handler< T >:

Collaboration diagram for HepMC3Handler< T >:

Public Member Functions
	HepMC3Handler (const ParametersList &params)
virtual	~HepMC3Handler ()
bool	operator<< (const Event &cg_event) override
	Writer operator.
void	setCrossSection (const Value &cross_section) override
	Specify the cross section value, in pb.
void	setEventNumber (unsigned long long ev_id)
	Set event number.
void	initialise (const RunParameters &)
	Initialise the handler and its inner parameterisation.
const RunParameters &	runParameters () const
	List of run parameters.
template<typename T >
T *	engine ()
	Retrieve the engine object.
const std::string &	name () const
	Module unique indexing name.
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
const ParametersList &	parameters () const override
	Module user-defined parameters.
virtual void	setParameters (const ParametersList &params) override
	Set module parameters.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Protected Member Functions
std::string	banner (const std::string &prep="") const
	Print a banner containing runtime parameters.
virtual void *	enginePtr ()
	Engine object.
template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.
template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.
std::string	steerName () const
	Retrieve module name from parameters.
std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
unsigned long long	event_num_ {0ull}
	Event index.
const std::string	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Detailed Description

template<typename T>
class cepgen::HepMC3Handler< T >

Template Parameters

T	HepMC writer handler (format-dependent)

Author

Laurent Forthomme laure.nosp@m.nt.f.nosp@m.ortho.nosp@m.mme@.nosp@m.cern..nosp@m.ch

Date

Sep 2016

Definition at line 39 of file HepMC3Handler.cpp.

Constructor & Destructor Documentation

HepMC3Handler()

template<typename T >

HepMC3Handler ( const ParametersList &  params )

explicit

Definition at line 41 of file HepMC3Handler.cpp.

~HepMC3Handler()

template<typename T >

virtual ~HepMC3Handler ( )

virtual

Definition at line 51 of file HepMC3Handler.cpp.

Member Function Documentation

banner()

std::string banner ( const std::string &  prep = "" ) const

protectedinherited

Definition at line 32 of file EventExporter.cpp.

description()

template<typename T >

static ParametersDescription description ( )

static

Definition at line 53 of file HepMC3Handler.cpp.

engine()

template<typename T >

T * engine ( )

inherited

Definition at line 42 of file EventHandler.h.

enginePtr()

void * enginePtr ( )

protectedvirtualinherited

Definition at line 50 of file EventHandler.cpp.

initialise()

void initialise ( const RunParameters &  params )

inherited

Definition at line 36 of file EventHandler.cpp.

name()

const std::string & name ( ) const

inherited

Definition at line 42 of file NamedModule.h.

operator!=()

template<typename T >

bool operator!= ( const SteeredObject< T > &  oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

operator<<()

template<typename T >

bool operator<< ( const Event &  )

overridevirtual

Implements EventExporter.

Definition at line 60 of file HepMC3Handler.cpp.

operator==()

template<typename T >

bool operator== ( const SteeredObject< T > &  oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

runParameters()

const RunParameters & runParameters ( ) const

inherited

Definition at line 44 of file EventHandler.cpp.

setCrossSection()

template<typename T >

void setCrossSection ( const Value &  )

overridevirtual

Reimplemented from EventExporter.

Definition at line 68 of file HepMC3Handler.cpp.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setEventNumber()

void setEventNumber ( unsigned long long  ev_id )

inherited

Definition at line 35 of file EventExporter.h.

setParameters()

template<typename T >

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

steer()

template<typename T >

T steer ( const std::string &  key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

U steerAs ( const std::string &  key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

steerPath()

std::string steerPath ( const std::string &  key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

event_num_

unsigned long long event_num_ {0ull}

protectedinherited

Definition at line 41 of file EventExporter.h.

name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.