basic::options Namespace Reference

Namespaces
	OptionKeys

Typedefs
typedef utility::options::OptionKey	OptionKey
typedef utility::options::BooleanOptionKey	BooleanOptionKey
typedef utility::options::IntegerOptionKey	IntegerOptionKey
typedef utility::options::RealOptionKey	RealOptionKey
typedef utility::options::StringOptionKey	StringOptionKey
typedef utility::options::FileOptionKey	FileOptionKey
typedef utility::options::PathOptionKey	PathOptionKey
typedef utility::options::BooleanVectorOptionKey	BooleanVectorOptionKey
typedef utility::options::IntegerVectorOptionKey	IntegerVectorOptionKey
typedef utility::options::RealVectorOptionKey	RealVectorOptionKey
typedef utility::options::ResidueChainVectorOptionKey	ResidueChainVectorOptionKey
typedef utility::options::StringVectorOptionKey	StringVectorOptionKey
typedef utility::options::FileVectorOptionKey	FileVectorOptionKey
typedef utility::options::PathVectorOptionKey	PathVectorOptionKey
typedef utility::options::OptionCollection	OptionCollection
typedef utility::options::Option	Option
typedef utility::options::BooleanOption	BooleanOption
typedef utility::options::IntegerOption	IntegerOption
typedef utility::options::RealOption	RealOption
typedef utility::options::StringOption	StringOption
typedef utility::options::FileOption	FileOption
typedef utility::options::PathOption	PathOption
typedef utility::options::BooleanVectorOption	BooleanVectorOption
typedef utility::options::IntegerVectorOption	IntegerVectorOption
typedef utility::options::RealVectorOption	RealVectorOption
typedef utility::options::StringVectorOption	StringVectorOption
typedef utility::options::FileVectorOption	FileVectorOption
typedef utility::options::PathVectorOption	PathVectorOption

Functions
OptionKey const &	key (std::string const &str)
	Get key for an option name. More...
bool	truefalseoption (std::string const &str)
bool	truefalseoption (OptionKey const &key)
double	realafteroption (std::string const &str)
double	realafteroption (std::string const &str, double const opt_default)
void	realafteroption (std::string const &str, double const opt_default, double &rnum)
void	realafteroption (OptionKey const &key, double const opt_default, double &rnum)
void	real2afteroption (std::string const &str, double const default1, double &rnum1, double const default2, double &rnum2)
void	real2afteroption (OptionKey const &key, double const default1, double &rnum1, double const default2, double &rnum2)
void	real3afteroption (std::string const &str, double const default1, double &rnum1, double const default2, double &rnum2, double const default3, double &rnum3)
void	real3afteroption (OptionKey const &key, double const default1, double &rnum1, double const default2, double &rnum2, double const default3, double &rnum3)
int	intafteroption (std::string const &str)
int	intafteroption (std::string const &str, int const opt_default)
void	intafteroption (std::string const &str, int const opt_default, int &inum)
void	intafteroption (OptionKey const &key, int const opt_default, int &inum)
void	optional_positive_intafteroption (std::string const &str, int const opt_default, int &inum)
void	optional_positive_intafteroption (OptionKey const &key, int const opt_default, int &inum)
void	int2afteroption (std::string const &str, int const opt_default, int &inum, int const opt_default2, int &inum2)
void	int2afteroption (OptionKey const &key, int const opt_default, int &inum, int const opt_default2, int &inum2)
std::string	stringafteroption (std::string const &str)
std::string	stringafteroption (std::string const &str, std::string const &opt_default)
void	stringafteroption (std::string const &str, std::string const &opt_default, std::string &cval)
void	stringafteroption (OptionKey const &key, std::string const &opt_default, std::string &cval)
void	stringafteroption (std::string const &str, char const opt_default, char &cval)
void	stringafteroption (OptionKey const &key, char const opt_default, char &cval)
static thread_local basic::Tracer	TR ("basic.options")
int const	silent (0)
	Named verbosity levels. More...
int const	quiet (1)
int const	standard (2)
int const	inform (4)
int const	chat (6)
int const	yap (7)
int const	gush (8)
int const	verbose (9)
OptionCollection &	initialize ()
	Initialize the options. More...
OptionCollection &	process ()
	Process the specified options note Do more complex value setup and checks here than the option system provides. More...
template<typename T , typename K >
T	get_option (std::string const &id)
template<typename T , typename K >
void	set_option (std::string const &id, T const &value)
bool	get_boolean_option (std::string const &id)
int	get_integer_option (std::string const &id)
double	get_real_option (std::string const &id)
std::string	get_string_option (std::string const &id)
std::string	get_file_option (std::string const &id)
void	set_boolean_option (std::string const &id, bool v)
void	set_integer_option (std::string const &id, int v)
void	set_real_option (std::string const &id, double v)
void	set_string_option (std::string const &id, std::string const &v)
void	set_file_option (std::string const &id, std::string const &v)
utility::vector1< bool >	get_boolean_vector_option (std::string const &id)
utility::vector1< int >	get_integer_vector_option (std::string const &id)
utility::vector1< double >	get_real_vector_option (std::string const &id)
utility::vector1< std::string >	get_string_vector_option (std::string const &id)
utility::vector1< std::string >	get_file_vector_option (std::string const &id)
void	set_boolean_vector_option (std::string const &id, utility::vector1< bool > const &v)
void	set_integer_vector_option (std::string const &id, utility::vector1< int > const &v)
void	set_real_vector_option (std::string const &id, utility::vector1< double > const &v)
void	set_string_vector_option (std::string const &id, utility::vector1< std::string > const &v)
void	set_file_vector_option (std::string const &id, utility::vector1< std::string > const &v)
std::string	start_file ()
	kind of like the old -s – just one file More...
utility::vector1< std::string >	start_files ()

Variables
utility::options::OptionCollection	option
	OptionCollection global. More...
int const	silent
	Named verbosity levels. More...
int const	quiet
int const	standard
int const	inform
int const	chat
int const	yap
int const	gush
int const	verbose

Typedef Documentation

typedef utility::options::BooleanOption basic::options::BooleanOption

typedef utility::options::BooleanOptionKey basic::options::BooleanOptionKey

typedef utility::options::BooleanVectorOption basic::options::BooleanVectorOption

typedef utility::options::BooleanVectorOptionKey basic::options::BooleanVectorOptionKey

typedef utility::options::FileOption basic::options::FileOption

typedef utility::options::FileOptionKey basic::options::FileOptionKey

typedef utility::options::FileVectorOption basic::options::FileVectorOption

typedef utility::options::FileVectorOptionKey basic::options::FileVectorOptionKey

typedef utility::options::IntegerOption basic::options::IntegerOption

typedef utility::options::IntegerOptionKey basic::options::IntegerOptionKey

typedef utility::options::IntegerVectorOption basic::options::IntegerVectorOption

typedef utility::options::IntegerVectorOptionKey basic::options::IntegerVectorOptionKey

typedef utility::options::Option basic::options::Option

typedef utility::options::OptionCollection basic::options::OptionCollection

typedef utility::options::OptionKey basic::options::OptionKey

typedef utility::options::PathOption basic::options::PathOption

typedef utility::options::PathOptionKey basic::options::PathOptionKey

typedef utility::options::PathVectorOption basic::options::PathVectorOption

typedef utility::options::PathVectorOptionKey basic::options::PathVectorOptionKey

typedef utility::options::RealOption basic::options::RealOption

typedef utility::options::RealOptionKey basic::options::RealOptionKey

typedef utility::options::RealVectorOption basic::options::RealVectorOption

typedef utility::options::RealVectorOptionKey basic::options::RealVectorOptionKey

typedef utility::options::ResidueChainVectorOptionKey basic::options::ResidueChainVectorOptionKey

typedef utility::options::StringOption basic::options::StringOption

typedef utility::options::StringOptionKey basic::options::StringOptionKey

typedef utility::options::StringVectorOption basic::options::StringVectorOption

typedef utility::options::StringVectorOptionKey basic::options::StringVectorOptionKey

Function Documentation

int const basic::options::chat

(

6

)

bool basic::options::get_boolean_option

(

std::string const &

id

)

utility::vector1< bool > basic::options::get_boolean_vector_option

(

std::string const &

id

)

std::string basic::options::get_file_option

(

std::string const &

id

)

utility::vector1< std::string > basic::options::get_file_vector_option

(

std::string const &

id

)

int basic::options::get_integer_option

(

std::string const &

id

)

utility::vector1< int > basic::options::get_integer_vector_option

(

std::string const &

id

)

template<typename T , typename K >

T basic::options::get_option

(

std::string const &

id

)

References utility::options::OptionKeys::has, utility::options::OptionKeys::key, option, utility_exit_with_message, and value.

double basic::options::get_real_option

(

std::string const &

id

)

utility::vector1< double > basic::options::get_real_vector_option

(

std::string const &

id

)

std::string basic::options::get_string_option

(

std::string const &

id

)

utility::vector1< std::string > basic::options::get_string_vector_option

(

std::string const &

id

)

int const basic::options::gush

(

8

)

int const basic::options::inform

(

4

)

OptionCollection & basic::options::initialize

(

)

Initialize the options.

References utility::options::OptionCollection::add_built_in_options(), utility::io::oc::cerr, utility::options::OptionCollection::check_specs(), utility::io::ocstream::flush(), option, and options.

void basic::options::int2afteroption	(	std::string const &	str,
		int const	opt_default,
		int &	inum,
		int const	opt_default2,
		int &	inum2
	)

References key().

void basic::options::int2afteroption	(	OptionKey const &	key,
		int const	opt_default,
		int &	inum,
		int const	opt_default2,
		int &	inum2
	)

References utility::io::oc::cerr, utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, utility::options::OptionCollection::option(), utility::options::VectorOption_T_< K, T >::size(), utility::options::OptionKeys::options::user, and utility_exit.

int basic::options::intafteroption

(

std::string const &

str

)

References utility::io::oc::cout, key(), truefalseoption(), and utility_exit.

Referenced by intafteroption().

int basic::options::intafteroption	(	std::string const &	str,
		int const	opt_default
	)

References intafteroption(), and key().

void basic::options::intafteroption	(	std::string const &	str,
		int const	opt_default,
		int &	inum
	)

References intafteroption(), and key().

void basic::options::intafteroption	(	OptionKey const &	key,
		int const	opt_default,
		int &	inum
	)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), key(), option, utility::options::OptionCollection::option(), and utility::options::OptionKeys::options::user.

OptionKey const& basic::options::key

(

std::string const &

str

)

Get key for an option name.

References utility::options::OptionCollection::find_key_cl(), and basic::options::OptionKeys::key.

Referenced by int2afteroption(), intafteroption(), optional_positive_intafteroption(), real2afteroption(), real3afteroption(), realafteroption(), stringafteroption(), and truefalseoption().

void basic::options::optional_positive_intafteroption	(	std::string const &	str,
		int const	opt_default,
		int &	inum
	)

References key().

void basic::options::optional_positive_intafteroption	(	OptionKey const &	key,
		int const	opt_default,
		int &	inum
	)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, utility::options::OptionCollection::option(), utility::options::VectorOption_T_< K, T >::size(), and utility::options::OptionKeys::options::user.

OptionCollection & basic::options::process

(

)

Process the specified options note Do more complex value setup and checks here than the option system provides.

Process the specified options.

References option, options, and TR().

int const basic::options::quiet

(

1

)

void basic::options::real2afteroption	(	std::string const &	str,
		double const	default1,
		double &	rnum1,
		double const	default2,
		double &	rnum2
	)

References key().

void basic::options::real2afteroption	(	OptionKey const &	key,
		double const	default1,
		double &	rnum1,
		double const	default2,
		double &	rnum2
	)

References utility::io::oc::cerr, utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, utility::options::OptionCollection::option(), utility::options::VectorOption_T_< K, T >::size(), utility::options::OptionKeys::options::user, and utility_exit.

void basic::options::real3afteroption	(	std::string const &	str,
		double const	default1,
		double &	rnum1,
		double const	default2,
		double &	rnum2,
		double const	default3,
		double &	rnum3
	)

References key().

void basic::options::real3afteroption	(	OptionKey const &	key,
		double const	default1,
		double &	rnum1,
		double const	default2,
		double &	rnum2,
		double const	default3,
		double &	rnum3
	)

References utility::io::oc::cerr, utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, utility::options::OptionCollection::option(), utility::options::VectorOption_T_< K, T >::size(), utility::options::OptionKeys::options::user, and utility_exit.

double basic::options::realafteroption

(

std::string const &

str

)

References utility::io::oc::cerr, truefalseoption(), and utility_exit.

Referenced by realafteroption().

double basic::options::realafteroption	(	std::string const &	str,
		double const	opt_default
	)

References key(), realafteroption(), and value.

void basic::options::realafteroption	(	std::string const &	str,
		double const	opt_default,
		double &	rnum
	)

References key(), and realafteroption().

void basic::options::realafteroption	(	OptionKey const &	key,
		double const	opt_default,
		double &	rnum
	)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), key(), option, utility::options::OptionCollection::option(), and utility::options::OptionKeys::options::user.

void basic::options::set_boolean_option	(	std::string const &	id,
		bool	v
	)

void basic::options::set_boolean_vector_option	(	std::string const &	id,
		utility::vector1< bool > const &	v
	)

void basic::options::set_file_option	(	std::string const &	id,
		std::string const &	v
	)

void basic::options::set_file_vector_option	(	std::string const &	id,
		utility::vector1< std::string > const &	v
	)

void basic::options::set_integer_option	(	std::string const &	id,
		int	v
	)

void basic::options::set_integer_vector_option	(	std::string const &	id,
		utility::vector1< int > const &	v
	)

template<typename T , typename K >

void basic::options::set_option	(	std::string const &	id,
		T const &	value
	)

References utility::options::OptionKeys::has, utility::options::OptionKeys::key, option, utility_exit_with_message, and value.

void basic::options::set_real_option	(	std::string const &	id,
		double	v
	)

void basic::options::set_real_vector_option	(	std::string const &	id,
		utility::vector1< double > const &	v
	)

void basic::options::set_string_option	(	std::string const &	id,
		std::string const &	v
	)

void basic::options::set_string_vector_option	(	std::string const &	id,
		utility::vector1< std::string > const &	v
	)

int const basic::options::silent

(

0

)

Named verbosity levels.

int const basic::options::standard

(

2

)

std::string basic::options::start_file

(

)

kind of like the old -s – just one file

convenience functions

References runtime_assert, and start_files().

utility::vector1< std::string > basic::options::start_files

(

)

Retrieve all files specified using -l or -s NOTE:: will die if neither option is used!

References utility::io::izstream::close(), utility::io::izstream::getline(), utility::io::izstream::good(), name, option, basic::T(), utility::options::OptionKeys::options::user, utility_exit, and utility_exit_with_message.

Referenced by start_file().

std::string basic::options::stringafteroption

(

std::string const &

str

)

References utility::io::oc::cout, key(), truefalseoption(), and utility_exit.

Referenced by stringafteroption().

std::string basic::options::stringafteroption	(	std::string const &	str,
		std::string const &	opt_default
	)

References key(), and stringafteroption().

void basic::options::stringafteroption	(	std::string const &	str,
		std::string const &	opt_default,
		std::string &	cval
	)

References key(), and stringafteroption().

void basic::options::stringafteroption	(	OptionKey const &	key,
		std::string const &	opt_default,
		std::string &	cval
	)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), key(), option, utility::options::OptionCollection::option(), and utility::options::OptionKeys::options::user.

void basic::options::stringafteroption	(	std::string const &	str,
		char const	opt_default,
		char &	cval
	)

References key(), and stringafteroption().

void basic::options::stringafteroption	(	OptionKey const &	key,
		char const	opt_default,
		char &	cval
	)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, utility::options::OptionCollection::option(), and utility::options::OptionKeys::options::user.

static thread_local basic::Tracer basic::options::TR ( "basic.options"  )

static

Referenced by process().

bool basic::options::truefalseoption

(

std::string const &

str

)

References key().

Referenced by intafteroption(), realafteroption(), and stringafteroption().

bool basic::options::truefalseoption

(

OptionKey const &

key

)

References utility::io::oc::cout, utility::keys::AutoKey< O, S, C >::id(), option, and utility::options::OptionKeys::options::user.

int const basic::options::verbose

(

9

)

int const basic::options::yap

(

7

)

Variable Documentation

int const basic::options::chat

int const basic::options::gush

int const basic::options::inform

OptionCollection basic::options::option

OptionCollection global.

OptionCollection global

Referenced by basic::ComparingTracer::ComparingTracer(), get_option(), initialize(), int2afteroption(), intafteroption(), optional_positive_intafteroption(), process(), basic::prof_start_function_body(), basic::prof_stop_function_body(), real2afteroption(), real3afteroption(), realafteroption(), set_option(), start_files(), stringafteroption(), and truefalseoption().

int const basic::options::quiet

int const basic::options::silent

Named verbosity levels.

int const basic::options::standard

int const basic::options::verbose

int const basic::options::yap