Detailed Description

Stores additional information about Heavy Ion generator.

This is an example of event attribute used to store Heavy Ion information

Examples:: HepMC3_fileIO_example.cc.

Definition at line 26 of file build/outputs/include/HepMC/GenHeavyIon.h.

#include <GenHeavyIon.h>

Inheritance diagram for GenHeavyIon:

Collaboration diagram for GenHeavyIon:

Public Member Functions
bool	from_string (const string &att)
	Implementation of Attribute::from_string. More...

bool	to_string (string &att) const
	Implementation of Attribute::to_string. More...

void	set (int nh, int np, int nt, int nc, int ns, int nsp, int nnw=0, int nwn=0, int nwnw=0, float im=0., float pl=0., float ec=0., float s=0., float cent=0.)
	Set all fields. More...

bool	operator== (const GenHeavyIon &) const
	Operator ==. More...

bool	operator!= (const GenHeavyIon &) const
	Operator !=. More...

bool	is_valid () const
	Verify that the instance contains non-zero information. More...

bool	from_string (const string &att)
	Implementation of Attribute::from_string. More...

bool	to_string (string &att) const
	Implementation of Attribute::to_string. More...

void	set (int nh, int np, int nt, int nc, int ns, int nsp, int nnw=0, int nwn=0, int nwnw=0, float im=0., float pl=0., float ec=0., float s=0., float cent=0.)
	Set all fields. More...

bool	operator== (const GenHeavyIon &) const
	Operator ==. More...

bool	operator!= (const GenHeavyIon &) const
	Operator !=. More...

bool	is_valid () const
	Verify that the instance contains non-zero information. More...

virtual bool	init (const GenEvent &)
	Optionally initialize the attribute after from_string. More...

virtual bool	init (const GenRunInfo &)
	Optionally initialize the attribute after from_string. More...

virtual bool	init (const GenEvent &)
	Optionally initialize the attribute after from_string. More...

virtual bool	init (const GenRunInfo &)
	Optionally initialize the attribute after from_string. More...

bool	is_parsed ()
	Check if this attribute is parsed. More...

bool	is_parsed ()
	Check if this attribute is parsed. More...

const string &	unparsed_string () const
	Get unparsed string. More...

const string &	unparsed_string () const
	Get unparsed string. More...

Data Fields
int	Ncoll_hard
	Number of hard collisions. More...

int	Npart_proj
	Number of participating nucleons in the projectile. More...

int	Npart_targ
	Number of participating nucleons in the target. More...

int	Ncoll
	Number of collisions. More...

int	spectator_neutrons
	Number of spectator neutrons. More...

int	spectator_protons
	Number of spectator protons. More...

int	N_Nwounded_collisions

int	Nwounded_N_collisions

int	Nwounded_Nwounded_collisions

double	impact_parameter
	Impact parameter. More...

double	event_plane_angle
	Event plane angle. More...

double	eccentricity
	Eccentricity. More...

double	sigma_inel_NN
	Assumed nucleon-nucleon cross-section. More...

double	centrality
	Centrality. More...

Protected Member Functions
void	set_is_parsed (bool flag)
	Set is_parsed flag. More...

void	set_is_parsed (bool flag)
	Set is_parsed flag. More...

void	set_unparsed_string (const string &st)
	Set unparsed string. More...

void	set_unparsed_string (const string &st)
	Set unparsed string. More...

Member Function Documentation

◆ from_string() [1/2]

bool from_string ( const string & att )

virtual

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 18 of file GenHeavyIon.cc.

References GenHeavyIon::centrality, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, and GenHeavyIon::spectator_protons.

◆ from_string() [2/2]

bool from_string ( const string & att )

virtual

Implementation of Attribute::from_string.

Implements Attribute.

◆ init() [1/4]

virtual bool init ( const GenEvent & )

inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file build/outputs/include/HepMC/Attribute.h.

◆ init() [2/4]

virtual bool init ( const GenEvent & )

inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file include/HepMC/Attribute.h.

◆ init() [3/4]

virtual bool init ( const GenRunInfo & )

inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file include/HepMC/Attribute.h.

◆ init() [4/4]

virtual bool init ( const GenRunInfo & )

inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file build/outputs/include/HepMC/Attribute.h.

◆ is_parsed() [1/2]

bool is_parsed ( )

inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ is_parsed() [2/2]

bool is_parsed ( )

inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ is_valid() [1/2]

bool is_valid ( ) const

Verify that the instance contains non-zero information.

◆ is_valid() [2/2]

bool is_valid ( ) const

Verify that the instance contains non-zero information.

Definition at line 116 of file GenHeavyIon.cc.

References GenHeavyIon::centrality, GenHeavyIon::eccentricity, GenHeavyIon::event_plane_angle, GenHeavyIon::impact_parameter, GenHeavyIon::N_Nwounded_collisions, GenHeavyIon::Ncoll, GenHeavyIon::Ncoll_hard, GenHeavyIon::Npart_proj, GenHeavyIon::Npart_targ, GenHeavyIon::Nwounded_N_collisions, GenHeavyIon::Nwounded_Nwounded_collisions, GenHeavyIon::sigma_inel_NN, GenHeavyIon::spectator_neutrons, and GenHeavyIon::spectator_protons.

◆ operator!=() [1/2]

bool operator!= ( const GenHeavyIon & a ) const

Operator !=.

Definition at line 112 of file GenHeavyIon.cc.

◆ operator!=() [2/2]

bool operator!= ( const GenHeavyIon & ) const

Operator !=.

◆ operator==() [1/2]

bool operator== ( const GenHeavyIon & ) const

Operator ==.

◆ operator==() [2/2]

bool operator== ( const GenHeavyIon & a ) const

Operator ==.

Definition at line 108 of file GenHeavyIon.cc.

◆ set() [1/2]

void set	(	int	nh,
		int	np,
		int	nt,
		int	nc,
		int	ns,
		int	nsp,
		int	nnw = `0`,
		int	nwn = `0`,
		int	nwnw = `0`,
		float	im = `0.`,
		float	pl = `0.`,
		float	ec = `0.`,
		float	s = `0.`,
		float	cent = `0.`
	)

Set all fields.

◆ set() [2/2]

void set	(	int	nh,
		int	np,
		int	nt,
		int	nc,
		int	ns,
		int	nsp,
		int	nnw = `0`,
		int	nwn = `0`,
		int	nwnw = `0`,
		float	im = `0.`,
		float	pl = `0.`,
		float	ec = `0.`,
		float	s = `0.`,
		float	cent = `0.`
	)