molpro::Options Class Reference

#include <Options.h>

Public Member Functions
	Options (std::string program, std::string input="")
	Construct Options object. More...
	Options (std::string program, int argc, char *argv[])
std::vector< int >	parameter (const std::string &key, const std::vector< int > &def) const
	Obtain an integer parameter. More...
int	parameter (const std::string &key, int def=0) const
std::vector< double >	parameter (const std::string &key, const std::vector< double > &def) const
	Obtain a real parameter. More...
double	parameter (const std::string &key, double def) const
std::vector< std::string >	parameter (const std::string &key, const std::vector< std::string > &def, bool molpro_parameter=false) const
	Obtain a string parameter. More...
std::string	parameter (const std::string &key, const std::string &def) const
void	addParameter (const std::string &key, const std::vector< std::string > &values, bool echo=false)
	Add a parameter with array values. More...
void	addParameter (const std::string &key, const std::vector< int > &values, bool echo=false)
	Add a parameter with array values. More...
void	addParameter (const std::string &key, const std::vector< double > &values, bool echo=false)
	Add a parameter with array values. More...
void	addParameter (const std::string &key, const std::string &value, bool echo=false)
	Add a parameter with a scalar value. More...
void	addParameter (const std::string &key, const int &value, bool echo=false)
	Add a parameter with a scalar value. More...
void	addParameter (const std::string &key, const double &value, bool echo=false)
	Add a parameter with a scalar value. More...
std::string	data () const

Constructor & Destructor Documentation

Options() [1/2]

molpro::Options::Options ( std::string  program, std::string  input = ""  )

explicit

Construct Options object.

Parameters

input	Namelist format option specifier
program	Name of code module owning this set of options. In the Molpro context, this is the registry set.

Options() [2/2]

molpro::Options::Options ( std::string  program, int  argc, char *  argv[]  )

explicit

Member Function Documentation

addParameter() [1/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const double &	value,
		bool	echo = false
	)

Add a parameter with a scalar value.

Parameters

key	key
value	value
echo	whether to print the parameter and value

addParameter() [2/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const int &	value,
		bool	echo = false
	)

Add a parameter with a scalar value.

Parameters

key	key
value	value
echo	whether to print the parameter and value

addParameter() [3/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const std::string &	value,
		bool	echo = false
	)

Add a parameter with a scalar value.

Parameters

key	key
value	value
echo	whether to print the parameter and value

addParameter() [4/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const std::vector< double > &	values,
		bool	echo = false
	)

Add a parameter with array values.

Parameters

key	key
values	values
echo	whether to print the parameter and value

addParameter() [5/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const std::vector< int > &	values,
		bool	echo = false
	)

Add a parameter with array values.

Parameters

key	key
values	values
echo	whether to print the parameter and value

addParameter() [6/6]

void molpro::Options::addParameter	(	const std::string &	key,
		const std::vector< std::string > &	values,
		bool	echo = false
	)

Add a parameter with array values.

Parameters

key	key
values	values
echo	whether to print the parameter and value

data()

std::string molpro::Options::data ( ) const

inline

parameter() [1/6]

std::string molpro::Options::parameter	(	const std::string &	key,
		const std::string &	def
	)		const

parameter() [2/6]

std::vector< double > molpro::Options::parameter	(	const std::string &	key,
		const std::vector< double > &	def
	)		const

Obtain a real parameter.

Parameters

key	The name of the parameter
def	Default value if the parameter is not found.

Returns

The result as a vector of integers.

parameter() [3/6]

std::vector< int > molpro::Options::parameter	(	const std::string &	key,
		const std::vector< int > &	def
	)		const

Obtain an integer parameter.

Parameters

key	The name of the parameter
def	Default value if the parameter is not found.

Returns

The result as a vector of integers.

parameter() [4/6]

std::vector< std::string > molpro::Options::parameter	(	const std::string &	key,
		const std::vector< std::string > &	def,
		bool	molpro_parameter = false
	)		const

Obtain a string parameter.

Parameters

key	The name of the parameter
def	Default value if the parameter is not found.

Returns

The result as a vector of integers.

parameter() [5/6]

double molpro::Options::parameter	(	const std::string &	key,
		double	def
	)		const

parameter() [6/6]

int molpro::Options::parameter	(	const std::string &	key,
		int	def = 0
	)		const

---

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

• /__w/utilities/utilities/src/molpro/Options.h
• /__w/utilities/utilities/src/molpro/Options.cpp