YAMLreader.hh File Reference

The file which handles the configuration file parameters. More...

#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "yaml-cpp/yaml.h"
#include "fastjet/JetDefinition.hh"
#include "HEJ/Config.hh"
#include "HEJ/Fraction.hh"
#include "HEJ/PDG_codes.hh"
#include "HEJ/exceptions.hh"
#include "HEJ/utility.hh"

Include dependency graph for YAMLreader.hh:

Go to the source code of this file.

Classes
struct	YAML::convert< HEJ::OutputFile >
struct	YAML::convert< HEJ::Fraction< Real > >

Namespaces
	HEJ
	Main HEJ 2 Namespace.
	HEJ::detail
	YAML

Functions
Config	HEJ::load_config (std::string const &config_file)
	Load configuration from file. More...
Config	HEJ::to_Config (YAML::Node const &yaml)
	Extract configuration from YAML. More...
template<typename T , typename... YamlNames>
void	HEJ::set_from_yaml (T &setting, YAML::Node const &yaml, YamlNames const &... names)
	Set option using the corresponding YAML entry. More...
template<typename T , typename... YamlNames>
void	HEJ::set_from_yaml_if_defined (T &setting, YAML::Node const &yaml, YamlNames const &... names)
	Set option using the corresponding YAML entry, if present. More...
JetParameters	HEJ::get_jet_parameters (YAML::Node const &node, std::string const &entry)
	Extract jet parameters from YAML configuration. More...
HiggsCouplingSettings	HEJ::get_Higgs_coupling (YAML::Node const &node, std::string const &entry)
	Extract Higgs coupling settings from YAML configuration. More...
EWConstants	HEJ::get_ew_parameters (YAML::Node const &node)
	Extract the EW parameters from YAML configuration. More...
ScaleConfig	HEJ::to_ScaleConfig (YAML::Node const &yaml)
	Extract scale setting parameters from YAML configuration. More...
RNGConfig	HEJ::to_RNGConfig (YAML::Node const &node, std::string const &entry)
	Extract random number generator settings from YAML configuration. More...
NLOConfig	HEJ::to_NLOConfig (YAML::Node const &node, std::string const &entry)
	Extract HEJNLO settings from YAML configuration. More...
void	HEJ::assert_all_options_known (YAML::Node const &conf, YAML::Node const &supported)
	Check whether all options in configuration are supported. More...
void	HEJ::detail::set_from_yaml (fastjet::JetAlgorithm &setting, YAML::Node const &yaml)
void	HEJ::detail::set_from_yaml (EventTreatment &setting, YAML::Node const &yaml)
void	HEJ::detail::set_from_yaml (ParticleID &setting, YAML::Node const &yaml)
void	HEJ::detail::set_from_yaml (OutputFile &setting, YAML::Node const &yaml)
void	HEJ::detail::set_from_yaml (WeightType &setting, YAML::Node const &yaml)
void	HEJ::detail::set_from_yaml (YAML::Node &setting, YAML::Node const &yaml)
template<typename Scalar >
void	HEJ::detail::set_from_yaml (Scalar &setting, YAML::Node const &yaml)
template<typename T >
void	HEJ::detail::set_from_yaml (std::optional< T > &setting, YAML::Node const &yaml)
template<typename T >
void	HEJ::detail::set_from_yaml (std::vector< T > &setting, YAML::Node const &yaml)
template<typename T , typename FirstName , typename... YamlNames>
void	HEJ::detail::set_from_yaml (T &setting, YAML::Node const &yaml, FirstName const &name, YamlNames &&... names)
template<typename T >
void	HEJ::detail::set_from_yaml_if_defined (T &setting, YAML::Node const &yaml)
template<typename T , typename FirstName , typename... YamlNames>
void	HEJ::detail::set_from_yaml_if_defined (T &setting, YAML::Node const &yaml, FirstName const &name, YamlNames &&... names)
std::string	HEJ::to_string (YAML::Node const &yaml)

Detailed Description

The file which handles the configuration file parameters.

The configuration files parameters are read and then stored within this objects.

Authors

The HEJ collaboration (see AUTHORS for details)

Date

2019-2023

Copyright

GPLv2 or later