parses the command line options More...

#include <command_line_options.hpp>

Collaboration diagram for flexiblesusy::Command_line_options:

Public Member Functions
	Command_line_options ()=default

	Command_line_options (const Dynamic_array_view< char * > &)

	Command_line_options (int, char *[])

const std::string &	get_database_output_file () const

const std::string &	get_higgsbounds_dataset () const

const std::string &	get_higgssignals_dataset () const

const std::string &	get_lilith_db () const

const std::string &	get_program_name () const

const std::string &	get_rgflow_file () const

const std::string &	get_slha_input_file () const

const std::string &	get_slha_output_file () const

const std::string &	get_spectrum_file () const

bool	must_exit () const

bool	must_print_model_info () const

void	parse (const Dynamic_array_view< char * > &)

void	print_build_info (std::ostream &) const

void	print_usage (std::ostream &) const

void	print_version (std::ostream &) const

void	reset ()

int	status () const

Static Public Member Functions
static bool	get_parameter_value (const std::string &, const std::string &, double &)

static bool	get_parameter_value (const std::string &, const std::string &, int &)

static bool	starts_with (const std::string &, const std::string &)

Private Attributes
std::string	database_output_file {}

bool	do_exit {false}

bool	do_print_model_info {false}

int	exit_status {EXIT_SUCCESS}

std::string	higgsbounds_dataset {}

std::string	higgssignals_dataset {}

std::string	lilith_db {}

std::string	program {}

std::string	rgflow_file {}

std::string	slha_input_file {}

std::string	slha_output_file {"-"}

std::string	spectrum_file {}

Detailed Description

parses the command line options

Usage:

int main(int argc, char* argv[])
{
   using namespace flexiblesusy;
   Command_line_options options(argc, argv);
   if (options.must_exit())
      return options.status();
   cout << "SLHA input file: " << options.get_slha_input_file() << endl;
}

Definition at line 47 of file command_line_options.hpp.

Constructor & Destructor Documentation

◆ Command_line_options() [1/3]

flexiblesusy::Command_line_options::Command_line_options ( )

default

Referenced by reset().

◆ Command_line_options() [2/3]

flexiblesusy::Command_line_options::Command_line_options	(	int	argc,
		char *	argv[]
	)

Definition at line 28 of file command_line_options.cpp.

◆ Command_line_options() [3/3]

flexiblesusy::Command_line_options::Command_line_options ( const Dynamic_array_view< char * > & args )

Definition at line 33 of file command_line_options.cpp.

References parse().

Member Function Documentation

◆ get_database_output_file()

const std::string & flexiblesusy::Command_line_options::get_database_output_file ( ) const

inline

Definition at line 62 of file command_line_options.hpp.

References database_output_file.

◆ get_higgsbounds_dataset()

const std::string & flexiblesusy::Command_line_options::get_higgsbounds_dataset ( ) const

inline

Definition at line 68 of file command_line_options.hpp.

References higgsbounds_dataset.

◆ get_higgssignals_dataset()

const std::string & flexiblesusy::Command_line_options::get_higgssignals_dataset ( ) const

inline

Definition at line 69 of file command_line_options.hpp.

References higgssignals_dataset.

◆ get_lilith_db()

const std::string & flexiblesusy::Command_line_options::get_lilith_db ( ) const

inline

Definition at line 70 of file command_line_options.hpp.

References lilith_db.

◆ get_parameter_value() [1/2]

bool flexiblesusy::Command_line_options::get_parameter_value	(	const std::string &	str,
		const std::string &	prefix,
		double &	parameter
	)

static

Extracts the parameter value from a command line option string of the form –m0=125 .

Parameters

	str	full option string, including the parameter value (–m0=125)
	prefix	option string, without the parameter value (–m0=)
[out]	parameter	output parameter value (of type double)

Returns: true, if str starts with prefix, false otherwise

Definition at line 162 of file command_line_options.cpp.

References starts_with().

◆ get_parameter_value() [2/2]

bool flexiblesusy::Command_line_options::get_parameter_value	(	const std::string &	str,
		const std::string &	prefix,
		int &	parameter
	)

static

Extracts the parameter value from a command line option string of the form –m0=125 .

Parameters

	str	full option string, including the parameter value (–m0=125)
	prefix	option string, without the parameter value (–m0=)
[out]	parameter	output parameter value (of type int)

Returns: true, if str starts with prefix, false otherwise

Definition at line 183 of file command_line_options.cpp.

References starts_with().

◆ get_program_name()

const std::string & flexiblesusy::Command_line_options::get_program_name ( ) const

inline

Definition at line 65 of file command_line_options.hpp.

References program.

◆ get_rgflow_file()

const std::string & flexiblesusy::Command_line_options::get_rgflow_file ( ) const

inline

Definition at line 66 of file command_line_options.hpp.

References rgflow_file.

◆ get_slha_input_file()

const std::string & flexiblesusy::Command_line_options::get_slha_input_file ( ) const

inline

Definition at line 63 of file command_line_options.hpp.

References slha_input_file.

◆ get_slha_output_file()

const std::string & flexiblesusy::Command_line_options::get_slha_output_file ( ) const

inline

Definition at line 64 of file command_line_options.hpp.

References slha_output_file.

◆ get_spectrum_file()

const std::string & flexiblesusy::Command_line_options::get_spectrum_file ( ) const

inline

Definition at line 67 of file command_line_options.hpp.

References spectrum_file.

◆ must_exit()

bool flexiblesusy::Command_line_options::must_exit ( ) const

inline

Definition at line 53 of file command_line_options.hpp.

References do_exit.

◆ must_print_model_info()

bool flexiblesusy::Command_line_options::must_print_model_info ( ) const

inline

Definition at line 54 of file command_line_options.hpp.

References do_print_model_info.

◆ parse()

void flexiblesusy::Command_line_options::parse ( const Dynamic_array_view< char * > & args )

Parse string of program options and store the given option values in the member variables of this class.

Parameters

args	command line arguments

Definition at line 44 of file command_line_options.cpp.

References database_output_file, do_exit, do_print_model_info, flexiblesusy::Dynamic_array_view< ElementType >::empty(), ERROR, exit_status, higgsbounds_dataset, higgssignals_dataset, lilith_db, print_build_info(), print_usage(), print_version(), program, reset(), rgflow_file, flexiblesusy::Dynamic_array_view< ElementType >::size(), slha_input_file, slha_output_file, spectrum_file, and starts_with().

Referenced by Command_line_options().

◆ print_build_info()

void flexiblesusy::Command_line_options::print_build_info ( std::ostream & ostr ) const

Definition at line 91 of file command_line_options.cpp.

References flexiblesusy::print_all_info().

Referenced by parse().

◆ print_usage()

void flexiblesusy::Command_line_options::print_usage ( std::ostream & ostr ) const

Definition at line 103 of file command_line_options.cpp.

References program.

Referenced by parse().

◆ print_version()

void flexiblesusy::Command_line_options::print_version ( std::ostream & ostr ) const

Definition at line 96 of file command_line_options.cpp.

References flexiblesusy::print_flexiblesusy_version().

Referenced by parse().

◆ reset()

void flexiblesusy::Command_line_options::reset ( )

Resets all command line options to their initial values.

Definition at line 133 of file command_line_options.cpp.

References Command_line_options().

Referenced by parse().

◆ starts_with()

bool flexiblesusy::Command_line_options::starts_with	(	const std::string &	str,
		const std::string &	prefix
	)

static

Returns true if the string str starts with prefix, false otherwise.

Parameters

str	string to search in
prefix	string to search for

Returns: true if the string str starts with prefix, false otherwise

Definition at line 146 of file command_line_options.cpp.

Referenced by get_parameter_value(), get_parameter_value(), and parse().

◆ status()

int flexiblesusy::Command_line_options::status ( ) const

inline

Definition at line 55 of file command_line_options.hpp.

References exit_status.

Member Data Documentation

◆ database_output_file

std::string flexiblesusy::Command_line_options::database_output_file {}

private

Definition at line 81 of file command_line_options.hpp.

Referenced by get_database_output_file(), and parse().

◆ do_exit

bool flexiblesusy::Command_line_options::do_exit {false}

private

Definition at line 77 of file command_line_options.hpp.

Referenced by must_exit(), and parse().

◆ do_print_model_info

bool flexiblesusy::Command_line_options::do_print_model_info {false}

private

Definition at line 78 of file command_line_options.hpp.

Referenced by must_print_model_info(), and parse().

◆ exit_status

int flexiblesusy::Command_line_options::exit_status {EXIT_SUCCESS}

private

Definition at line 79 of file command_line_options.hpp.

Referenced by parse(), and status().

◆ higgsbounds_dataset

std::string flexiblesusy::Command_line_options::higgsbounds_dataset {}

private

Definition at line 83 of file command_line_options.hpp.

Referenced by get_higgsbounds_dataset(), and parse().

◆ higgssignals_dataset

std::string flexiblesusy::Command_line_options::higgssignals_dataset {}

private

Definition at line 82 of file command_line_options.hpp.

Referenced by get_higgssignals_dataset(), and parse().

◆ lilith_db

std::string flexiblesusy::Command_line_options::lilith_db {}

private

Definition at line 84 of file command_line_options.hpp.

Referenced by get_lilith_db(), and parse().

◆ program

std::string flexiblesusy::Command_line_options::program {}

private

Definition at line 80 of file command_line_options.hpp.

Referenced by get_program_name(), parse(), and print_usage().

◆ rgflow_file

std::string flexiblesusy::Command_line_options::rgflow_file {}

private

Definition at line 85 of file command_line_options.hpp.

Referenced by get_rgflow_file(), and parse().

◆ slha_input_file

std::string flexiblesusy::Command_line_options::slha_input_file {}

private

Definition at line 86 of file command_line_options.hpp.

Referenced by get_slha_input_file(), and parse().

◆ slha_output_file

std::string flexiblesusy::Command_line_options::slha_output_file {"-"}

private

Definition at line 87 of file command_line_options.hpp.

Referenced by get_slha_output_file(), and parse().

◆ spectrum_file

std::string flexiblesusy::Command_line_options::spectrum_file {}

private

Definition at line 88 of file command_line_options.hpp.

Referenced by get_spectrum_file(), and parse().

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Command_line_options() [1/3]

◆ Command_line_options() [2/3]

◆ Command_line_options() [3/3]

Member Function Documentation

◆ get_database_output_file()

◆ get_higgsbounds_dataset()

◆ get_higgssignals_dataset()

◆ get_lilith_db()

◆ get_parameter_value() [1/2]

◆ get_parameter_value() [2/2]

◆ get_program_name()

◆ get_rgflow_file()

◆ get_slha_input_file()

◆ get_slha_output_file()

◆ get_spectrum_file()

◆ must_exit()

◆ must_print_model_info()

◆ parse()

◆ print_build_info()

◆ print_usage()

◆ print_version()

◆ reset()

◆ starts_with()

◆ status()

Member Data Documentation

◆ database_output_file

◆ do_exit

◆ do_print_model_info

◆ exit_status

◆ higgsbounds_dataset

◆ higgssignals_dataset

◆ lilith_db

◆ program

◆ rgflow_file

◆ slha_input_file

◆ slha_output_file

◆ spectrum_file