Program options collection. More...
#include <OptionCollection.hh>
Public Member Functions inherited from Static Public Member Functions | |
| static std::string | space_prefixed (std::string const &s, int const n=1) |
| Space-prefixed string except blank if string is empty. More... | |
| static std::string | tab_prefixed (std::string const &s, int const n=1) |
| Tab-prefixed string except blank if string is empty. More... | |
| static void | check_key (OptionKey const &key) |
| Check that a key's identifiers are legal. More... | |
| static void | check_key (Option const &option) |
| Check that an option's identifiers are legal. More... | |
| static std::string | lower_no_under (std::string const &instring) |
| Remove underscores and lowercase string. More... | |
| static void | add_edits (std::set< std::string > &items) |
| Add to the set possible typos for a given word. More... | |
| static std::string | find_key_file (std::string const &key_string, std::string const &cid, bool const top) |
| static std::string::size_type | n_part (std::string const &s) |
| Number of parts in an option id. More... | |
| static std::string::size_type | n_part_prefix_match (std::string const &s, std::string const &t) |
| Number of prefix parts of two ids that match. More... | |
| static std::string | prefix (std::string const &s, int const n=1) |
| Prefix of an option id with a specified number of parts. More... | |
| static std::string | suffix (std::string const &s, int const n=1) |
| Suffix of an option id with a specified number of parts. More... | |
| static std::string & | trim (std::string &s, int const n=1) |
| Trim a specified number of parts from the suffix of an option id. More... | |
| static std::string | trimmed (std::string const &s, int const n=1) |
| Prefix of an option id with a specified number of suffix parts removed. More... | |
| static std::string | cleaned (std::string const &s) |
| Cleaned option id with repeat colons condensed. More... | |
| static std::string | merged (std::string const &s, std::string const &t) |
| Merged option ids with the minimal suffix-prefix overlap, if any, removed. More... | |
| static std::string | wrapped (std::string const &s, std::string::size_type indent=10, std::string::size_type width=80, std::string const &header_for_extra_lines="") |
| String wrapped and indented. More... | |
Private Member Functions | |
| void | load_option_cl (std::string const &arg_string, ValueStrings &arg_strings, std::string const &pid) |
| Load a user-specified option argument from a command line. More... | |
| void | load_option_from_file (std::string const &arg_string, ValueStrings &arg_strings, std::string const &pid) |
| Load one option from user specified file. More... | |
| void | load_option_file (std::string const &arg_string, ValueStrings &val_strings, std::string &cid, bool const cl_context=false) |
| void | set_option_value_cl (std::string const &key_id, ValueStrings &arg_strings) |
| Set a user-specified option value from a command line. More... | |
| void | set_option_value_file (std::string const &key_id, ValueStrings &val_strings) |
Private Attributes | |
| Booleans | booleans_ |
| Boolean options. More... | |
| Integers | integers_ |
| Integer options. More... | |
| Reals | reals_ |
| Real options. More... | |
| Strings | strings_ |
| String options. More... | |
| Files | files_ |
| File options. More... | |
| Paths | paths_ |
| Path options. More... | |
| Anys | anys_ |
| Any value type options. More... | |
| BooleanVectors | boolean_vectors_ |
| Boolean vector options. More... | |
| IntegerVectors | integer_vectors_ |
| Integer vector options. More... | |
| RealVectors | real_vectors_ |
| Real vector options. More... | |
| ResidueChainVectors | residue_chain_vectors_ |
| Residue/chain vector options. More... | |
| StringVectors | string_vectors_ |
| String vector options. More... | |
| FileVectors | file_vectors_ |
| File vector options. More... | |
| PathVectors | path_vectors_ |
| Path vector options. More... | |
| AnyVectors | any_vectors_ |
| Any value type vector options. More... | |
| All | all_ |
| All options (non-owning pointers) More... | |
| std::vector< OptionKey const * > | relevant_ |
| List of application-relevant options. More... | |
| std::string | argv_copy_ |
| keep a copy of argv around in case people want to get at it elsewhere in the code. More... | |
| bool | show_accessed_options_ = false |
| Flag indicating that list of accessed option should be printed when destructor of OptionCollection is called. This flag is false by default. More... | |
| bool | show_unused_options_ = false |
| Flag indicating that list of user specified but inaccessed options should be printed when destructor of OptionCollection is called. This flag is false by default. More... | |
Friends | |
| std::ostream & | operator<< (std::ostream &stream, OptionCollection const &options) |
| Output to stream. More... | |
Detailed Description
Program options collection.
Member Typedef Documentation
◆ All
|
private |
◆ Anys
|
private |
◆ AnyVectors
|
private |
◆ Booleans
|
private |
◆ BooleanVectors
|
private |
◆ Files
|
private |
◆ FileVectors
|
private |
◆ Integers
|
private |
◆ IntegerVectors
|
private |
◆ Paths
|
private |
◆ PathVectors
|
private |
◆ Reals
|
private |
◆ RealVectors
|
private |
◆ ResidueChainVectors
|
private |
◆ Strings
|
private |
◆ StringVectors
|
private |
◆ ValueStrings
|
private |
Constructor & Destructor Documentation
◆ OptionCollection() [1/2]
|
inline |
Default constructor.
◆ OptionCollection() [2/2]
| utility::options::OptionCollection::OptionCollection | ( | OptionCollection const & | src | ) |
Copy constructor.
Needed because the mutex can't be copied.
◆ ~OptionCollection()
|
override |
Destructor.
References utility::io::oc::cout, show_accessed_options(), show_accessed_options_, show_unused_options(), and show_unused_options_.
Member Function Documentation
◆ add() [1/28]
|
inline |
Add an AnyOption.
References all_, utility::options::ANY_OPTION, anys_, check_key(), and utility::options::ScalarOption_T_< K, T >::key().
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [2/28]
|
inline |
Add an AnyVectorOption.
References all_, utility::options::ANY_VECTOR_OPTION, any_vectors_, check_key(), and utility::options::VectorOption_T_< K, T >::key().
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [3/28]
|
inline |
Add a BooleanOption.
References all_, utility::options::BOOLEAN_OPTION, booleans_, check_key(), and utility::options::ScalarOption_T_< K, T >::key().
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [4/28]
|
inline |
Add a BooleanOption.
References all_, utility::options::BOOLEAN_OPTION, booleans_, check_key(), and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), add_built_in_options(), add_my_options(), pyrosetta.bindings.pose.ResidueLabelAccessor::discard(), main(), and register_options().
◆ add() [5/28]
|
inline |
◆ add() [6/28]
|
inline |
Add a BooleanVectorOption.
References all_, utility::options::BOOLEAN_VECTOR_OPTION, boolean_vectors_, check_key(), and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [7/28]
|
inline |
Add a FileOption.
References all_, check_key(), utility::options::FILE_OPTION, files_, and utility::options::ScalarOption_T_< K, T >::key().
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [8/28]
|
inline |
Add a FileOption.
References all_, check_key(), utility::options::FILE_OPTION, files_, and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [9/28]
|
inline |
◆ add() [10/28]
|
inline |
Add a FileVectorOption.
References all_, check_key(), utility::options::FILE_VECTOR_OPTION, file_vectors_, and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [11/28]
|
inline |
Add an IntegerOption.
References all_, check_key(), utility::options::INTEGER_OPTION, integers_, and utility::options::ScalarOption_T_< K, T >::key().
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [12/28]
|
inline |
Add an IntegerOption.
References all_, check_key(), utility::options::INTEGER_OPTION, integers_, and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [13/28]
|
inline |
◆ add() [14/28]
|
inline |
Add an IntegerVectorOption.
References all_, check_key(), utility::options::INTEGER_VECTOR_OPTION, integer_vectors_, and subloop_histogram::key.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [15/28]
|
inline |
Add a PathOption.
References all_, check_key(), utility::options::ScalarOption_T_< K, T >::key(), utility::options::PATH_OPTION, and paths_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [16/28]
|
inline |
Add a PathOption.
References all_, check_key(), subloop_histogram::key, utility::options::PATH_OPTION, and paths_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [17/28]
|
inline |
◆ add() [18/28]
|
inline |
Add a PathVectorOption.
References all_, check_key(), subloop_histogram::key, utility::options::PATH_VECTOR_OPTION, and path_vectors_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [19/28]
|
inline |
Add a RealOption.
References all_, check_key(), utility::options::ScalarOption_T_< K, T >::key(), utility::options::REAL_OPTION, and reals_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [20/28]
|
inline |
Add a RealOption.
References all_, check_key(), subloop_histogram::key, utility::options::REAL_OPTION, and reals_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [21/28]
|
inline |
◆ add() [22/28]
|
inline |
Add a RealVectorOption.
References all_, check_key(), subloop_histogram::key, utility::options::REAL_VECTOR_OPTION, and real_vectors_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [23/28]
|
inline |
Add an ResidueChainVectorOption.
References all_, check_key(), utility::options::VectorOption_T_< K, T >::key(), utility::options::RESIDUE_CHAIN_VECTOR_OPTION, and residue_chain_vectors_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [24/28]
|
inline |
◆ add() [25/28]
|
inline |
Add a StringOption.
References all_, check_key(), utility::options::ScalarOption_T_< K, T >::key(), utility::options::STRING_OPTION, and strings_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [26/28]
|
inline |
Add a StringOption.
References all_, check_key(), subloop_histogram::key, utility::options::STRING_OPTION, and strings_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add() [27/28]
|
inline |
◆ add() [28/28]
|
inline |
Add a StringVectorOption.
References all_, check_key(), subloop_histogram::key, utility::options::STRING_VECTOR_OPTION, and string_vectors_.
Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().
◆ add_built_in_options()
| void utility::options::OptionCollection::add_built_in_options | ( | ) |
Add the built-in options.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References add(), all, check_specs(), utility::options::ScalarOption_T_< K, T >::def(), utility::options::OptionKeys::options::exit, enumerate_junctions::help, utility::options::ScalarOption_T_< K, T >::legal(), options, utility::options::OptionKeys::options::table::table, utility::options::OptionKeys::options::table::text, basic::options::OptionKeys::inout::dbms::user, and utility::options::OptionKeys::options::table::Wiki.
Referenced by basic::options::initialize().
◆ add_edits()
|
static |
Add to the set possible typos for a given word.
These are strings with Levenshtein distance of 1
- Based off of the approach from http://norvig.com/spell-correct.html
References create_a3b_hbs::ii, beta_nonlocal::jj, and transposed().
Referenced by find_key_cl().
◆ add_relevant()
|
inline |
add OptionKey to list of application relevant options
References subloop_histogram::key, and relevant_.
Referenced by main(), and register_options().
◆ check_key() [1/2]
|
static |
Check that an option's identifiers are legal.
References utility::options::ScalarOption_T_< K, T >::code(), CREATE_EXCEPTION, utility::options::ScalarOption_T_< K, T >::id(), utility::options::ScalarOption_T_< K, T >::identifier(), ObjexxFCL::is_double(), option(), and suffix().
◆ check_key() [2/2]
|
static |
Check that a key's identifiers are legal.
References CREATE_EXCEPTION, ObjexxFCL::is_double(), subloop_histogram::key, and suffix().
Referenced by add().
◆ check_specs()
| void utility::options::OptionCollection::check_specs | ( | ) | const |
Check for problems in the option specifications.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References begin, test.T009_Exceptions::e, end, closure_error::error, has(), create_a3b_hbs::i, subloop_histogram::key, option(), and utility::options::std_exit_wrapper().
Referenced by add_built_in_options(), and basic::options::initialize().
◆ check_values()
| void utility::options::OptionCollection::check_values | ( | ) | const |
Check for problems in the option values.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References begin, test.T009_Exceptions::e, end, closure_error::error, has(), create_a3b_hbs::i, subloop_histogram::key, option(), and utility::options::std_exit_wrapper().
Referenced by load().
◆ cleaned()
|
static |
Cleaned option id with repeat colons condensed.
References test.T009_Exceptions::e, create_a3b_hbs::i, docking::s, and predPRE::t.
Referenced by load_option_cl(), load_option_file(), and merged().
◆ clone()
|
inline |
◆ find_key_cl()
| std::string utility::options::OptionCollection::find_key_cl | ( | std::string const & | key_string, |
| std::string const & | cid, | ||
| bool const | top | ||
| ) |
Find a user-specified option key in a command line context.
- Note
- Searches up the context to find a match
References add_edits(), begin, CREATE_EXCEPTION, gpu_set_args::done, test.T009_Exceptions::e, end, has, create_a3b_hbs::i, is_relevant(), subloop_histogram::key, lower_no_under(), merged(), n_part(), n_part_prefix_match(), pid(), suffix(), top, and trim().
Referenced by basic::options::key(), load_option_cl(), and load_option_file().
◆ find_key_file()
|
static |
References CREATE_EXCEPTION, has, merged(), and top.
Referenced by load_option_file().
◆ get_argv()
| std::string utility::options::OptionCollection::get_argv | ( | ) | const |
Returns a copy of the concatenated argv strings that were initialized in load().
References argv_copy_.
◆ has() [1/16]
|
inline |
Is there an option with an AnyOptionKey?
References anys_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [2/16]
|
inline |
Is there an option with an AnyVectorOptionKey?
References any_vectors_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [3/16]
|
inline |
Is there an option with a BooleanOptionKey?
References booleans_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
Referenced by check_specs(), check_values(), load_options_from_stream(), main(), basic::options::read_subset_of_global_option_collection(), set_option_value_cl(), set_option_value_file(), show_all(), show_all_hier(), show_inaccessed_user_options(), show_option_help(), show_option_help_hier(), show_table_text(), show_table_Wiki(), and show_user().
◆ has() [4/16]
|
inline |
Is there an option with a BooleanVectorOptionKey?
References boolean_vectors_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [5/16]
|
inline |
Is there an option with a FileOptionKey?
References files_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [6/16]
|
inline |
Is there an option with a FileVectorOptionKey?
References file_vectors_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [7/16]
|
inline |
Is there an option with an IntegerOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), integers_, and subloop_histogram::key.
◆ has() [8/16]
|
inline |
Is there an option with an IntegerVectorOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), integer_vectors_, and subloop_histogram::key.
◆ has() [9/16]
|
inline |
Is there an option with an OptionKey?
References all_, utility::keys::SmallKeyVector< K, T >::has(), and subloop_histogram::key.
◆ has() [10/16]
|
inline |
Is there an option with a PathOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and paths_.
◆ has() [11/16]
|
inline |
Is there an option with a PathVectorOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and path_vectors_.
◆ has() [12/16]
|
inline |
Is there an option with a RealOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and reals_.
◆ has() [13/16]
|
inline |
Is there an option with a RealVectorOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and real_vectors_.
◆ has() [14/16]
|
inline |
Is there an option with an IntegerVectorOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and residue_chain_vectors_.
◆ has() [15/16]
|
inline |
Is there an option with a StringOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and strings_.
◆ has() [16/16]
|
inline |
Is there an option with a StringVectorOptionKey?
References utility::keys::SmallKeyVector< K, T >::has(), subloop_histogram::key, and string_vectors_.
◆ is_relevant()
| bool utility::options::OptionCollection::is_relevant | ( | OptionKey const & | key | ) |
Checks if option has been registered as relevant.
Checks is option has been registered as relevant.
References create_a3b_hbs::i, subloop_histogram::key, and relevant_.
Referenced by find_key_cl().
◆ load() [1/3]
| void utility::options::OptionCollection::load | ( | const std::vector< std::string > & | args, |
| bool const | free_args | ||
| ) |
Load the user-specified option values.
References arg(), find_lowest_scoring_relaxed_struct::args, and argv_copy_.
Referenced by load().
◆ load() [2/3]
| void utility::options::OptionCollection::load | ( | int const | argc, |
| char *const | argv[], | ||
| bool const | free_args = false |
||
| ) |
Load the user-specified option values.
References argv, argv_copy_, load(), and erraser_analysis::temp.
◆ load() [3/3]
| void utility::options::OptionCollection::load | ( | std::string | executable_name, |
| ValueStrings & | arg_strings, | ||
| bool const | free_args | ||
| ) |
Load the user-specified option values.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References all, check_values(), utility::io::oc::cout, CREATE_EXCEPTION, utility::options::OptionKeys::options::exit, enumerate_junctions::help, ObjexxFCL::is_double(), utility::options::is_not_ascii(), load_option_cl(), load_option_from_file(), load_options_from_file(), option(), options, show_all_hier(), show_help_hier(), show_table_text(), show_table_Wiki(), show_user(), utility::options::std_exit_wrapper(), utility::options::OptionKeys::options::table::table, utility::options::OptionKeys::options::table::text, ObjexxFCL::trim(), basic::options::OptionKeys::inout::dbms::user, and utility::options::OptionKeys::options::table::Wiki.
◆ load_option_cl()
|
private |
Load a user-specified option argument from a command line.
References cleaned(), CREATE_EXCEPTION, find_key_cl(), utility::options::has_non_ascii(), utility::options::non_ascii_pos(), set_option_value_cl(), ObjexxFCL::stripped_whitespace(), numeric::interpolation::to_string(), and top.
Referenced by load(), and load_option_from_file().
◆ load_option_file()
|
private |
References cleaned(), CREATE_EXCEPTION, find_key_cl(), find_key_file(), utility::options::has_non_ascii(), load_option_from_file(), utility::options::non_ascii_pos(), set_option_value_file(), ObjexxFCL::stripped_whitespace(), numeric::interpolation::to_string(), and top.
Referenced by load_options_from_stream().
◆ load_option_from_file()
|
private |
Load one option from user specified file.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References utility::io::izstream::close(), CREATE_EXCEPTION, getline(), load_option_cl(), res, and utility::split_to_list().
Referenced by load(), and load_option_file().
◆ load_options_from_file()
| void utility::options::OptionCollection::load_options_from_file | ( | std::string const & | file_string, |
| std::string const & | cid = "" |
||
| ) |
Load all options in a flags file.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References load_options_from_file_exception().
Referenced by load(), load_options_from_stream(), and LigandDockBenchmark::setUp().
◆ load_options_from_file_exception()
| void utility::options::OptionCollection::load_options_from_file_exception | ( | std::string const & | file_string, |
| std::string const & | cid = "" |
||
| ) |
same as load_options_from_file, but throws exception instead of call to std::exit
Load all options in a flags file.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References CREATE_EXCEPTION, and load_options_from_stream().
Referenced by load_options_from_file().
◆ load_options_from_stream()
| void utility::options::OptionCollection::load_options_from_stream | ( | std::istream & | stream, |
| std::string const & | file_string = "STREAM", |
||
| std::string const & | cid = "", |
||
| bool | print_lines = false |
||
| ) |
Load all options in a flags file.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References utility::io::oc::cout, CREATE_EXCEPTION, create_a3b_hbs::f, create_a3b_hbs::first, getline(), has(), ObjexxFCL::has(), utility::options::has_non_ascii(), binder::indent(), ObjexxFCL::is_any_of(), create_a3b_hbs::j, ObjexxFCL::len_trim_whitespace(), line, load_option_file(), load_options_from_file(), utility::options::non_ascii_pos(), quote, utility::replace_environment_variables(), ObjexxFCL::SPACE(), ObjexxFCL::strip_whitespace(), ObjexxFCL::stripped_whitespace(), ObjexxFCL::TAB(), ObjexxFCL::trim(), and ObjexxFCL::WHITESPACE().
Referenced by load_options_from_file_exception().
◆ lower_no_under()
|
static |
Remove underscores and lowercase string.
References ObjexxFCL::lowercased().
Referenced by find_key_cl().
◆ merged()
|
static |
Merged option ids with the minimal suffix-prefix overlap, if any, removed.
References cleaned(), min(), n_part(), basic::options::OptionKeys::out::file::o, prefix(), docking::s, suffix(), predPRE::t, and trimmed().
Referenced by find_key_cl(), and find_key_file().
◆ n_part()
|
static |
Number of parts in an option id.
References test.T009_Exceptions::e, create_a3b_hbs::i, and docking::s.
Referenced by find_key_cl(), merged(), n_part_prefix_match(), prefix(), show_all_hier(), show_option_help_hier(), show_table_text(), suffix(), trim(), and trimmed().
◆ n_part_prefix_match()
|
static |
Number of prefix parts of two ids that match.
References min(), kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, n_part(), prefix(), docking::s, predPRE::t, and kmeans_adaptive_kernel_density_bb_dependent_rotlib::u.
Referenced by find_key_cl().
◆ operator()() [1/38]
|
inline |
Option by AnyOptionKey.
References anys_, utility::options::Option::check_restricted_access(), and subloop_histogram::key.
◆ operator()() [2/38]
|
inline |
Option by AnyOptionKey with option type template argument.
References anys_, and subloop_histogram::key.
◆ operator()() [3/38]
|
inline |
Option by AnyOptionKey.
References anys_, utility::options::Option::check_restricted_access(), and subloop_histogram::key.
◆ operator()() [4/38]
|
inline |
Option by AnyOptionKey with option type template argument.
References anys_, and subloop_histogram::key.
◆ operator()() [5/38]
|
inline |
◆ operator()() [6/38]
|
inline |
VectorOption by AnyVectorOptionKey with option type template argument.
References any_vectors_, and subloop_histogram::key.
◆ operator()() [7/38]
|
inline |
◆ operator()() [8/38]
|
inline |
VectorOption by AnyVectorOptionKey with option type template argument.
References any_vectors_, and subloop_histogram::key.
◆ operator()() [9/38]
|
inline |
◆ operator()() [10/38]
|
inline |
◆ operator()() [11/38]
|
inline |
◆ operator()() [12/38]
|
inline |
◆ operator()() [13/38]
|
inline |
Option by FileOptionKey.
References utility::options::Option::check_restricted_access(), files_, and subloop_histogram::key.
◆ operator()() [14/38]
|
inline |
Option by FileOptionKey.
References utility::options::Option::check_restricted_access(), files_, and subloop_histogram::key.
◆ operator()() [15/38]
|
inline |
◆ operator()() [16/38]
|
inline |
◆ operator()() [17/38]
|
inline |
◆ operator()() [18/38]
|
inline |
◆ operator()() [19/38]
|
inline |
◆ operator()() [20/38]
|
inline |
◆ operator()() [21/38]
|
inline |
References all_, utility::options::ANY_OPTION, utility::options::ANY_VECTOR_OPTION, any_vectors_, anys_, utility::keys::SmallKeyVector< K, T >::begin(), utility::options::BOOLEAN_OPTION, utility::options::BOOLEAN_VECTOR_OPTION, boolean_vectors_, booleans_, utility::io::oc::cerr, utility::options::Option::check_restricted_access(), enumerate_junctions::default, utility::down_cast(), utility::options::FILE_OPTION, utility::options::FILE_VECTOR_OPTION, file_vectors_, files_, utility::keys::SmallKeyVector< K, T >::has(), enumerate_junctions::int, utility::options::INTEGER_OPTION, utility::options::INTEGER_VECTOR_OPTION, integer_vectors_, integers_, subloop_histogram::key, utility::options::PATH_OPTION, utility::options::PATH_VECTOR_OPTION, path_vectors_, paths_, utility::options::REAL_OPTION, utility::options::REAL_VECTOR_OPTION, real_vectors_, reals_, utility::options::RESIDUE_CHAIN_VECTOR_OPTION, residue_chain_vectors_, runtime_assert, utility::options::STRING_OPTION, utility::options::STRING_VECTOR_OPTION, string_vectors_, strings_, utility::options::UNKNOWN_OPTION, and utility_exit_with_message.
◆ operator()() [22/38]
|
inline |
Option by OptionKey with option type template argument.
References subloop_histogram::key.
◆ operator()() [23/38]
|
inline |
References all_, utility::options::ANY_OPTION, utility::options::ANY_VECTOR_OPTION, any_vectors_, anys_, utility::keys::SmallKeyVector< K, T >::begin(), utility::options::BOOLEAN_OPTION, utility::options::BOOLEAN_VECTOR_OPTION, boolean_vectors_, booleans_, utility::io::oc::cerr, utility::options::Option::check_restricted_access(), enumerate_junctions::default, utility::down_cast(), utility::options::FILE_OPTION, utility::options::FILE_VECTOR_OPTION, file_vectors_, files_, utility::keys::SmallKeyVector< K, T >::has(), enumerate_junctions::int, utility::options::INTEGER_OPTION, utility::options::INTEGER_VECTOR_OPTION, integer_vectors_, integers_, subloop_histogram::key, utility::options::PATH_OPTION, utility::options::PATH_VECTOR_OPTION, path_vectors_, paths_, utility::options::REAL_OPTION, utility::options::REAL_VECTOR_OPTION, real_vectors_, reals_, utility::options::RESIDUE_CHAIN_VECTOR_OPTION, residue_chain_vectors_, runtime_assert, utility::options::STRING_OPTION, utility::options::STRING_VECTOR_OPTION, string_vectors_, strings_, utility::options::UNKNOWN_OPTION, and utility_exit_with_message.
◆ operator()() [24/38]
|
inline |
Option by OptionKey with option type template argument.
References subloop_histogram::key.
◆ operator()() [25/38]
|
inline |
Option by PathOptionKey.
References utility::options::Option::check_restricted_access(), subloop_histogram::key, and paths_.
◆ operator()() [26/38]
|
inline |
Option by PathOptionKey.
References utility::options::Option::check_restricted_access(), subloop_histogram::key, and paths_.
◆ operator()() [27/38]
|
inline |
◆ operator()() [28/38]
|
inline |
◆ operator()() [29/38]
|
inline |
Option by RealOptionKey.
References utility::options::Option::check_restricted_access(), subloop_histogram::key, and reals_.
◆ operator()() [30/38]
|
inline |
Option by RealOptionKey.
References utility::options::Option::check_restricted_access(), subloop_histogram::key, and reals_.
◆ operator()() [31/38]
|
inline |
◆ operator()() [32/38]
|
inline |
◆ operator()() [33/38]
|
inline |
◆ operator()() [34/38]
|
inline |
◆ operator()() [35/38]
|
inline |
◆ operator()() [36/38]
|
inline |
◆ operator()() [37/38]
|
inline |
◆ operator()() [38/38]
|
inline |
◆ operator=()
| OptionCollection & utility::options::OptionCollection::operator= | ( | OptionCollection const & | src | ) |
Copy assignment operator.
Needed because the mutext can't be copied.
References all_, any_vectors_, anys_, argv_copy_, boolean_vectors_, booleans_, file_vectors_, files_, integer_vectors_, integers_, path_vectors_, paths_, real_vectors_, reals_, relevant_, residue_chain_vectors_, show_accessed_options_, show_unused_options_, string_vectors_, and strings_.
◆ operator[]() [1/38]
|
inline |
◆ operator[]() [2/38]
|
inline |
OptionCollection[ AnyOptionKey ] with option type template argument.
References anys_, and subloop_histogram::key.
◆ operator[]() [3/38]
|
inline |
◆ operator[]() [4/38]
|
inline |
OptionCollection[ AnyOptionKey ] with option type template argument.
References anys_, and subloop_histogram::key.
◆ operator[]() [5/38]
|
inline |
◆ operator[]() [6/38]
|
inline |
OptionCollection[ AnyVectorOptionKey ] with option type template argument.
References any_vectors_, and subloop_histogram::key.
◆ operator[]() [7/38]
|
inline |
◆ operator[]() [8/38]
|
inline |
OptionCollection[ AnyVectorOptionKey ] with option type template argument.
References any_vectors_, and subloop_histogram::key.
◆ operator[]() [9/38]
|
inline |
◆ operator[]() [10/38]
|
inline |
OptionCollection[ BooleanOptionKey ].
References booleans_, utility::options::Option::check_restricted_access(), and subloop_histogram::key.
Referenced by option().
◆ operator[]() [11/38]
|
inline |
◆ operator[]() [12/38]
|
inline |
◆ operator[]() [13/38]
|
inline |
◆ operator[]() [14/38]
|
inline |
◆ operator[]() [15/38]
|
inline |
◆ operator[]() [16/38]
|
inline |
◆ operator[]() [17/38]
|
inline |
◆ operator[]() [18/38]
|
inline |
◆ operator[]() [19/38]
|
inline |
◆ operator[]() [20/38]
|
inline |
◆ operator[]() [21/38]
OptionCollection[ OptionKey ].
References all_, utility::options::ANY_OPTION, utility::options::ANY_VECTOR_OPTION, any_vectors_, anys_, utility::keys::SmallKeyVector< K, T >::begin(), utility::options::BOOLEAN_OPTION, utility::options::BOOLEAN_VECTOR_OPTION, boolean_vectors_, booleans_, utility::io::oc::cerr, utility::options::Option::check_restricted_access(), enumerate_junctions::default, utility::down_cast(), utility::options::FILE_OPTION, utility::options::FILE_VECTOR_OPTION, file_vectors_, files_, utility::keys::SmallKeyVector< K, T >::has(), enumerate_junctions::int, utility::options::INTEGER_OPTION, utility::options::INTEGER_VECTOR_OPTION, integer_vectors_, integers_, subloop_histogram::key, utility::options::PATH_OPTION, utility::options::PATH_VECTOR_OPTION, path_vectors_, paths_, utility::options::REAL_OPTION, utility::options::REAL_VECTOR_OPTION, real_vectors_, reals_, utility::options::RESIDUE_CHAIN_VECTOR_OPTION, residue_chain_vectors_, runtime_assert, utility::options::STRING_OPTION, utility::options::STRING_VECTOR_OPTION, string_vectors_, strings_, utility::options::UNKNOWN_OPTION, and utility_exit_with_message.
◆ operator[]() [22/38]
|
inline |
OptionCollection[ OptionKey ] with option type template argument.
References subloop_histogram::key.
◆ operator[]() [23/38]
OptionCollection[ OptionKey ].
References all_, utility::options::ANY_OPTION, utility::options::ANY_VECTOR_OPTION, any_vectors_, anys_, utility::keys::SmallKeyVector< K, T >::begin(), utility::options::BOOLEAN_OPTION, utility::options::BOOLEAN_VECTOR_OPTION, boolean_vectors_, booleans_, utility::io::oc::cerr, utility::options::Option::check_restricted_access(), enumerate_junctions::default, utility::down_cast(), utility::options::FILE_OPTION, utility::options::FILE_VECTOR_OPTION, file_vectors_, files_, utility::keys::SmallKeyVector< K, T >::has(), enumerate_junctions::int, utility::options::INTEGER_OPTION, utility::options::INTEGER_VECTOR_OPTION, integer_vectors_, integers_, subloop_histogram::key, utility::options::PATH_OPTION, utility::options::PATH_VECTOR_OPTION, path_vectors_, paths_, utility::options::REAL_OPTION, utility::options::REAL_VECTOR_OPTION, real_vectors_, reals_, utility::options::RESIDUE_CHAIN_VECTOR_OPTION, residue_chain_vectors_, runtime_assert, utility::options::STRING_OPTION, utility::options::STRING_VECTOR_OPTION, string_vectors_, strings_, utility::options::UNKNOWN_OPTION, and utility_exit_with_message.
◆ operator[]() [24/38]
|
inline |
OptionCollection[ OptionKey ] with option type template argument.
References subloop_histogram::key.
◆ operator[]() [25/38]
|
inline |
◆ operator[]() [26/38]
|
inline |
◆ operator[]() [27/38]
|
inline |
◆ operator[]() [28/38]
|
inline |
◆ operator[]() [29/38]
|
inline |
◆ operator[]() [30/38]
|
inline |
◆ operator[]() [31/38]
|
inline |
◆ operator[]() [32/38]
|
inline |
◆ operator[]() [33/38]
|
inline |
◆ operator[]() [34/38]
|
inline |
◆ operator[]() [35/38]
|
inline |
◆ operator[]() [36/38]
|
inline |
◆ operator[]() [37/38]
|
inline |
◆ operator[]() [38/38]
|
inline |
◆ option() [1/36]
|
inline |
Option by AnyOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [2/36]
|
inline |
Option by AnyOptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [3/36]
|
inline |
Option by AnyOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [4/36]
|
inline |
Option by AnyOptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [5/36]
|
inline |
VectorOption by AnyVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [6/36]
|
inline |
VectorOption by AnyVectorOptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [7/36]
|
inline |
VectorOption by AnyVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [8/36]
|
inline |
VectorOption by AnyVectorOptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [9/36]
|
inline |
References subloop_histogram::key, and operator[]().
◆ option() [10/36]
|
inline |
References subloop_histogram::key, and operator[]().
Referenced by check_key(), check_specs(), check_values(), basic::options::int2afteroption(), basic::options::intafteroption(), load(), basic::options::optional_positive_intafteroption(), basic::options::real2afteroption(), basic::options::real3afteroption(), basic::options::realafteroption(), set_option_value_cl(), set_option_value_file(), show_all(), show_all_hier(), show_inaccessed_user_options(), show_option_help(), show_option_help_hier(), show_table_text(), show_table_Wiki(), show_user(), and basic::options::stringafteroption().
◆ option() [11/36]
|
inline |
VectorOption by BooleanVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [12/36]
|
inline |
VectorOption by BooleanVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [13/36]
|
inline |
Option by FileOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [14/36]
|
inline |
Option by FileOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [15/36]
|
inline |
VectorOption by FileVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [16/36]
|
inline |
VectorOption by FileVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [17/36]
|
inline |
References subloop_histogram::key, and operator[]().
◆ option() [18/36]
|
inline |
References subloop_histogram::key, and operator[]().
◆ option() [19/36]
|
inline |
VectorOption by IntegerVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [20/36]
|
inline |
VectorOption by IntegerVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [21/36]
References subloop_histogram::key, and operator[]().
◆ option() [22/36]
|
inline |
Option by OptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [23/36]
References subloop_histogram::key, and operator[]().
◆ option() [24/36]
|
inline |
Option by OptionKey with option type template argument.
References subloop_histogram::key.
◆ option() [25/36]
|
inline |
Option by PathOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [26/36]
|
inline |
Option by PathOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [27/36]
|
inline |
VectorOption by PathVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [28/36]
|
inline |
VectorOption by PathVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [29/36]
|
inline |
Option by RealOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [30/36]
|
inline |
Option by RealOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [31/36]
|
inline |
VectorOption by RealVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [32/36]
|
inline |
VectorOption by RealVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [33/36]
|
inline |
References subloop_histogram::key, and operator[]().
◆ option() [34/36]
|
inline |
References subloop_histogram::key, and operator[]().
◆ option() [35/36]
|
inline |
VectorOption by StringVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ option() [36/36]
|
inline |
VectorOption by StringVectorOptionKey.
References subloop_histogram::key, and operator[]().
◆ prefix()
|
static |
Prefix of an option id with a specified number of parts.
References create_a3b_hbs::i, kmeans_adaptive_kernel_density_bb_dependent_rotlib::idx, kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, n_part(), runtime_assert, and docking::s.
Referenced by pyrosetta.distributed.utility.log.ProgressLogger::increment(), merged(), n_part_prefix_match(), show_all(), show_all_hier(), show_option_help(), show_option_help_hier(), show_table_text(), show_table_Wiki(), and show_user().
◆ set_option_value_cl()
|
private |
Set a user-specified option value from a command line.
Set a user-specified option value from a command line note Decides whether to use value strings and erases the ones used.
References utility::options::Option::can_hold_another(), utility::options::Option::cl_value(), utility::io::oc::cout, CREATE_EXCEPTION, has, has(), utility::options::has_non_ascii(), ObjexxFCL::is_any_of(), utility::options::Option::is_cl_value(), subloop_histogram::key, option(), and runtime_assert.
Referenced by load_option_cl().
◆ set_option_value_file()
|
private |
References utility::options::ScalarOption_T_< K, T >::cl_value(), utility::io::oc::cout, CREATE_EXCEPTION, has, has(), utility::options::has_non_ascii(), subloop_histogram::key, option(), runtime_assert, and value.
Referenced by load_option_file().
◆ set_show_accessed_options_flag()
|
inline |
modify 'show_accessed_options' flag;
References show_accessed_options_, and kmeans_adaptive_kernel_density_bb_dependent_rotlib::v.
◆ set_show_unused_options_flag()
|
inline |
modify 'show_unused_options' flag;
References show_unused_options_, and kmeans_adaptive_kernel_density_bb_dependent_rotlib::v.
◆ show_accessed_options()
| void utility::options::OptionCollection::show_accessed_options | ( | std::ostream & | stream | ) | const |
Show accessed list of options.
References utility::keys::SmallKeyVector< K, T >::begin(), boolean_vectors_, booleans_, utility::keys::SmallKeyVector< K, T >::end(), file_vectors_, files_, create_a3b_hbs::i, integer_vectors_, integers_, path_vectors_, paths_, real_vectors_, reals_, utility::options::show_accessed_options_T(), string_vectors_, and strings_.
Referenced by ~OptionCollection().
◆ show_all()
| void utility::options::OptionCollection::show_all | ( | std::ostream & | stream | ) | const |
Show all the options and their values.
References begin, test.T009_Exceptions::e, end, utility::options::Option::equals_string(), compute_difference::group, has(), create_a3b_hbs::i, utility::options::Option::id(), subloop_histogram::key, option(), and prefix().
Referenced by job_manager.MoveStatsWindow::__init__().
◆ show_all_hier()
| void utility::options::OptionCollection::show_all_hier | ( | std::ostream & | stream | ) | const |
Show all the options and their values in a hierarchy format.
References begin, test.T009_Exceptions::e, end, utility::options::Option::equals_string(), compute_difference::group, has(), create_a3b_hbs::i, utility::options::Option::id(), subloop_histogram::key, extract_by_sidechain_sasa_score::l, n_part(), option(), prefix(), and suffix().
Referenced by load().
◆ show_help()
| void utility::options::OptionCollection::show_help | ( | std::ostream & | stream | ) |
Show all the options and their descriptions.
References begin, test.T009_Exceptions::e, end, compute_difference::group, create_a3b_hbs::i, subloop_histogram::key, relevant_, and show_option_help().
◆ show_help_hier()
| void utility::options::OptionCollection::show_help_hier | ( | std::ostream & | stream | ) |
Show all the options and their descriptions in a hierarchy format.
References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, begin, COL1, COL2, COL3, test.T009_Exceptions::e, end, compute_difference::group, create_a3b_hbs::i, subloop_histogram::key, ObjexxFCL::format::LJ(), relevant_, ObjexxFCL::format::RJ(), and show_option_help_hier().
Referenced by load().
◆ show_inaccessed_user_options()
| void utility::options::OptionCollection::show_inaccessed_user_options | ( | std::ostream & | stream | ) | const |
Show inaccessed user-specified options.
Show the user-specified options and their values.
References begin, test.T009_Exceptions::e, end, has(), create_a3b_hbs::i, utility::options::Option::id(), utility::options::Option::is_been_accessed(), subloop_histogram::key, option(), utility::options::Option::set_accessed(), utility::options::Option::user(), and utility::options::Option::value_string().
◆ show_option_help()
| void utility::options::OptionCollection::show_option_help | ( | OptionKey const & | key, |
| std::string & | group, | ||
| std::ostream & | stream | ||
| ) |
Show one option and it description.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References utility::options::Option::default_string(), utility::options::Option::description(), compute_difference::group, has(), utility::options::Option::id(), subloop_histogram::key, utility::options::Option::legal_string(), min(), option(), prefix(), space_prefixed(), and wrapped().
Referenced by show_help().
◆ show_option_help_hier()
| void utility::options::OptionCollection::show_option_help_hier | ( | OptionKey const & | key, |
| std::string & | group, | ||
| std::ostream & | stream | ||
| ) |
Show one option and it description in a hierarchy format.
- Note
- This function calls only threadsafe functions (that lock appropriate mutexes), so it doesn't need to lock any mutexes itself.
References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, COL1, COL2, COL3, utility::options::Option::description(), compute_difference::group, has(), utility::options::Option::id(), subloop_histogram::key, n_part(), option(), prefix(), ObjexxFCL::format::RJ(), suffix(), utility::options::Option::type_string(), utility::options::Option::value_string(), and wrapped().
Referenced by show_help_hier().
◆ show_table_text()
| void utility::options::OptionCollection::show_table_text | ( | std::ostream & | stream | ) | const |
Show the options definitions table in text format.
References begin, utility::options::Option::default_string(), utility::options::Option::description(), test.T009_Exceptions::e, end, compute_difference::group, has(), create_a3b_hbs::i, utility::options::Option::id(), subloop_histogram::key, extract_by_sidechain_sasa_score::l, utility::options::Option::legal_string(), n_part(), option(), prefix(), suffix(), and utility::options::Option::type_string().
Referenced by load().
◆ show_table_Wiki()
| void utility::options::OptionCollection::show_table_Wiki | ( | std::ostream & | stream | ) | const |
Show the options definitions table in Wiki format.
- Note
- Based on Sergey Lyskov's Python Wiki table generator code
References begin, utility::options::Option::default_string(), utility::options::Option::description(), test.T009_Exceptions::e, end, compute_difference::group, has(), create_a3b_hbs::i, utility::options::Option::id(), subloop_histogram::key, utility::options::Option::legal_string(), option(), prefix(), suffix(), and utility::options::Option::type_string().
Referenced by load().
◆ show_unused_options()
| void utility::options::OptionCollection::show_unused_options | ( | std::ostream & | stream | ) | const |
Show options that were user-specified, but not yet accessed. Differs from show_inaccessed_user_options() mainly by formatting And how the options are accessed. (This one should be destructor safe.)
References utility::keys::SmallKeyVector< K, T >::begin(), boolean_vectors_, booleans_, utility::keys::SmallKeyVector< K, T >::end(), file_vectors_, files_, create_a3b_hbs::i, integer_vectors_, integers_, path_vectors_, paths_, real_vectors_, reals_, utility::options::show_unused_options_T(), string_vectors_, and strings_.
Referenced by ~OptionCollection().
◆ show_user()
| void utility::options::OptionCollection::show_user | ( | std::ostream & | stream | ) | const |
Show the user-specified options and their values.
References begin, test.T009_Exceptions::e, end, compute_difference::group, has(), create_a3b_hbs::i, utility::options::Option::id(), utility::options::Option::is_been_accessed(), subloop_histogram::key, option(), prefix(), utility::options::Option::set_accessed(), utility::options::Option::user(), and utility::options::Option::value_string().
Referenced by load().
◆ space_prefixed()
|
inlinestatic |
Space-prefixed string except blank if string is empty.
References kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, and docking::s.
Referenced by show_option_help().
◆ suffix()
|
static |
Suffix of an option id with a specified number of parts.
References create_a3b_hbs::i, kmeans_adaptive_kernel_density_bb_dependent_rotlib::idx, kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, n_part(), runtime_assert, and docking::s.
Referenced by check_key(), find_key_cl(), merged(), show_all_hier(), show_option_help_hier(), show_table_text(), and show_table_Wiki().
◆ tab_prefixed()
|
inlinestatic |
Tab-prefixed string except blank if string is empty.
References kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, and docking::s.
◆ trim()
|
static |
Trim a specified number of parts from the suffix of an option id.
References create_a3b_hbs::i, kmeans_adaptive_kernel_density_bb_dependent_rotlib::idx, kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, n_part(), runtime_assert, and docking::s.
Referenced by find_key_cl().
◆ trimmed()
|
static |
Prefix of an option id with a specified number of suffix parts removed.
References create_a3b_hbs::i, kmeans_adaptive_kernel_density_bb_dependent_rotlib::idx, kmeans_adaptive_kernel_density_bb_dependent_rotlib::n, n_part(), runtime_assert, and docking::s.
Referenced by merged().
◆ wrapped()
|
static |
String wrapped and indented.
References compute_difference::b, test.T009_Exceptions::e, create_a3b_hbs::i, binder::indent(), ObjexxFCL::is_any_of(), extract_by_sidechain_sasa_score::l, min(), runtime_assert, docking::s, w, and basic::options::OptionKeys::mp::visualize::width.
Referenced by show_option_help(), and show_option_help_hier().
Friends And Related Function Documentation
◆ operator<<
|
friend |
Output to stream.
Member Data Documentation
◆ all_
|
private |
All options (non-owning pointers)
Referenced by add(), has(), operator()(), operator=(), and operator[]().
◆ any_vectors_
|
private |
Any value type vector options.
Referenced by add(), has(), operator()(), operator=(), and operator[]().
◆ anys_
|
private |
Any value type options.
Referenced by add(), has(), operator()(), operator=(), and operator[]().
◆ argv_copy_
|
private |
keep a copy of argv around in case people want to get at it elsewhere in the code.
Referenced by get_argv(), load(), and operator=().
◆ boolean_vectors_
|
private |
Boolean vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ booleans_
|
private |
Boolean options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ file_vectors_
|
private |
File vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ files_
|
private |
File options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ integer_vectors_
|
private |
Integer vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ integers_
|
private |
Integer options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ path_vectors_
|
private |
Path vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ paths_
|
private |
Path options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ real_vectors_
|
private |
Real vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ reals_
|
private |
Real options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ relevant_
|
private |
List of application-relevant options.
Referenced by add_relevant(), is_relevant(), operator=(), show_help(), and show_help_hier().
◆ residue_chain_vectors_
|
private |
Residue/chain vector options.
Referenced by add(), has(), operator()(), operator=(), and operator[]().
◆ show_accessed_options_
|
private |
Flag indicating that list of accessed option should be printed when destructor of OptionCollection is called. This flag is false by default.
Referenced by operator=(), set_show_accessed_options_flag(), and ~OptionCollection().
◆ show_unused_options_
|
private |
Flag indicating that list of user specified but inaccessed options should be printed when destructor of OptionCollection is called. This flag is false by default.
Referenced by operator=(), set_show_unused_options_flag(), and ~OptionCollection().
◆ string_vectors_
|
private |
String vector options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
◆ strings_
|
private |
String options.
Referenced by add(), has(), operator()(), operator=(), operator[](), show_accessed_options(), and show_unused_options().
The documentation for this class was generated from the following files:
- src/utility/options/OptionCollection.hh
- src/utility/options/OptionCollection.cc
