#include <GeneratorHepMCParam.h>

Inherits o2::conf::ConfigurableParamHelper< GeneratorHepMCParam >.

Public Member Functions
	O2ParamDef (GeneratorHepMCParam, "HepMC")

Public Member Functions inherited from o2::conf::ConfigurableParamHelper< GeneratorHepMCParam >
std::string	getName () const final

EParamProvenance	getMemberProvenance (const std::string &key) const final

void	printKeyValues (bool showProv=true, bool useLogger=false) const final

size_t	getHash () const final

void	output (std::ostream &out) const final

std::vector< ParamDataMember > *	getDataMembers () const

void	putKeyValues (boost::property_tree::ptree *tree) final

void	initFrom (TFile *file) final

void	syncCCDBandRegistry (void *externalobj) final

void	serializeTo (TFile *file) const final

	ConfigurableParam ()

Public Attributes
int	version = 0

uint64_t	eventsToSkip = 0

std::string	fileName = ""

bool	prune = false

Additional Inherited Members
Public Types inherited from o2::conf::ConfigurableParam
enum	EParamProvenance { kCODE , kCCDB , kRT }

enum class	EParamUpdateStatus { Changed , Unchanged , Failed }

Static Public Member Functions inherited from o2::conf::ConfigurableParamHelper< GeneratorHepMCParam >
static const GeneratorHepMCParam &	Instance ()

Static Public Member Functions inherited from o2::conf::ConfigurableParam
static std::string	toString (EParamProvenance p)

static EParamProvenance	getProvenance (const std::string &key)

static void	printAllRegisteredParamNames ()

static void	printAllKeyValuePairs (bool useLogger=false)

static const std::string &	getOutputDir ()

static void	setOutputDir (const std::string &d)

static bool	configFileExists (std::string const &filepath)

static void	writeJSON (std::string const &filename, std::string const &keyOnly="")

static void	writeINI (std::string const &filename, std::string const &keyOnly="")

template<typename T >
static T	getValueAs (std::string key)

template<typename T >
static void	setValue (std::string const &mainkey, std::string const &subkey, T x)

static void	setProvenance (std::string const &mainkey, std::string const &subkey, EParamProvenance p)

static void	setValue (std::string const &key, std::string const &valuestring)

static void	setEnumValue (const std::string &, const std::string &)

static void	setArrayValue (const std::string &, const std::string &)

static void	setValues (std::vector< std::pair< std::string, std::string > > const &keyValues)

static void	initialize ()

static void	toCCDB (std::string filename)

static void	fromCCDB (std::string filename)

static void	updateFromString (std::string const &)

static void	updateFromFile (std::string const &, std::string const &paramsList="", bool unchangedOnly=false)

Protected Member Functions inherited from o2::conf::ConfigurableParam
	ConfigurableParam ()

virtual	~ConfigurableParam ()=default

void	setRegisterMode (bool b)

bool	isInitialized () const

Static Protected Member Functions inherited from o2::conf::ConfigurableParam
static void	initPropertyTree ()

static EParamUpdateStatus	updateThroughStorageMap (std::string, std::string, std::type_info const &, void *)

static EParamUpdateStatus	updateThroughStorageMapWithConversion (std::string const &, std::string const &)

Static Protected Attributes inherited from o2::conf::ConfigurableParam
static std::map< std::string, std::pair< std::type_info const &, void * > > *	sKeyToStorageMap = nullptr

static std::map< std::string, ConfigurableParam::EParamProvenance > *	sValueProvenanceMap = nullptr

static EnumRegistry *	sEnumRegistry = nullptr

static std::string	sOutputDir = ""

Detailed Description

a parameter class/struct to keep the settings of the HepMC event generator and allow the user to modify them

Definition at line 32 of file GeneratorHepMCParam.h.

Member Function Documentation

◆ O2ParamDef()

o2::eventgen::GeneratorHepMCParam::O2ParamDef	(	GeneratorHepMCParam	,
		"HepMC"
	)

Member Data Documentation

◆ eventsToSkip

uint64_t o2::eventgen::GeneratorHepMCParam::eventsToSkip = 0

Number of events to skip at the start of the input

Definition at line 40 of file GeneratorHepMCParam.h.

◆ fileName

std::string o2::eventgen::GeneratorHepMCParam::fileName = ""

Deprecated. Set the name of the file to read from. Use GeneratorFileOrCmd.fileNames instead.

Definition at line 43 of file GeneratorHepMCParam.h.

◆ prune

bool o2::eventgen::GeneratorHepMCParam::prune = false

Wether to prune the event tree. If true, then only particles that are

beam particles (status == 4)
decayed (status == 2), or
final state (status == 1)

are kept. This reduces the event size. How much depends on the event generator producing the event. Use with caution, as it may corrupt the event record.

Definition at line 53 of file GeneratorHepMCParam.h.

◆ version

int o2::eventgen::GeneratorHepMCParam::version = 0

Version number of event structure to decode. Note, when reading from a file, this key is ignored. The interface will figure out the version automatically. When reading from a pipe, and the command line writes HepMC version 2 format, then this parameter should be set to 2

Definition at line 38 of file GeneratorHepMCParam.h.

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

/home/runner/work/AliceO2/AliceO2/Generators/include/Generators/GeneratorHepMCParam.h

Public Member Functions

Public Attributes

Additional Inherited Members