Rosetta 3.3
Namespaces | Classes | Functions
utility::options Namespace Reference

Program options system. More...

Namespaces

namespace  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  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  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...

Functions

void mpi_safe_std_err (std::string msg)
bool operator< (Option const &a, Option const &b)
 Option < Option.
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.
std::ostream & operator<< (std::ostream &stream, OptionCollection const &options)
 Output to stream.
std::string operator+ (StringOption const &option1, StringOption const &option2)
 StringOption + StringOption.
std::string operator+ (StringOption const &option, std::string const &s)
 StringOption + std::string.
std::string operator+ (std::string const &s, StringOption const &option)
 std::string + StringOption
template<typename O >
bool operator< (VariantOption< O > const &a, VariantOption< O > const &b)
 VariantOption < VariantOption.

Detailed Description

Program options system.

The utility::options package provides a system for representing and accessing the value of program options. This system is designed to have syntactic and type convenience and to be "pluggable", allowing optional modules to add their own options. Options are accessed by named keys (see the options::keys package) which provides a high level of type safety and fast lookup.

Introduction

Options are specified to applications in the usual ways with options entered directly on the command line or in files specified on the command line:

application -option1 -option2=value2


Function Documentation

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

std::string + StringOption

References option.

std::string utility::options::operator+ ( StringOption const &  option1,
StringOption const &  option2 
)
std::string utility::options::operator+ ( StringOption const &  option,
std::string const &  s 
)
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 ( i,
e,
std::vector< std::string > &  sv 
)

Local helper function for implementing show_accessed_options.

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

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

void utility::options::std_exit_wrapper ( const int  error_code)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines