![]() |
Rosetta
2020.50
|
Program vector-valued option abstract base class. More...
#include <VectorOption_T_.hh>
Public Types | |
typedef utility::vector1< T > | Values |
typedef K | key_type |
typedef T | value_type |
typedef Values::const_iterator | const_iterator |
typedef Values::iterator | iterator |
typedef K | Key |
typedef T | Value |
typedef Values::const_iterator | ConstIterator |
typedef Values::iterator | Iterator |
![]() | |
typedef OptionKey | key_type |
typedef std::size_t | size_type |
typedef OptionKey | Key |
typedef std::size_t | Size |
Public Member Functions | |
VectorOption_T_ * | clone () const override=0 |
Clone this. More... | |
~VectorOption_T_ () override | |
Destructor. More... | |
void | copy_from (Option const &other) override |
Copy operation #details Relies on assignment operator; does not lock mutexes itself. More... | |
operator Values const & () const | |
Value conversion. More... | |
Values::const_iterator | begin () const |
Iterator access for range for loops. More... | |
Values::const_iterator | end () const |
Iterator access for range for loops. More... | |
VectorOption_T_ & | activate () override |
Activate. More... | |
VectorOption_T_ & | deactivate () override |
Deactivate. More... | |
VectorOption_T_ & | to_default () override |
Set to default value, if any. More... | |
VectorOption_T_ & | clear () override |
Clear. More... | |
VectorOption_T_ & | legal (Value const &value_a) |
Add a legal value. More... | |
VectorOption_T_ & | shortd (std::string const &s) |
Set a short description. More... | |
VectorOption_T_ & | lower (Value const &value_a) |
Set a lower bound. More... | |
VectorOption_T_ & | strict_lower (Value const &value_a) |
Set a strict lower bound. More... | |
VectorOption_T_ & | upper (Value const &value_a) |
Set an upper bound. More... | |
VectorOption_T_ & | strict_upper (Value const &value_a) |
Set a strict upper bound. More... | |
VectorOption_T_ & | n (Size const n_a) override |
Fixed number of values required assignment. More... | |
VectorOption_T_ & | n_lower (Size const n_a) override |
Lower number of values allowed assignment. More... | |
VectorOption_T_ & | n_upper (Size const n_a) override |
Upper number of values allowed assignment. More... | |
virtual VectorOption_T_ & | default_value (Value const &value_a) |
Default value assignment. More... | |
virtual VectorOption_T_ & | def (Value const &value_a) |
Default value assignment. More... | |
virtual VectorOption_T_ & | def () |
Default value assignment to empty vector. More... | |
VectorOption_T_ & | default_value (Values const &value_a) |
Default value vector assignment. More... | |
VectorOption_T_ & | def (Values const &value_a) |
Default value vector assignment. More... | |
VectorOption_T_ & | cl_value (std::string const &value_str) override |
Value assignment from a command line string. More... | |
virtual VectorOption_T_ & | value (Value const &value_a) |
Value assignment. More... | |
virtual VectorOption_T_ & | push_back (Value const &value_a) |
Add to values. Note that this just calls value() which has push_back functionality but confusing name. More... | |
virtual VectorOption_T_ & | operator() (Value const &value_a) |
Value assignment. More... | |
VectorOption_T_ & | value (Values const &value_a) |
Value vector assignment. More... | |
VectorOption_T_ & | operator() (Values const &value_a) |
Value vector assignment. More... | |
VectorOption_T_ & | default_to (VectorOption_T_ const &option) |
Default to another option's value. More... | |
bool | legal_specs_report () const override |
Legal specifications check: Report and return error state. More... | |
bool | legal_limits_report () const override |
Legal value limits check: Report and return error state. More... | |
bool | legal_size_report () const override |
Legal size limits check: Report and return error state. More... | |
bool | legal_default_report () const override |
Legal default value check: Report and return error state. More... | |
void | legal_default_check () const override |
Legal default value check. More... | |
void | legal_default_check (Value const &value_a) const |
Legal default value check. More... | |
bool | legal_report () const override |
Legal value check: Report and return error state. More... | |
void | legal_check () const override |
Legal value check. More... | |
void | legal_check (Value const &value_a) const |
Legal value check. More... | |
bool | specified_report () const override |
Required specified option check: Report and return error state. More... | |
void | specified_check () const override |
Required specified option check. More... | |
Key const & | key () const override |
Key. More... | |
std::string const & | id () const override |
ID. More... | |
std::string const & | identifier () const override |
Identifier. More... | |
std::string const & | code () const override |
Code. More... | |
std::string const & | name () const override |
Name. More... | |
std::string const & | description () const override |
Description. More... | |
std::string const & | short_description () const override |
Short Description. More... | |
void | short_description (std::string const &sd) |
bool | legal_default () const override |
Legal or inactive default value and size? More... | |
bool | legal_default_value () const override |
Legal or inactive default value? More... | |
bool | legal_default_size () const override |
Legal default value size? More... | |
bool | legal () const override |
Legal value and size? More... | |
bool | legal_value () const override |
Legal value? More... | |
bool | legal_size () const override |
Legal value size? More... | |
bool | legal_value (Value const &value_a) const |
Overload of legal_value. Assumes mutex_ is NOT locked, so that functions that this will call will obtain locks. More... | |
bool | has_default () const override |
Has a default? More... | |
bool | default_active () const override |
Default active? More... | |
bool | default_inactive () const override |
Default inactive? More... | |
bool | active () const override |
Active? That is, the option has some value, either the default one or specified on the command line. More... | |
bool | user () const override |
User-specified? That is, the option value was specified on the command line. You should probably use active() instead in almost all cases! More... | |
bool | can_hold_another () const override |
Can another value be added and stay within any size constraints? More... | |
Size | default_size () const override |
Default size (number of default values) More... | |
Size | n_default_value () const override |
Number of default values (default size) More... | |
Size | size () const override |
Size( number of values). More... | |
Size | n_value () const override |
Number of values (size) More... | |
bool | has_any_of_characters (std::string const &str1, std::string const &s) const |
Has Any Character of a std::string? non ambiguous vesrion for Python binding. More... | |
std::string | legal_string () const override |
Legal value string representation. More... | |
std::string | size_constraint_string () const override |
Size constraint string representation. More... | |
std::string | default_string () const override |
Default value string representation. More... | |
std::string | raw_default_string () const override |
Same as default_string, but without the "[" and "]"s wrapping the value list. More... | |
std::string | value_string () const override |
Value string representation. More... | |
std::string | raw_value_string () const override |
Value string representation. More... | |
std::string | equals_string () const override |
=Value string representation More... | |
LegalBound const & | lower () const |
Lower bound. More... | |
LegalBound const & | upper () |
Upper bound. More... | |
bool | fixed_size () const override |
Fixed number of values required? More... | |
Size | n () const override |
Fixed number of values required (zero if none) More... | |
Size | n_lower () const override |
Lower number of values allowed (zero if none) More... | |
Size | n_upper () const override |
Upper number of values allowed (zero if none) More... | |
Values const & | default_value () const |
Default value. More... | |
Value const & | default_value (Size const i) const |
Default value at a given index. More... | |
Values const & | value () const |
Value. More... | |
Values const & | operator() () const |
Value. More... | |
Values | value_or (Values const &value_a) const |
Value or passed default if inactive. More... | |
Values | user_or (Values const &value_a) const |
Value or passed default if not user-specified. More... | |
Value const & | value (Size const i) const |
Value at a given index. More... | |
bool | has_value (Value const &value) |
Does the VectorOption contain the given value? More... | |
Value const & | operator() (Size const i) const |
Value at a given index. More... | |
Value const & | operator[] (Size const i) const |
Value at a given index. More... | |
Value | value_or (Size const i, Value const &value_a) const |
Value at a given index or passed default if inactive. More... | |
Value | user_or (Size const i, Value const &value_a) const |
Value at a given index or passed default if not user-specified. More... | |
![]() | |
~VectorOption () override | |
Destructor. More... | |
void | set_value (std::string const &value_str, bool reset=false) override |
Value assignemt from a command line string but without a VectorOption & return type. This will separate arguments by whitespace and set the vector option accordingly. If reset is true, the current values will be cleared first. More... | |
void | set_cl_value (std::string const &value_str) override |
Set the value of the option from a string from the commandline options. More... | |
![]() | |
virtual | ~Option () |
Destructor. More... | |
Option & | is_group (bool value) |
bool | is_group () const |
Is this the synonymous option for an option group (e.g. -in:file:file) More... | |
virtual bool | is_value (std::string const &value_str) const =0 |
Is a string readable as this option's value type? More... | |
virtual bool | is_cl_value (std::string const &value_str) const =0 |
Is a string readable as this option's value type and a legal command line value? More... | |
virtual std::string | type_string () const =0 |
Option type code string representation. More... | |
void | been_accessed () const |
Set access property to true. More... | |
void | set_accessed (bool setting) const |
bool | is_been_accessed () const |
Return true if option value was anyhow accessed. More... | |
Option & | restrict_access (bool setting) |
Restrict direct access to option for general use. More... | |
void | check_restricted_access (bool do_check) const |
Protected Member Functions | |
VectorOption_T_ () | |
Default constructor. More... | |
VectorOption_T_ (VectorOption_T_ const &option) | |
Copy constructor. More... | |
VectorOption_T_ (Key const &key_a, std::string const &description_a) | |
Key + description constructor. More... | |
VectorOption_T_ & | operator= (VectorOption_T_ const &option) |
Copy assignment. More... | |
virtual Value | value_of (std::string const &value_str) const =0 |
Value of a string. More... | |
virtual Values | values_of (std::string const &value_str) const |
Value of a string. More... | |
virtual std::string | value_string_of (Value const &v) const |
String representation of a given value. More... | |
void | default_inactive_error () const |
Error handler for using inactive option value. More... | |
void | inactive_error () const |
Error handler for using inactive option value. More... | |
virtual void | stream_setup (std::ostream &) const |
Setup stream state for the Option value type. More... | |
bool | unconstrained () const |
Value is unconstrained? More... | |
bool | default_is_legal () const |
Default value is a specified legal value? More... | |
bool | value_is_legal () const |
Value is a specified legal value? More... | |
bool | value_is_legal (Value const &value_a) const |
Value is legal? More... | |
bool | default_obeys_bounds () const |
Default value obeys specified bounds? More... | |
bool | value_obeys_bounds () const |
Value obeys specified bounds? More... | |
bool | value_obeys_bounds (Value const &value_a) const |
Given value obeys specified bounds? More... | |
bool | default_size_ok () const |
Default value size is OK? More... | |
bool | value_size_ok () const |
Value size is OK? More... | |
![]() | |
VectorOption () | |
Default constructor. More... | |
VectorOption (VectorOption const &)=default | |
Copy constructor. More... | |
VectorOption & | operator= (VectorOption const &) |
Copy assignment. More... | |
![]() | |
Option () | |
Default constructor. More... | |
Option (Option const &option) | |
Copy constructor. More... | |
Option & | operator= (Option const &option) |
Copy assignment. More... | |
Private Types | |
typedef VectorOption | Super |
typedef std::set< T > | LegalValues |
typedef Bound< T > | LegalBound |
Private Member Functions | |
bool | legal_value (Value const &value_a, bool const already_locked) const |
Is the given value legal? More... | |
Size | size (bool const ) const |
Size (number of values) More... | |
std::string | legal_string (bool const ) const |
Legal value string representation. More... | |
std::string | default_string (bool const ) const |
Default value string representation. More... | |
std::string | raw_default_string (bool const ) const |
Same as default_string, but without the "[" and "]"s wrapping the value list. More... | |
bool | unconstrained (bool const ) const |
Value is unconstrained? More... | |
bool | default_is_legal (bool const ) const |
Default value is a specified legal value? More... | |
bool | value_is_legal (Value const &value_a, bool const ) const |
Value is legal? More... | |
bool | value_obeys_bounds (Value const &value_a, bool const ) const |
Given value obeys specified bounds? More... | |
Private Attributes | |
Key | key_ |
Key. More... | |
std::string | description_ |
Description. More... | |
std::string | short_description_ |
Short Description. More... | |
LegalValues | legal_ |
Legal values. More... | |
LegalBound | lower_ |
Bound values. More... | |
LegalBound | upper_ |
Size | n_ |
Size requirements. More... | |
Size | n_lower_ |
Size | n_upper_ |
State | default_state_ |
Default state. More... | |
Values | default_value_ |
Value. More... | |
State | state_ |
State. More... | |
Values | value_ |
Value. More... | |
Additional Inherited Members | |
![]() | |
static void | print_error_message (std::string const &message) |
Print an error message. As a separate function to keep stream handling from being part of the header files. More... | |
![]() | |
enum | State { INACTIVE, DEFAULT, USER } |
Option state enumeration. More... | |
Program vector-valued option abstract base class.
typedef Values::const_iterator utility::options::VectorOption_T_< K, T >::const_iterator |
typedef Values::const_iterator utility::options::VectorOption_T_< K, T >::ConstIterator |
typedef Values::iterator utility::options::VectorOption_T_< K, T >::iterator |
typedef Values::iterator utility::options::VectorOption_T_< K, T >::Iterator |
typedef K utility::options::VectorOption_T_< K, T >::Key |
typedef K utility::options::VectorOption_T_< K, T >::key_type |
|
private |
|
private |
|
private |
typedef T utility::options::VectorOption_T_< K, T >::Value |
typedef T utility::options::VectorOption_T_< K, T >::value_type |
typedef utility::vector1< T > utility::options::VectorOption_T_< K, T >::Values |
|
inlineprotected |
Default constructor.
|
inlineprotected |
Copy constructor.
|
inlineprotected |
Key + description constructor.
|
inlineoverride |
Destructor.
|
inlineoverridevirtual |
Activate.
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Active? That is, the option has some value, either the default one or specified on the command line.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_value().
|
inline |
Iterator access for range for loops.
Not threadsafe.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::begin().
|
inlineoverridevirtual |
Can another value be added and stay within any size constraints?
Implements utility::options::Option.
|
inlineoverridevirtual |
Value assignment from a command line string.
Implements utility::options::VectorOption.
Referenced by utility::options::ResidueChainVectorOption::cl_value().
|
inlineoverridevirtual |
Clear.
Implements utility::options::VectorOption.
|
overridepure virtual |
Clone this.
Implements utility::options::VectorOption.
Implemented in utility::options::AnyVectorOption< T >, utility::options::FileVectorOption, utility::options::PathVectorOption, utility::options::ResidueChainVectorOption, utility::options::IntegerVectorOption, utility::options::RealVectorOption, utility::options::BooleanVectorOption, and utility::options::StringVectorOption.
|
inlineoverridevirtual |
Code.
Implements utility::options::Option.
|
inlineoverridevirtual |
Copy operation #details Relies on assignment operator; does not lock mutexes itself.
Implements utility::options::Option.
|
inlineoverridevirtual |
Deactivate.
Implements utility::options::VectorOption.
|
inlinevirtual |
Default value assignment.
|
inlinevirtual |
Default value assignment to empty vector.
|
inline |
Default value vector assignment.
|
inlineoverridevirtual |
Default active?
Implements utility::options::Option.
|
inlineoverridevirtual |
Default inactive?
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_value().
|
inlineprotected |
Error handler for using inactive option value.
|
inlineprivate |
Default value is a specified legal value?
Pass true if mutex_ is already locked.
|
inlineprotected |
Default value is a specified legal value?
Assumes mutex_ is unlocked.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_value().
|
inlineprotected |
Default value obeys specified bounds?
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_value().
|
inlineoverridevirtual |
Default size (number of default values)
Implements utility::options::Option.
|
inlineprotected |
Default value size is OK?
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_size().
|
inlineprivate |
Default value string representation.
|
inlineoverridevirtual |
Default value string representation.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_report().
|
inline |
Default to another option's value.
|
inlinevirtual |
Default value assignment.
|
inline |
Default value vector assignment.
|
inline |
Default value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_to().
|
inline |
Default value at a given index.
|
inlineoverridevirtual |
Description.
Implements utility::options::Option.
|
inline |
Iterator access for range for loops.
Not threadsafe.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::end().
|
inlineoverridevirtual |
=Value string representation
Implements utility::options::Option.
|
inlineoverridevirtual |
Fixed number of values required?
Implements utility::options::VectorOption.
|
inline |
Has Any Character of a std::string? non ambiguous vesrion for Python binding.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().
|
inlineoverridevirtual |
Has a default?
Implements utility::options::Option.
|
inline |
Does the VectorOption contain the given value?
|
inlineoverridevirtual |
ID.
Implements utility::options::Option.
|
inlineoverridevirtual |
Identifier.
Implements utility::options::Option.
|
inlineprotected |
Error handler for using inactive option value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator Values const &().
|
inlineoverridevirtual |
|
inline |
Add a legal value.
|
inlineoverridevirtual |
Legal value and size?
Implements utility::options::Option.
|
inlineoverridevirtual |
Legal value check.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator()(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::value().
|
inline |
Legal value check.
|
inlineoverridevirtual |
Legal or inactive default value and size?
Implements utility::options::Option.
|
inlineoverridevirtual |
Legal default value check.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::def(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_value().
|
inline |
Legal default value check.
|
inlineoverridevirtual |
Legal default value check: Report and return error state.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_specs_report().
|
inlineoverridevirtual |
Legal default value size?
Implements utility::options::VectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_report().
|
inlineoverridevirtual |
Legal or inactive default value?
Implements utility::options::VectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_report().
|
inlineoverridevirtual |
Legal value limits check: Report and return error state.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_specs_report().
|
inlineoverridevirtual |
Legal value check: Report and return error state.
Implements utility::options::Option.
|
inlineoverridevirtual |
Legal value size?
Implements utility::options::VectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_report().
|
inlineoverridevirtual |
Legal size limits check: Report and return error state.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_specs_report().
|
inlineoverridevirtual |
Legal specifications check: Report and return error state.
Implements utility::options::Option.
|
inlineprivate |
Legal value string representation.
Allows specification of whether mutex_ is locked.
|
inlineoverridevirtual |
Legal value string representation.
Assumes that mutex_ is unlocked.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_limits_report().
|
inlineoverridevirtual |
Legal value?
Implements utility::options::VectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::cl_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_check(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_report().
|
inlineprivate |
Is the given value legal?
If already_locked is true, there is already a write-lock on mutex_, so additional locking should not be done.
|
inline |
Overload of legal_value. Assumes mutex_ is NOT locked, so that functions that this will call will obtain locks.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_value().
|
inline |
Set a lower bound.
|
inline |
Lower bound.
|
inlineoverridevirtual |
Fixed number of values required assignment.
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Fixed number of values required (zero if none)
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Number of default values (default size)
Implements utility::options::Option.
|
inlineoverridevirtual |
Lower number of values allowed assignment.
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Lower number of values allowed (zero if none)
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Upper number of values allowed assignment.
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Upper number of values allowed (zero if none)
Implements utility::options::VectorOption.
|
inlineoverridevirtual |
Number of values (size)
Implements utility::options::Option.
|
inlineoverridevirtual |
Name.
Implements utility::options::Option.
|
inline |
Value conversion.
|
inlinevirtual |
Value assignment.
|
inline |
Value vector assignment.
|
inline |
Value.
|
inline |
Value at a given index.
|
inlineprotected |
Copy assignment.
Threadsafe.
|
inline |
Value at a given index.
|
inlinevirtual |
Add to values. Note that this just calls value() which has push_back functionality but confusing name.
|
inlineprivate |
Same as default_string, but without the "[" and "]"s wrapping the value list.
|
inlineoverridevirtual |
Same as default_string, but without the "[" and "]"s wrapping the value list.
Implements utility::options::Option.
|
inlineoverridevirtual |
Value string representation.
Implements utility::options::Option.
|
inlineoverridevirtual |
Short Description.
Implements utility::options::Option.
|
inline |
|
inline |
Set a short description.
|
inlineprivate |
Size (number of values)
Allows specification of whether mutex_ is already locked.
|
inlineoverridevirtual |
Size( number of values).
Assmues mutex_ is unlocked.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::can_hold_another(), basic::options::int2afteroption(), my_main(), basic::options::optional_positive_intafteroption(), basic::options::real2afteroption(), basic::options::real3afteroption(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::size().
|
inlineoverridevirtual |
Size constraint string representation.
Implements utility::options::Option.
|
inlineoverridevirtual |
Required specified option check.
Implements utility::options::Option.
|
inlineoverridevirtual |
Required specified option check: Report and return error state.
Implements utility::options::Option.
|
inlineprotectedvirtual |
Setup stream state for the Option value type.
Reimplemented in utility::options::RealVectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().
|
inline |
Set a strict lower bound.
|
inline |
Set a strict upper bound.
|
inlineoverridevirtual |
Set to default value, if any.
Implements utility::options::VectorOption.
|
inlineprivate |
Value is unconstrained?
Pass true if mutex_ is already locked.
|
inlineprotected |
Value is unconstrained?
Assumes mutex_ is unlocked.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_value(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_value().
|
inline |
Set an upper bound.
|
inline |
Upper bound.
|
inlineoverridevirtual |
User-specified? That is, the option value was specified on the command line. You should probably use active() instead in almost all cases!
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::specified_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::specified_report().
|
inline |
Value or passed default if not user-specified.
|
inline |
Value at a given index or passed default if not user-specified.
|
inlinevirtual |
Value assignment.
|
inline |
Value vector assignment.
|
inline |
Value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::push_back().
|
inline |
Value at a given index.
|
inlineprotected |
Value is a specified legal value?
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_value().
|
inlineprivate |
Value is legal?
Pass true if mutex_ is already locked, false otherwise.
|
inlineprotected |
Value is legal?
Assumes mutex_ is not locked.
|
inlineprotected |
Value obeys specified bounds?
Assumes mutex_ is unlocked.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_value().
|
inlineprivate |
Given value obeys specified bounds?
Allows specification of whether mutex_ is already locked.
|
inlineprotected |
Given value obeys specified bounds?
Assumes mutex_ is unlocked.
|
protectedpure virtual |
Value of a string.
Implemented in utility::options::FileVectorOption, utility::options::PathVectorOption, utility::options::ResidueChainVectorOption, utility::options::BooleanVectorOption, utility::options::IntegerVectorOption, utility::options::RealVectorOption, and utility::options::StringVectorOption.
|
inline |
Value or passed default if inactive.
|
inline |
Value at a given index or passed default if inactive.
|
inlineprotected |
Value size is OK?
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_size().
|
inlineoverridevirtual |
Value string representation.
Implements utility::options::Option.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_report().
|
inlineprotectedvirtual |
String representation of a given value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_check(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_default_check(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string().
|
inlineprotectedvirtual |
Value of a string.
Reimplemented in utility::options::IntegerVectorOption, and utility::options::ResidueChainVectorOption.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::cl_value().
|
private |
Default state.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::def(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_active(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_inactive(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_size(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::has_default(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::to_default().
|
private |
Value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::def(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_size(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::to_default().
|
private |
|
private |
Key.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::code(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::id(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::identifier(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::key(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::name(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=().
|
private |
|
private |
Bound values.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_limits_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::lower(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::strict_lower().
|
private |
Size requirements.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::can_hold_another(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_size_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=().
|
private |
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_size_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_lower(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=().
|
private |
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::can_hold_another(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_size_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_upper(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=().
|
private |
|
private |
State.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::activate(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::active(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::cl_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::deactivate(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::def(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_to(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator Values const &(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator()(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::size(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::to_default(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::user(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::value().
|
private |
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_limits_report(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::legal_string(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::strict_upper(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::upper().
|
private |
Value.
Referenced by utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::cl_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::clear(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::def(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::default_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::n_value(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator Values const &(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator()(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::operator=(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::size(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::to_default(), and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::value().