Rosetta  2019.40
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Private Types | List of all members
utility::options::StringVectorOption Class Reference

Program string option class. More...

#include <StringVectorOption.hh>

Inheritance diagram for utility::options::StringVectorOption:
Inheritance graph
[legend]

Public Member Functions

 StringVectorOption ()
 Default constructor. More...
 
 StringVectorOption (StringVectorOptionKey const &key_a, std::string const &description_a)
 Key + description constructor. More...
 
StringVectorOptionclone () const override
 Clone this. More...
 
 ~StringVectorOption () override
 Destructor. More...
 
bool is_value (std::string const &) const override
 Is a string readable as this option's value type? More...
 
bool is_cl_value (std::string const &value_str) const override
 Is a string readable as this option's value type and a legal command line value? More...
 
std::string type_string () const override
 Option type code string representation. More...
 
- Public Member Functions inherited from utility::options::VectorOption_T_< StringVectorOptionKey, std::string >
 ~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...
 
bool legal () const override
 Legal value and size? 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...
 
LegalBound const & lower () const
 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...
 
LegalBound const & upper ()
 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...
 
Size n () const override
 Fixed number of values required (zero if none) More...
 
VectorOption_T_n_lower (Size const n_a) override
 Lower number of values allowed assignment. More...
 
Size n_lower () const override
 Lower number of values allowed (zero if none) More...
 
VectorOption_T_n_upper (Size const n_a) override
 Upper number of values allowed assignment. More...
 
Size n_upper () const override
 Upper number of values allowed (zero if none) More...
 
virtual VectorOption_T_default_value (Value const &value_a)
 Default value assignment. More...
 
VectorOption_T_default_value (Values const &value_a)
 Default value vector assignment. More...
 
Values const & default_value () const
 Default value. More...
 
Value const & default_value (Size const i) const
 Default value at a given index. 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_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...
 
VectorOption_T_value (Values const &value_a)
 Value vector assignment. More...
 
Values const & value () const
 Value. More...
 
Value const & value (Size const i) const
 Value at a given index. 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_operator() (Values const &value_a)
 Value vector assignment. More...
 
Values const & operator() () const
 Value. More...
 
Value const & operator() (Size const i) const
 Value at a given index. 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_value () const override
 Legal value? 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 legal_size () const override
 Legal value size? 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...
 
bool fixed_size () const override
 Fixed number of values required? More...
 
Values value_or (Values const &value_a) const
 Value or passed default if inactive. More...
 
Value value_or (Size const i, Value const &value_a) const
 Value at a given index or passed default if inactive. More...
 
Values user_or (Values const &value_a) const
 Value or passed default if not user-specified. 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...
 
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...
 
- Public Member Functions inherited from utility::options::VectorOption
 ~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...
 
- Public Member Functions inherited from utility::options::Option
virtual ~Option ()
 Destructor. More...
 
Optionis_group (bool value)
 
bool is_group () const
 Is this the synonymous option for an option group (e.g. -in:file:file) 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...
 
Optionrestrict_access (bool setting)
 Restrict direct access to option for general use. More...
 
void check_restricted_access (bool do_check) const
 

Protected Member Functions

Value value_of (std::string const &value_str) const override
 Value of a string. More...
 
- Protected Member Functions inherited from utility::options::VectorOption_T_< StringVectorOptionKey, std::string >
 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 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...
 
- Protected Member Functions inherited from utility::options::VectorOption
 VectorOption ()
 Default constructor. More...
 
 VectorOption (VectorOption const &)=default
 Copy constructor. More...
 
VectorOptionoperator= (VectorOption const &)
 Copy assignment. More...
 
- Protected Member Functions inherited from utility::options::Option
 Option ()
 Default constructor. More...
 
 Option (Option const &option)
 Copy constructor. More...
 
Optionoperator= (Option const &option)
 Copy assignment. More...
 

Private Types

typedef VectorOption_T_
< StringVectorOptionKey,
std::string > 
Super
 

Additional Inherited Members

- Public Types inherited from utility::options::VectorOption_T_< StringVectorOptionKey, std::string >
typedef utility::vector1
< std::string > 
Values
 
typedef StringVectorOptionKey key_type
 
typedef std::string value_type
 
typedef Values::const_iterator const_iterator
 
typedef Values::iterator iterator
 
typedef StringVectorOptionKey Key
 
typedef std::string Value
 
typedef Values::const_iterator ConstIterator
 
typedef Values::iterator Iterator
 
- Public Types inherited from utility::options::Option
typedef OptionKey key_type
 
typedef std::size_t size_type
 
typedef OptionKey Key
 
typedef std::size_t Size
 
- Protected Types inherited from utility::options::Option
enum  State { INACTIVE, DEFAULT, USER }
 Option state enumeration. More...
 

Detailed Description

Program string option class.

Member Typedef Documentation

Constructor & Destructor Documentation

utility::options::StringVectorOption::StringVectorOption ( )
inline

Default constructor.

Referenced by clone().

utility::options::StringVectorOption::StringVectorOption ( StringVectorOptionKey const &  key_a,
std::string const &  description_a 
)
inline

Key + description constructor.

utility::options::StringVectorOption::~StringVectorOption ( )
inlineoverride

Destructor.

Member Function Documentation

StringVectorOption* utility::options::StringVectorOption::clone ( ) const
inlineoverridevirtual
bool utility::options::StringVectorOption::is_cl_value ( std::string const &  value_str) const
inlineoverridevirtual

Is a string readable as this option's value type and a legal command line value?

Implements utility::options::Option.

References ObjexxFCL::is_any_of().

bool utility::options::StringVectorOption::is_value ( std::string const &  ) const
inlineoverridevirtual

Is a string readable as this option's value type?

Implements utility::options::Option.

std::string utility::options::StringVectorOption::type_string ( ) const
inlineoverridevirtual
Value utility::options::StringVectorOption::value_of ( std::string const &  value_str) const
inlineoverrideprotectedvirtual

The documentation for this class was generated from the following file: