#include <ParmParse.H>

Inheritance diagram for IO::ParmParse:

Public Member Functions
	ParmParse (std::string arg)

	ParmParse ()

std::string	getPrefix () const

void	ignore (std::string name)

void	forbid (std::string name, std::string explanation, std::string file="", std::string func="", int line=-1)

bool	contains (std::string name)

template<typename T >
int	query_required (std::string name, T &value, std::string file="", std::string func="", int line=-1)

template<typename T >
int	query_default (std::string name, T &value, T defaultvalue, std::string="", std::string="", int=-1)

int	query_validate (std::string name, int &value, std::vector< int > possibleintvals, std::string file="", std::string func="", int line=-1)

int	query_validate (std::string name, std::string &value, std::vector< const char * > possiblecharvals, bool firstbydefault, std::string file="", std::string func="", int line=-1)

int	query_validate (std::string name, std::string &value, std::vector< const char * > possiblecharvals, std::string file="", std::string func="", int line=-1)

int	query_default (std::string name, std::string &value, const char *defaultvalue, std::string file="", std::string func="", int line=-1)

int	query_default (std::string name, int &value, bool defaultvalue, std::string file="", std::string func="query_default", int line=-1)

int	query_file (std::string name, std::string &value, bool copyfile, bool checkfile, std::string file="", std::string func="query_file", int line=-1)

int	query_file (std::string name, std::string &value, bool copyfile, std::string file="", std::string func="query_file", int line=-1)

int	query_file (std::string name, std::string &value, std::string file="", std::string func="query_file", int line=-1)

template<typename T >
int	queryarr (std::string name, std::vector< T > &value, std::string, std::string, int)

int	queryarr (std::string name, Set::Vector &value, std::string file="", std::string func="queryarr", int line=-1)

int	queryarr (std::string name, Set::Matrix &value, std::string file="", std::string func="queryarr", int line=-1)

template<typename T >
int	queryarr_required (std::string name, std::vector< T > &value, std::string file, std::string func, int line)

int	queryarr_default (std::string name, std::vector< std::string > &value, std::string defaultvalue, std::string="", std::string="", int=-1)

template<typename T >
int	queryclass_enumerate (std::string a_name, std::vector< T > &value, int number=1, std::string file="", std::string func="", int line=__LINE__)

template<typename T >
int	query_enumerate (std::string a_name, std::vector< T > &value, int number=1, std::string file="", std::string func="", int line=__LINE__)

int	AnyUnusedInputs ()

std::vector< std::string >	GetUnusedInputs ()

std::string	prefix ()

std::string	full (std::string name)

template<class T >
void	queryclass (std::string name, T *value, std::string file="", std::string func="", int line=-1)

template<class T >
void	queryclass (std::string name, T &value, std::string file="", std::string func="", int line=__LINE__)

template<class T >
void	queryclass (T *value, std::string file="", std::string func="", int line=__LINE__)

template<class T >
void	queryclass (T &value, std::string file="", std::string func="", int line=__LINE__)

template<typename... IC, typename... Args, typename PTRTYPE >
void	select (std::string name, PTRTYPE *&ic_eta, Args &&... args)

template<typename FirstIC , typename... IC, typename... Args, typename PTRTYPE >
void	select_default (std::string name, PTRTYPE *&ic_eta, Args &&... args)

template<typename... INTEGRATOR, typename... Args, typename PTRTYPE >
void	select_main (PTRTYPE *&ic_eta, Args &&... args)

template<typename INTEGRATOR , typename Args , typename PTRTYPE >
void	select_only (PTRTYPE *&ic_eta, Args &&args)

template<typename INTEGRATOR , typename PTRTYPE >
void	select_only (PTRTYPE *&ic_eta)

template<int N>
void	query_exactly (std::vector< std::string > names, std::pair< std::string, Set::Scalar > values[N])

Static Public Member Functions
static int	AllUnusedInputs ()

Private Member Functions
void	Define ()

Static Private Attributes
static bool	checked_for_input_files = false

Detailed Description

Definition at line 113 of file ParmParse.H.

Constructor & Destructor Documentation

◆ ParmParse() [1/2]

IO::ParmParse::ParmParse ( std::string arg )

inline

Definition at line 132 of file ParmParse.H.

◆ ParmParse() [2/2]

IO::ParmParse::ParmParse ( )

inline

Definition at line 133 of file ParmParse.H.

Member Function Documentation

◆ AllUnusedInputs()

static int IO::ParmParse::AllUnusedInputs ( )

inlinestatic

Definition at line 576 of file ParmParse.H.

◆ AnyUnusedInputs()

int IO::ParmParse::AnyUnusedInputs ( )

inline

Definition at line 549 of file ParmParse.H.

◆ contains()

bool IO::ParmParse::contains ( std::string name )

inline

Definition at line 154 of file ParmParse.H.

◆ Define()

void IO::ParmParse::Define ( )

inlineprivate

Definition at line 116 of file ParmParse.H.

◆ forbid()

void IO::ParmParse::forbid	(	std::string	name,
		std::string	explanation,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 140 of file ParmParse.H.

◆ full()

std::string IO::ParmParse::full ( std::string name )

inline

Definition at line 594 of file ParmParse.H.

◆ getPrefix()

std::string IO::ParmParse::getPrefix ( ) const

inline

Definition at line 134 of file ParmParse.H.

◆ GetUnusedInputs()

std::vector< std::string > IO::ParmParse::GetUnusedInputs ( )

inline

Definition at line 563 of file ParmParse.H.

◆ ignore()

void IO::ParmParse::ignore ( std::string name )

inline

Definition at line 135 of file ParmParse.H.

◆ prefix()

std::string IO::ParmParse::prefix ( )

inline

Definition at line 590 of file ParmParse.H.

◆ query_default() [1/3]

int IO::ParmParse::query_default	(	std::string	name,
		int &	value,
		bool	defaultvalue,
		std::string	file = `""`,
		std::string	func = `"query_default"`,
		int	line = `-1`
	)

inline

Definition at line 277 of file ParmParse.H.

◆ query_default() [2/3]

int IO::ParmParse::query_default	(	std::string	name,
		std::string &	value,
		const char *	defaultvalue,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 271 of file ParmParse.H.

◆ query_default() [3/3]

template<typename T >

int IO::ParmParse::query_default	(	std::string	name,
		T &	value,
		T	defaultvalue,
		std::string	= `""`,
		std::string	= `""`,
		int	= `-1`
	)

inline

Definition at line 185 of file ParmParse.H.

◆ query_enumerate()

template<typename T >

int IO::ParmParse::query_enumerate	(	std::string	a_name,
		std::vector< T > &	value,
		int	number = `1`,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `__LINE__`
	)

inline

Definition at line 483 of file ParmParse.H.

◆ query_exactly()

template<int N>

void IO::ParmParse::query_exactly	(	std::vector< std::string >	names,
		std::pair< std::string, Set::Scalar >	values[N]
	)

inline

Definition at line 778 of file ParmParse.H.

◆ query_file() [1/3]

int IO::ParmParse::query_file	(	std::string	name,
		std::string &	value,
		bool	copyfile,
		bool	checkfile,
		std::string	file = `""`,
		std::string	func = `"query_file"`,
		int	line = `-1`
	)

inline

Definition at line 288 of file ParmParse.H.

◆ query_file() [2/3]

int IO::ParmParse::query_file	(	std::string	name,
		std::string &	value,
		bool	copyfile,
		std::string	file = `""`,
		std::string	func = `"query_file"`,
		int	line = `-1`
	)

inline

Definition at line 323 of file ParmParse.H.

◆ query_file() [3/3]

int IO::ParmParse::query_file	(	std::string	name,
		std::string &	value,
		std::string	file = `""`,
		std::string	func = `"query_file"`,
		int	line = `-1`
	)

inline

Definition at line 328 of file ParmParse.H.

◆ query_required()

template<typename T >

int IO::ParmParse::query_required	(	std::string	name,
		T &	value,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 174 of file ParmParse.H.

◆ query_validate() [1/3]

int IO::ParmParse::query_validate	(	std::string	name,
		int &	value,
		std::vector< int >	possibleintvals,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 195 of file ParmParse.H.

◆ query_validate() [2/3]

int IO::ParmParse::query_validate	(	std::string	name,
		std::string &	value,
		std::vector< const char * >	possiblecharvals,
		bool	firstbydefault,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 226 of file ParmParse.H.

◆ query_validate() [3/3]

int IO::ParmParse::query_validate	(	std::string	name,
		std::string &	value,
		std::vector< const char * >	possiblecharvals,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 263 of file ParmParse.H.

◆ queryarr() [1/3]

int IO::ParmParse::queryarr	(	std::string	name,
		Set::Matrix &	value,
		std::string	file = `""`,
		std::string	func = `"queryarr"`,
		int	line = `-1`
	)

inline

Definition at line 353 of file ParmParse.H.

◆ queryarr() [2/3]

int IO::ParmParse::queryarr	(	std::string	name,
		Set::Vector &	value,
		std::string	file = `""`,
		std::string	func = `"queryarr"`,
		int	line = `-1`
	)

inline

Definition at line 341 of file ParmParse.H.

◆ queryarr() [3/3]

template<typename T >

int IO::ParmParse::queryarr	(	std::string	name,
		std::vector< T > &	value,
		std::string	,
		std::string	,
		int
	)

inline

Definition at line 336 of file ParmParse.H.

◆ queryarr_default()

int IO::ParmParse::queryarr_default	(	std::string	name,
		std::vector< std::string > &	value,
		std::string	defaultvalue,
		std::string	= `""`,
		std::string	= `""`,
		int	= `-1`
	)

inline

Definition at line 402 of file ParmParse.H.

◆ queryarr_required()

template<typename T >

int IO::ParmParse::queryarr_required	(	std::string	name,
		std::vector< T > &	value,
		std::string	file,
		std::string	func,
		int	line
	)

inline

Definition at line 391 of file ParmParse.H.

◆ queryclass() [1/4]

template<class T >

void IO::ParmParse::queryclass	(	std::string	name,
		T &	value,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `__LINE__`
	)

inline

Definition at line 630 of file ParmParse.H.

◆ queryclass() [2/4]

template<class T >

void IO::ParmParse::queryclass	(	std::string	name,
		T *	value,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `-1`
	)

inline

Definition at line 604 of file ParmParse.H.

◆ queryclass() [3/4]

template<class T >

void IO::ParmParse::queryclass	(	T &	value,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `__LINE__`
	)

inline

Definition at line 670 of file ParmParse.H.

◆ queryclass() [4/4]

template<class T >

void IO::ParmParse::queryclass	(	T *	value,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `__LINE__`
	)

inline

Definition at line 657 of file ParmParse.H.

◆ queryclass_enumerate()

template<typename T >

int IO::ParmParse::queryclass_enumerate	(	std::string	a_name,
		std::vector< T > &	value,
		int	number = `1`,
		std::string	file = `""`,
		std::string	func = `""`,
		int	line = `__LINE__`
	)

inline

Definition at line 416 of file ParmParse.H.

◆ select()

template<typename... IC, typename... Args, typename PTRTYPE >

void IO::ParmParse::select	(	std::string	name,
		PTRTYPE *&	ic_eta,
		Args &&...	args
	)

inline

Definition at line 692 of file ParmParse.H.

◆ select_default()

template<typename FirstIC , typename... IC, typename... Args, typename PTRTYPE >

void IO::ParmParse::select_default	(	std::string	name,
		PTRTYPE *&	ic_eta,
		Args &&...	args
	)

inline

Definition at line 720 of file ParmParse.H.

◆ select_main()

template<typename... INTEGRATOR, typename... Args, typename PTRTYPE >

void IO::ParmParse::select_main	(	PTRTYPE *&	ic_eta,
		Args &&...	args
	)

inline

Definition at line 744 of file ParmParse.H.

◆ select_only() [1/2]

template<typename INTEGRATOR , typename PTRTYPE >

void IO::ParmParse::select_only ( PTRTYPE *& ic_eta )

inline

Definition at line 771 of file ParmParse.H.

◆ select_only() [2/2]

template<typename INTEGRATOR , typename Args , typename PTRTYPE >

void IO::ParmParse::select_only	(	PTRTYPE *&	ic_eta,
		Args &&	args
	)

inline

Definition at line 765 of file ParmParse.H.

Field Documentation

◆ checked_for_input_files

bool IO::ParmParse::checked_for_input_files = false

staticprivate

Definition at line 129 of file ParmParse.H.

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

src/IO/ParmParse.H
src/IO/ParmParse.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParmParse() [1/2]

◆ ParmParse() [2/2]

Member Function Documentation

◆ AllUnusedInputs()

◆ AnyUnusedInputs()

◆ contains()

◆ Define()

◆ forbid()

◆ full()

◆ getPrefix()

◆ GetUnusedInputs()

◆ ignore()

◆ prefix()

◆ query_default() [1/3]

◆ query_default() [2/3]

◆ query_default() [3/3]

◆ query_enumerate()

◆ query_exactly()

◆ query_file() [1/3]

◆ query_file() [2/3]

◆ query_file() [3/3]

◆ query_required()

◆ query_validate() [1/3]

◆ query_validate() [2/3]

◆ query_validate() [3/3]

◆ queryarr() [1/3]

◆ queryarr() [2/3]

◆ queryarr() [3/3]

◆ queryarr_default()

◆ queryarr_required()

◆ queryclass() [1/4]

◆ queryclass() [2/4]

◆ queryclass() [3/4]

◆ queryclass() [4/4]

◆ queryclass_enumerate()

◆ select()

◆ select_default()

◆ select_main()

◆ select_only() [1/2]

◆ select_only() [2/2]

Field Documentation

◆ checked_for_input_files