utility::options Namespace Reference

Namespaces
	OptionKeys

Classes
class	AnyOption
	Program any scalar-valued option abstract base class. More...
class	AnyOptionKey
	Automatic hidden index key for any scalar-valued options. More...
class	AnyVectorOption
	Program any vector-valued option abstract base class. More...
class	AnyVectorOptionKey
	Automatic hidden index key for any vector-valued options. More...
class	BooleanOption
	Program boolean option class. More...
class	BooleanOptionKey
	Automatic hidden index key for boolean options. More...
class	BooleanVectorOption
	Program boolean vector option class. More...
class	BooleanVectorOptionKey
	Automatic hidden index key for boolean options. More...
class	FileOption
	Program file option class. More...
class	FileOptionKey
	Automatic hidden index key for file options. More...
class	FileVectorOption
	Program file vector option class. More...
class	FileVectorOptionKey
	Automatic hidden index key for file options. More...
class	IntegerOption
	Program integer option class. More...
class	IntegerOptionKey
	Automatic hidden index key for integer options. More...
class	IntegerVectorOption
	Program integer vector option class. More...
class	IntegerVectorOptionKey
	Automatic hidden index key for integer options. More...
class	Option
	Program option interface class. More...
class	OptionCollection
	Program options collection. More...
class	OptionKey
	Abstract automatic hidden index key for options. More...
class	PathOption
	Program path option class. More...
class	PathOptionKey
	Automatic hidden index key for path options. More...
class	PathVectorOption
	Program path vector option class. More...
class	PathVectorOptionKey
	Automatic hidden index key for path options. More...
class	RealOption
	Program real option class. More...
class	RealOptionKey
	Automatic hidden index key for real options. More...
class	RealVectorOption
	Program real vector option class. More...
class	RealVectorOptionKey
	Automatic hidden index key for real options. More...
class	ResidueChainVectorOption
	Program integer vector option class. More...
class	ResidueChainVectorOptionKey
	Automatic hidden index key for integer options. More...
class	ScalarOption
	Program scalar-valued option interface class. More...
class	ScalarOption_T_
	Program scalar-valued option abstract base class. More...
class	ScalarOptionKey
	Abstract automatic hidden index key for scalar-valued options. More...
class	StringOption
	Program string option class. More...
class	StringOptionKey
	Automatic hidden index key for string options. More...
class	StringVectorOption
	Program string option class. More...
class	StringVectorOptionKey
	Automatic hidden index key for string options. More...
class	VariantOption
	Variant option class. More...
class	VectorOption
	Program vector-valued option interface class. More...
class	VectorOption_T_
	Program vector-valued option abstract base class. More...
class	VectorOptionKey
	Abstract automatic hidden index key for vector-valued options. More...

Functions
void	mpi_safe_std_err (std::string msg)
bool	operator< (Option const &a, Option const &b)
	Option < Option. More...
void	std_exit_wrapper (const int error_code)
template<class T >
void	show_accessed_options_T (T i, T e, std::vector< std::string > &sv)
	Local helper function for implementing show_accessed_options. More...
template<class T >
void	show_unused_options_T (T i, T e, std::vector< std::string > &sv)
	Local helper function for implementing show_unused_options. More...
std::ostream &	operator<< (std::ostream &stream, OptionCollection const &options)
	Output to stream. More...
std::string	operator+ (StringOption const &option1, StringOption const &option2)
	StringOption + StringOption. More...
std::string	operator+ (StringOption const &option, std::string const &s)
	StringOption + std::string. More...
std::string	operator+ (std::string const &s, StringOption const &option)
	std::string + StringOption More...
template<typename O >
bool	operator< (VariantOption< O > const &a, VariantOption< O > const &b)
	VariantOption < VariantOption. More...

Function Documentation

void utility::options::mpi_safe_std_err

(

std::string

msg

)

References utility::io::oc::cerr, utility::io::ocstream::flush(), and utility::mpi_rank().

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::cl_value(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_check(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_report(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::specified_report(), and utility::options::IntegerOption::value_of().

std::string utility::options::operator+	(	StringOption const &	option1,
		StringOption const &	option2
	)

StringOption + StringOption.

std::string utility::options::operator+	(	StringOption const &	option,
		std::string const &	s
	)

StringOption + std::string.

References option.

std::string utility::options::operator+	(	std::string const &	s,
		StringOption const &	option
	)

std::string + StringOption

References option.

template<typename O >

bool utility::options::operator<	(	VariantOption< O > const &	a,
		VariantOption< O > const &	b
	)

VariantOption < VariantOption.

References runtime_assert.

bool utility::options::operator<	(	Option const &	a,
		Option const &	b
	)

Option < Option.

Note

Key-based ordering

Needed for use as option in associative containers

References utility::options::Option::key().

std::ostream& utility::options::operator<<	(	std::ostream &	stream,
		OptionCollection const &	options
	)

Output to stream.

References utility::options::OptionKeys::begin, utility::options::OptionKeys::end, utility::options::OptionCollection::has(), utility::options::Option::id(), basic::options::OptionKeys::key, and utility::options::OptionCollection::option().

template<class T >

void utility::options::show_accessed_options_T	(	T	i,
		T	e,
		std::vector< std::string > &	sv
	)

Local helper function for implementing show_accessed_options.

References utility::options::Option::id(), and utility::options::Option::is_been_accessed().

Referenced by utility::options::OptionCollection::show_accessed_options().

template<class T >

void utility::options::show_unused_options_T	(	T	i,
		T	e,
		std::vector< std::string > &	sv
	)

Local helper function for implementing show_unused_options.

References utility::options::Option::id(), utility::options::Option::is_been_accessed(), utility::options::Option::is_group(), utility::options::Option::set_accessed(), utility::options::Option::user(), and utility::options::Option::value_string().

Referenced by utility::options::OptionCollection::show_unused_options().

void utility::options::std_exit_wrapper

(

const int

error_code

)

References utility::options::OptionKeys::options::exit.

Referenced by utility::options::OptionCollection::check_specs(), utility::options::OptionCollection::check_values(), and utility::options::OptionCollection::load().