Rosetta  2019.40
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
utility::options::ScalarOption_T_< K, T > Class Template Referenceabstract

Program scalar-valued option abstract base class. More...

#include <ScalarOption_T_.hh>

Inheritance diagram for utility::options::ScalarOption_T_< K, T >:
Inheritance graph
[legend]

Public Types

typedefkey_type
 
typedef T value_type
 
typedefKey
 
typedef T Value
 
- 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
 

Public Member Functions

ScalarOption_T_clone () const override=0
 Clone this. More...
 
 ~ScalarOption_T_ () override
 Destructor. More...
 
void copy_from (Option const &other) override
 Copy operation. More...
 
 operator Value const & () const
 Value conversion. More...
 
ScalarOption_T_activate () override
 Activate. More...
 
ScalarOption_T_deactivate () override
 Deactivate. More...
 
ScalarOption_T_to_default () override
 Set to default value, if any. More...
 
ScalarOption_T_clear () override
 Clear. More...
 
ScalarOption_T_legal (Value const &value_a)
 Add a legal value. More...
 
ScalarOption_T_shortd (std::string const &s)
 Set a short description. More...
 
ScalarOption_T_lower (Value const &value_a)
 Set a lower bound. More...
 
ScalarOption_T_strict_lower (Value const &value_a)
 Set a strict lower bound. More...
 
ScalarOption_T_upper (Value const &value_a)
 Set an upper bound. More...
 
ScalarOption_T_strict_upper (Value const &value_a)
 Set a strict upper bound. More...
 
virtual ScalarOption_T_default_value (Value const &value_a)
 Default value assignment. More...
 
virtual ScalarOption_T_def (Value const &value_a)
 Default value assignment. More...
 
ScalarOption_T_cl_value (std::string const &value_str) override
 Value assignment from a command line string. More...
 
virtual ScalarOption_T_value (Value const &value_a)
 Value assignment. More...
 
virtual ScalarOption_T_operator() (Value const &value_a)
 Value assignment. More...
 
ScalarOption_T_default_to (ScalarOption_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)
 
void description (std::string const &sd)
 
bool legal_default () const override
 Legal or inactive default value? More...
 
bool legal () const override
 Legal value? More...
 
bool legal_value (Value const &value_a) const
 Is the given value legal? 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 (bool const ) const
 Legal value string representation. 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
 Default value string representation. 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...
 
Value const & default_value () const
 Default value. More...
 
Value const & value () const
 Value. More...
 
Value const & operator() () const
 Value. More...
 
Value value_or (Value const &value_a) const
 Value or passed default if inactive. More...
 
Value user_or (Value const &value_a) const
 Value or passed default if not user-specified. More...
 
- Public Member Functions inherited from utility::options::ScalarOption
 ~ScalarOption () override
 Destructor. More...
 
void set_value (std::string const &value_str, bool=false) override
 Value assignment from full string. More...
 
void set_cl_value (std::string const &value_str) override
 Value assignemt from a command line string but without a ScalarOption & return type. 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...
 
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...
 
Optionrestrict_access (bool setting)
 Restrict direct access to option for general use. More...
 
void check_restricted_access (bool do_check) const
 

Protected Member Functions

 ScalarOption_T_ ()
 Default constructor. More...
 
 ScalarOption_T_ (ScalarOption_T_ const &option)
 Copy constructor. More...
 
 ScalarOption_T_ (Key const &key_a, std::string const &description_a)
 Key + description constructor. More...
 
ScalarOption_T_operator= (ScalarOption_T_ const &option)
 Copy assignment. More...
 
virtual Value value_of (std::string const &value_str) const =0
 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...
 
- Protected Member Functions inherited from utility::options::ScalarOption
 ScalarOption ()
 Default constructor. More...
 
 ScalarOption (ScalarOption const &)=default
 Copy constructor. More...
 
ScalarOptionoperator= (ScalarOption 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 ScalarOption Super
 
typedef std::set< TLegalValues
 
typedef Bound< TLegalBound
 

Private Member Functions

void legal_default_check_write_locked () const
 Legal default value check. More...
 
bool legal_default_write_locked () const
 Legal or inactive default value? Only to be called if mutex_ is already locked. More...
 
bool default_inactive_write_locked () const
 Default inactive? More...
 
std::string default_string_write_locked () const
 Default value string representation. More...
 
bool unconstrained_write_locked () const
 Value is unconstrained? More...
 
bool default_is_legal_write_locked () const
 Default value is a specified legal value? More...
 
bool value_is_legal_write_locked () const
 Value is a specified legal value? More...
 
bool default_obeys_bounds_write_locked () const
 Default 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_
 
State default_state_
 Default state. More...
 
Value default_value_
 Value. More...
 
State state_
 State. More...
 
Value value_
 Value. More...
 

Additional Inherited Members

- Protected Types inherited from utility::options::Option
enum  State { INACTIVE, DEFAULT, USER }
 Option state enumeration. More...
 

Detailed Description

template<typename K, typename T>
class utility::options::ScalarOption_T_< K, T >

Program scalar-valued option abstract base class.

Member Typedef Documentation

template<typename K, typename T>
typedef K utility::options::ScalarOption_T_< K, T >::Key
template<typename K, typename T>
typedef K utility::options::ScalarOption_T_< K, T >::key_type
template<typename K, typename T>
typedef Bound< T > utility::options::ScalarOption_T_< K, T >::LegalBound
private
template<typename K, typename T>
typedef std::set< T > utility::options::ScalarOption_T_< K, T >::LegalValues
private
template<typename K, typename T>
typedef ScalarOption utility::options::ScalarOption_T_< K, T >::Super
private
template<typename K, typename T>
typedef T utility::options::ScalarOption_T_< K, T >::Value
template<typename K, typename T>
typedef T utility::options::ScalarOption_T_< K, T >::value_type

Constructor & Destructor Documentation

template<typename K, typename T>
utility::options::ScalarOption_T_< K, T >::ScalarOption_T_ ( )
inlineprotected

Default constructor.

template<typename K, typename T>
utility::options::ScalarOption_T_< K, T >::ScalarOption_T_ ( ScalarOption_T_< K, T > const &  option)
inlineprotected

Copy constructor.

template<typename K, typename T>
utility::options::ScalarOption_T_< K, T >::ScalarOption_T_ ( Key const &  key_a,
std::string const &  description_a 
)
inlineprotected

Key + description constructor.

template<typename K, typename T>
utility::options::ScalarOption_T_< K, T >::~ScalarOption_T_ ( )
inlineoverride

Destructor.

Member Function Documentation

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::activate ( )
inlineoverridevirtual

Activate.

Implements utility::options::ScalarOption.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::active ( ) const
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::ScalarOption_T_< PathOptionKey, file::PathName >::legal().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::can_hold_another ( ) const
inlineoverridevirtual

Can another value be added and stay within any size constraints?

Implements utility::options::Option.

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::cl_value ( std::string const &  value_str)
inlineoverridevirtual

Value assignment from a command line string.

Implements utility::options::ScalarOption.

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

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::clear ( )
inlineoverridevirtual

Clear.

Implements utility::options::ScalarOption.

template<typename K, typename T>
ScalarOption_T_* utility::options::ScalarOption_T_< K, T >::clone ( ) const
overridepure virtual
template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::code ( ) const
inlineoverridevirtual

Code.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::copy_from ( Option const &  other)
inlineoverridevirtual

Copy operation.

Implements utility::options::Option.

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::deactivate ( )
inlineoverridevirtual

Deactivate.

Implements utility::options::ScalarOption.

template<typename K, typename T>
virtual ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::def ( Value const &  value_a)
inlinevirtual
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_active ( ) const
inlineoverridevirtual

Default active?

Implements utility::options::Option.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_inactive ( ) const
inlineoverridevirtual
template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::default_inactive_error ( ) const
inlineprotected

Error handler for using inactive option value.

Note
Not handled with assert because unspecified option can be a user error
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_inactive_write_locked ( ) const
inlineprivate

Default inactive?

Only to be called if mutex_ is already locked.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_write_locked().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_is_legal ( ) const
inlineprotected

Default value is a specified legal value?

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_is_legal_write_locked ( ) const
inlineprivate

Default value is a specified legal value?

Only to be called if mutex_ is already write-locked.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_write_locked().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_obeys_bounds ( ) const
inlineprotected
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::default_obeys_bounds_write_locked ( ) const
inlineprivate

Default value obeys specified bounds?

Only to be called if mutex_ is already write-locked.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_write_locked().

template<typename K, typename T>
Size utility::options::ScalarOption_T_< K, T >::default_size ( ) const
inlineoverridevirtual

Default size (number of default values)

Implements utility::options::Option.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::default_string ( ) const
inlineoverridevirtual
template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::default_string_write_locked ( ) const
inlineprivate

Default value string representation.

Only to be called if mutex_ is write-locked already.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_check_write_locked().

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::default_to ( ScalarOption_T_< K, T > const &  option)
inline

Default to another option's value.

template<typename K, typename T>
virtual ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::default_value ( Value const &  value_a)
inlinevirtual

Default value assignment.

template<typename K, typename T>
Value const& utility::options::ScalarOption_T_< K, T >::default_value ( ) const
inline
template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::description ( ) const
inlineoverridevirtual

Description.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::description ( std::string const &  sd)
inline
template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::equals_string ( ) const
inlineoverridevirtual

=Value string representation

Implements utility::options::Option.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::has_any_of_characters ( std::string const &  str1,
std::string const &  s 
) const
inline

Has Any Character of a std::string? non ambiguous vesrion for Python binding.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_string().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::has_default ( ) const
inlineoverridevirtual

Has a default?

Implements utility::options::Option.

template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::id ( ) const
inlineoverridevirtual
template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::identifier ( ) const
inlineoverridevirtual

Identifier.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::inactive_error ( ) const
inlineprotected

Error handler for using inactive option value.

Note
Not handled with assert because unspecified option can be a user error

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::operator Value const &().

template<typename K, typename T>
Key const& utility::options::ScalarOption_T_< K, T >::key ( ) const
inlineoverridevirtual

Key.

Not really threadsafe, since this returns a reference to internal data.

Implements utility::options::Option.

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

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::legal ( Value const &  value_a)
inline
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal ( ) const
inlineoverridevirtual
template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::legal_check ( ) const
inlineoverridevirtual
template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::legal_check ( Value const &  value_a) const
inline

Legal value check.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_default ( ) const
inlineoverridevirtual
template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::legal_default_check ( ) const
inlineoverridevirtual

Legal default value check.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::legal_default_check ( Value const &  value_a) const
inline

Legal default value check.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::legal_default_check_write_locked ( ) const
inlineprivate
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_default_report ( ) const
inlineoverridevirtual

Legal default value check: Report and return error state.

Implements utility::options::Option.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_specs_report().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_default_write_locked ( ) const
inlineprivate

Legal or inactive default value? Only to be called if mutex_ is already locked.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_check_write_locked().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_limits_report ( ) const
inlineoverridevirtual

Legal value limits check: Report and return error state.

Implements utility::options::Option.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_specs_report().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_report ( ) const
inlineoverridevirtual

Legal value check: Report and return error state.

Implements utility::options::Option.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_size_report ( ) const
inlineoverridevirtual

Legal size limits check: Report and return error state.

Implements utility::options::Option.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_specs_report ( ) const
inlineoverridevirtual

Legal specifications check: Report and return error state.

Implements utility::options::Option.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::legal_string ( bool  const) const
inline

Legal value string representation.

Specify whether mutex_ is already locked.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::legal_string ( ) const
inlineoverridevirtual

Legal value string representation.

Assumes mutex_ not locked.

Implements utility::options::Option.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_limits_report().

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::legal_value ( Value const &  value_a) const
inline
template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::lower ( Value const &  value_a)
inline
template<typename K, typename T>
LegalBound const& utility::options::ScalarOption_T_< K, T >::lower ( ) const
inline

Lower bound.

template<typename K, typename T>
Size utility::options::ScalarOption_T_< K, T >::n_default_value ( ) const
inlineoverridevirtual

Number of default values (default size)

Implements utility::options::Option.

template<typename K, typename T>
Size utility::options::ScalarOption_T_< K, T >::n_value ( ) const
inlineoverridevirtual

Number of values (size)

Implements utility::options::Option.

template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::name ( ) const
inlineoverridevirtual

Name.

Implements utility::options::Option.

template<typename K, typename T>
utility::options::ScalarOption_T_< K, T >::operator Value const & ( ) const
inline

Value conversion.

Fundamentally non-threadsafe, since a reference to internal data is returned.

template<typename K, typename T>
virtual ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::operator() ( Value const &  value_a)
inlinevirtual

Value assignment.

template<typename K, typename T>
Value const& utility::options::ScalarOption_T_< K, T >::operator() ( ) const
inline

Value.

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::operator= ( ScalarOption_T_< K, T > const &  option)
inlineprotected

Copy assignment.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::raw_default_string ( ) const
inlineoverridevirtual

Default value string representation.

Implements utility::options::Option.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::raw_value_string ( ) const
inlineoverridevirtual

Value string representation.

Implements utility::options::Option.

template<typename K, typename T>
std::string const& utility::options::ScalarOption_T_< K, T >::short_description ( ) const
inlineoverridevirtual

Short Description.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::short_description ( std::string const &  sd)
inline
template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::shortd ( std::string const &  s)
inline
template<typename K, typename T>
Size utility::options::ScalarOption_T_< K, T >::size ( ) const
inlineoverridevirtual

Size (number of values)

Implements utility::options::Option.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::size_constraint_string ( ) const
inlineoverridevirtual

Size constraint string representation.

Implements utility::options::Option.

template<typename K, typename T>
void utility::options::ScalarOption_T_< K, T >::specified_check ( ) const
inlineoverridevirtual

Required specified option check.

Implements utility::options::Option.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::specified_report ( ) const
inlineoverridevirtual

Required specified option check: Report and return error state.

Implements utility::options::Option.

template<typename K, typename T>
virtual void utility::options::ScalarOption_T_< K, T >::stream_setup ( std::ostream &  ) const
inlineprotectedvirtual
template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::strict_lower ( Value const &  value_a)
inline

Set a strict lower bound.

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::strict_upper ( Value const &  value_a)
inline

Set a strict upper bound.

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::to_default ( )
inlineoverridevirtual

Set to default value, if any.

Implements utility::options::ScalarOption.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::unconstrained ( ) const
inlineprotected
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::unconstrained_write_locked ( ) const
inlineprivate

Value is unconstrained?

Only to be called if mutex_ is already write-locked.

Referenced by utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::legal_default_write_locked().

template<typename K, typename T>
ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::upper ( Value const &  value_a)
inline

Set an upper bound.

Referenced by add_rosetta_options_10(), and add_rosetta_options_2().

template<typename K, typename T>
LegalBound const& utility::options::ScalarOption_T_< K, T >::upper ( )
inline

Upper bound.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::user ( ) const
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::ScalarOption_T_< PathOptionKey, file::PathName >::specified_check(), and utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::specified_report().

template<typename K, typename T>
Value utility::options::ScalarOption_T_< K, T >::user_or ( Value const &  value_a) const
inline

Value or passed default if not user-specified.

template<typename K, typename T>
virtual ScalarOption_T_& utility::options::ScalarOption_T_< K, T >::value ( Value const &  value_a)
inlinevirtual

Value assignment.

template<typename K, typename T>
Value const& utility::options::ScalarOption_T_< K, T >::value ( ) const
inline
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::value_is_legal ( ) const
inlineprotected
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::value_is_legal ( Value const &  value_a) const
inlineprotected

Value is legal?

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::value_is_legal_write_locked ( ) const
inlineprivate

Value is a specified legal value?

Only to be called if mutex_ is already write-locked.

template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::value_obeys_bounds ( ) const
inlineprotected
template<typename K, typename T>
bool utility::options::ScalarOption_T_< K, T >::value_obeys_bounds ( Value const &  value_a) const
inlineprotected

Given value obeys specified bounds?

template<typename K, typename T>
virtual Value utility::options::ScalarOption_T_< K, T >::value_of ( std::string const &  value_str) const
protectedpure virtual
template<typename K, typename T>
Value utility::options::ScalarOption_T_< K, T >::value_or ( Value const &  value_a) const
inline

Value or passed default if inactive.

template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::value_string ( ) const
inlineoverridevirtual
template<typename K, typename T>
virtual std::string utility::options::ScalarOption_T_< K, T >::value_string_of ( Value const &  v) const
inlineprotectedvirtual

Member Data Documentation

template<typename K, typename T>
State utility::options::ScalarOption_T_< K, T >::default_state_
private
template<typename K, typename T>
Value utility::options::ScalarOption_T_< K, T >::default_value_
private
template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::description_
private
template<typename K, typename T>
Key utility::options::ScalarOption_T_< K, T >::key_
private
template<typename K, typename T>
LegalValues utility::options::ScalarOption_T_< K, T >::legal_
private
template<typename K, typename T>
LegalBound utility::options::ScalarOption_T_< K, T >::lower_
private
template<typename K, typename T>
std::string utility::options::ScalarOption_T_< K, T >::short_description_
private
template<typename K, typename T>
State utility::options::ScalarOption_T_< K, T >::state_
private
template<typename K, typename T>
LegalBound utility::options::ScalarOption_T_< K, T >::upper_
private
template<typename K, typename T>
Value utility::options::ScalarOption_T_< K, T >::value_
private

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