Rosetta  2019.22
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Namespaces | Classes | Typedefs | Enumerations | Functions
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...
 

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

OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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...
 
OptionKeyListoperator+ (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)
 
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

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

Enumeration Type Documentation

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

void utility::options::mpi_safe_std_err ( std::string const &  msg)
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;  
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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

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 "+".

std::string utility::options::operator+ ( StringOption const &  option1,
StringOption const &  option2 
)
std::string utility::options::operator+ ( StringOption const &  option,
std::string const &  s 
)
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 
)
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 
)
template<class T >
void utility::options::show_accessed_options_T ( T  i,
T  e,
std::vector< std::string > &  sv 
)
template<class T >
void utility::options::show_unused_options_T ( T  i,
T  e,
std::vector< std::string > &  sv 
)
void utility::options::std_exit_wrapper ( const int  error_code)