utility::options Namespace Reference

Namespaces
	OptionKeys

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

Typedefs
typedef std::list< keys::VariantKey< OptionKey > >	OptionKeyList
typedef utility::pointer::shared_ptr< OptionCollection >	OptionCollectionOP
typedef utility::pointer::shared_ptr< OptionCollection const >	OptionCollectionCOP

Enumerations
enum	OptionTypes {   UNKNOWN_OPTION , BOOLEAN_OPTION , INTEGER_OPTION , REAL_OPTION ,   STRING_OPTION , FILE_OPTION , PATH_OPTION , ANY_OPTION ,   BOOLEAN_VECTOR_OPTION , INTEGER_VECTOR_OPTION , REAL_VECTOR_OPTION , RESIDUE_CHAIN_VECTOR_OPTION ,   STRING_VECTOR_OPTION , FILE_VECTOR_OPTION , PATH_VECTOR_OPTION , ANY_VECTOR_OPTION }
	Option types enumeration. More...

Functions
OptionKeyList &	operator+ (OptionKeyList &key_list, BooleanOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, IntegerOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, RealOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, StringOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, FileOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, PathOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, BooleanVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, IntegerVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, RealVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, StringVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, FileVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, PathVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
OptionKeyList &	operator+ (OptionKeyList &key_list, ResidueChainVectorOptionKey const &key)
	Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+". More...
void	mpi_safe_std_err (std::string const &msg)
bool	operator< (Option const &a, Option const &b)
	Option < Option. More...
void	std_exit_wrapper (const int error_code)
bool	is_not_ascii (char C)
	Utility function to return true if a character isn't a standard ASCII one. This is a bit more general, as it also returns true if the character is a (non-space) non-printing ASCII one. More...
bool	has_non_ascii (std::string const &str)
	Utility function which returns true if the string contains a non-ASCII value. More...
std::string::size_type	non_ascii_pos (std::string const &str)
	Utility function to return the position of the first non-ASCII value in the string. The return value is 1-indexed. More...
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...

Typedef Documentation

OptionCollectionCOP

typedef utility::pointer::shared_ptr< OptionCollection const > utility::options::OptionCollectionCOP

OptionCollectionOP

typedef utility::pointer::shared_ptr< OptionCollection > utility::options::OptionCollectionOP

OptionKeyList

typedef std::list< keys::VariantKey< OptionKey > > utility::options::OptionKeyList

Enumeration Type Documentation

OptionTypes

enum utility::options::OptionTypes

Option types enumeration.

Enumerator
UNKNOWN_OPTION
BOOLEAN_OPTION
INTEGER_OPTION
REAL_OPTION
STRING_OPTION
FILE_OPTION
PATH_OPTION
ANY_OPTION
BOOLEAN_VECTOR_OPTION
INTEGER_VECTOR_OPTION
REAL_VECTOR_OPTION
RESIDUE_CHAIN_VECTOR_OPTION
STRING_VECTOR_OPTION
FILE_VECTOR_OPTION
PATH_VECTOR_OPTION
ANY_VECTOR_OPTION

Function Documentation

has_non_ascii()

bool utility::options::has_non_ascii ( std::string const &  str )

inline

Utility function which returns true if the string contains a non-ASCII value.

References is_not_ascii(), and str().

Referenced by utility::options::OptionCollection::load_option_cl(), utility::options::OptionCollection::load_option_file(), utility::options::OptionCollection::load_options_from_stream(), utility::options::OptionCollection::set_option_value_cl(), and utility::options::OptionCollection::set_option_value_file().

is_not_ascii()

bool utility::options::is_not_ascii ( char  C )

inline

Utility function to return true if a character isn't a standard ASCII one. This is a bit more general, as it also returns true if the character is a (non-space) non-printing ASCII one.

Referenced by has_non_ascii(), utility::options::OptionCollection::load(), and non_ascii_pos().

mpi_safe_std_err()

void utility::options::mpi_safe_std_err

(

std::string const &

msg

)

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

Referenced by utility::options::ScalarOption_T_< K, T >::cl_value(), utility::options::ScalarOption_T_< K, T >::legal_check(), utility::options::ScalarOption_T_< K, T >::legal_report(), utility::options::ScalarOption_T_< K, T >::specified_report(), and utility::options::IntegerOption::value_of().

non_ascii_pos()

std::string::size_type utility::options::non_ascii_pos ( std::string const &  str )

inline

Utility function to return the position of the first non-ASCII value in the string. The return value is 1-indexed.

References create_a3b_hbs::ii, is_not_ascii(), and str().

Referenced by utility::options::OptionCollection::load_option_cl(), utility::options::OptionCollection::load_option_file(), and utility::options::OptionCollection::load_options_from_stream().

operator+() [1/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		BooleanOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

For example if you have to add the option keys packing::ex1, packing::ex2, packing::ex3 and packing::ex4 to a list of option keys named optlist, then you can write:

using namespace basic::options::OptionKeys::packing;
optlist + ex1 + ex2 + ex3 + ex4; 

References subloop_histogram::key.

operator+() [2/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		BooleanVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [3/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		FileOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [4/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		FileVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [5/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		IntegerOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [6/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		IntegerVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [7/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		PathOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [8/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		PathVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [9/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		RealOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [10/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		RealVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [11/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		ResidueChainVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [12/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		StringOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [13/16]

OptionKeyList & utility::options::operator+	(	OptionKeyList &	key_list,
		StringVectorOptionKey const &	key
	)

Convenience function for appending an option key to an option key list (which itself is a list of pointers to OptionKeys, using the VariantKey class) so that many option keys can be appended by simply chaining a set of calls using "+".

References subloop_histogram::key.

operator+() [14/16]

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

std::string + StringOption

operator+() [15/16]

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

StringOption + std::string.

operator+() [16/16]

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

StringOption + StringOption.

operator<() [1/2]

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

Option < Option.

Note

Key-based ordering

Needed for use as option in associative containers

operator<() [2/2]

template<typename O >

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

VariantOption < VariantOption.

operator<<()

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

Output to stream.

show_accessed_options_T()

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 cal_vdw_radius_pool::buf, test.T009_Exceptions::e, create_a3b_hbs::i, utility::options::Option::id(), and utility::options::Option::is_been_accessed().

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

show_unused_options_T()

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 cal_vdw_radius_pool::buf, test.T009_Exceptions::e, create_a3b_hbs::i, 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().

std_exit_wrapper()

void utility::options::std_exit_wrapper

(

const int

error_code

)

References CREATE_EXCEPTION, and utility::options::OptionKeys::options::exit.

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