Rosetta 3.3
Namespaces | Typedefs | Functions | Variables
basic::options Namespace Reference

Namespaces

namespace  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::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.
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)
int const silent (0)
 Named verbosity levels.
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)
OptionCollectioninitialize ()
 Initialize the options.
OptionCollectionprocess ()
 Process the specified options note Do more complex value setup and checks here than the option system provides.
template<typename T , typename K >
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)
utility::vector1< boolget_boolean_vector_option (std::string const &id)
utility::vector1< intget_integer_vector_option (std::string const &id)
utility::vector1< doubleget_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)
std::string start_file ()
 kind of like the old -s -- just one file
utility::vector1< std::string > start_files ()

Variables

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

Typedef Documentation


Function Documentation

int const basic::options::chat ( )
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)
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 ( )
int const basic::options::inform ( )
OptionCollection & basic::options::initialize ( )
void basic::options::int2afteroption ( OptionKey const &  key,
int const  opt_default,
int inum,
int const  opt_default2,
int inum2 
)
void basic::options::int2afteroption ( std::string const &  str,
int const  opt_default,
int inum,
int const  opt_default2,
int inum2 
)

References key().

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

References intafteroption(), and key().

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

References intafteroption(), and key().

void basic::options::intafteroption ( OptionKey const &  key,
int const  opt_default,
int inum 
)
OptionKey const& basic::options::key ( std::string const &  str)
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 
)
OptionCollection & basic::options::process ( )
int const basic::options::quiet ( )
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 
)
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 
)
double basic::options::realafteroption ( std::string const &  str)
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 
)
template<typename T , typename K >
void basic::options::set_option ( std::string const &  id,
T const &  value 
)
int const basic::options::silent ( )

Named verbosity levels.

std::string basic::options::start_file ( )

kind of like the old -s -- just one file

convenience functions

References sd::files, runtime_assert, and start_files().

Referenced by main(), run_pep_prep(), and RunPepSpec().

utility::vector1< std::string > basic::options::start_files ( )
void basic::options::stringafteroption ( std::string const &  str,
char const  opt_default,
char &  cval 
)

References key(), and 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().

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

References key().

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

int const basic::options::yap ( )

Variable Documentation

Named verbosity levels.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines