Program option interface class. More...

#include <Option.hh>

Inheritance diagram for utility::options::Option:

[legend]

Public Types
typedef OptionKey	key_type

typedef std::size_t	size_type

typedef OptionKey	Key

typedef std::size_t	Size

Public Member Functions
virtual Option *	clone () const =0
	Clone this. More...

virtual	~Option ()
	Destructor. More...

virtual void	copy_from (Option const &other)=0
	Copy operation – requires that other match the type of this. More...

virtual Option &	activate ()=0
	Activate. More...

virtual Option &	deactivate ()=0
	Deactivate. More...

virtual Option &	to_default ()=0
	Set to default value, if any. More...

virtual Option &	clear ()=0
	Clear. More...

virtual Option &	cl_value (std::string const &value_str)=0
	Value assignment from a command line string. More...

virtual bool	legal_specs_report () const =0
	Legal specifications check: Report and return error state. More...

virtual bool	legal_limits_report () const =0
	Legal value limits check: Report and return error state. More...

virtual bool	legal_size_report () const =0
	Legal size limits check: Report and return error state. More...

virtual bool	legal_default_report () const =0
	Legal default value check: Report and return error state. More...

virtual void	legal_default_check () const =0
	Legal default value check. More...

virtual bool	legal_report () const =0
	Legal value check: Report and return error state. More...

virtual void	legal_check () const =0
	Legal value check. More...

virtual bool	specified_report () const =0
	Required specified option check: Report and return error state. More...

virtual void	specified_check () const =0
	Required specified option check. 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 Key const &	key () const =0
	Key. More...

virtual std::string const &	id () const =0
	ID. More...

virtual std::string const &	identifier () const =0
	Identifier. More...

virtual std::string const &	code () const =0
	Code. More...

virtual std::string const &	name () const =0
	Name. More...

virtual std::string const &	description () const =0
	Description. More...

virtual std::string const &	short_description () const =0
	short_Description More...

virtual bool	legal_default () const =0
	Legal or inactive default value? More...

virtual bool	legal () const =0
	Legal value? More...

virtual bool	has_default () const =0
	Has a default? More...

virtual bool	default_active () const =0
	Default active? More...

virtual bool	default_inactive () const =0
	Default inactive? More...

virtual bool	active () const =0
	Active? That is, the option has some value, either the default one or specified on the command line. More...

virtual bool	user () const =0
	User-specified? That is, the option value was specified on the command line. You should probably use active() instead in almost all cases! 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 bool	can_hold_another () const =0
	Can another value be added and stay within any size constraints? More...

virtual Size	default_size () const =0
	Default size (number of default values) More...

virtual Size	n_default_value () const =0
	Number of default values (default size) More...

virtual Size	size () const =0
	Size (number of values) More...

virtual Size	n_value () const =0
	Number of values (size) More...

virtual std::string	type_string () const =0
	Option type code string representation. More...

virtual std::string	legal_string () const =0
	Legal value string representation. More...

virtual std::string	size_constraint_string () const =0
	Size constraint string representation. More...

virtual std::string	default_string () const =0
	Default value string representation. More...

virtual std::string	raw_default_string () const =0
	Default value string representation. More...

virtual std::string	value_string () const =0
	Value string representation. More...

virtual std::string	raw_value_string () const =0
	Value string representation. More...

virtual std::string	equals_string () const =0
	=Value string representation More...

virtual void	set_value (std::string const &value_str, bool reset=false)=0
	Set the value of the option from a string. More...

virtual void	set_cl_value (std::string const &value_str)=0
	Set the value of the option from a string from the commandline options. 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

Static Public Member Functions
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...

Protected Types
enum	State { INACTIVE , DEFAULT , USER }
	Option state enumeration. More...

Protected Member Functions
	Option ()
	Default constructor. More...

	Option (Option const &option)
	Copy constructor. More...

Option &	operator= (Option const &option)
	Copy assignment. More...

Private Attributes
bool	is_group_
	Is this a synonymous option for an option group (e.g. -in:file:file) More...

bool	been_accessed_
	flag, will be true if application was trying to anyhow access/check option value. Used to create option usage reports. False by default, any access functions ie: user(), active(), value(), operator()() will set it to true. More...

bool	restricted_access_
	Is directly accessing this option deprecated in favor of accessing it through the resource manager? More...

Friends
bool	operator< (Option const &a, Option const &b)
	Option < Option. More...

Detailed Description

Program option interface class.

Member Typedef Documentation

◆ Key

typedef OptionKey utility::options::Option::Key

◆ key_type

typedef OptionKey utility::options::Option::key_type

◆ Size

typedef std::size_t utility::options::Option::Size

◆ size_type

typedef std::size_t utility::options::Option::size_type

Member Enumeration Documentation

◆ State

enum utility::options::Option::State

protected

Option state enumeration.

Enumerator
INACTIVE
DEFAULT
USER

Constructor & Destructor Documentation

◆ Option() [1/2]

utility::options::Option::Option ( )

inlineprotected

Default constructor.

◆ Option() [2/2]

utility::options::Option::Option ( Option const & option )

inlineprotected

Copy constructor.

◆ ~Option()

virtual utility::options::Option::~Option ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ activate()

virtual Option& utility::options::Option::activate ( )

pure virtual

Activate.

◆ active()

virtual bool utility::options::Option::active ( ) const

pure virtual

Active? That is, the option has some value, either the default one or specified on the command line.

◆ been_accessed()

void utility::options::Option::been_accessed ( ) const

inline

Set access property to true.

References been_accessed_.

Referenced by utility::options::ScalarOption_T_< K, T >::operator Value const &(), utility::options::VectorOption_T_< K, T >::operator Values const &(), utility::options::ScalarOption_T_< K, T >::user(), and utility::options::VectorOption_T_< K, T >::user().

◆ can_hold_another()

virtual bool utility::options::Option::can_hold_another ( ) const

pure virtual

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

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

◆ check_restricted_access()

void utility::options::Option::check_restricted_access ( bool do_check ) const

inline

References code(), CREATE_EXCEPTION, and restricted_access_.

Referenced by utility::options::OptionCollection::operator()(), and utility::options::OptionCollection::operator[]().

◆ cl_value()

virtual Option& utility::options::Option::cl_value ( std::string const & value_str )

pure virtual

Value assignment from a command line string.

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

◆ clear()

virtual Option& utility::options::Option::clear ( )

pure virtual

Clear.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ clone()

virtual Option* utility::options::Option::clone ( ) const

pure virtual

Clone this.

◆ code()

virtual std::string const& utility::options::Option::code ( ) const

pure virtual

Code.

Referenced by check_restricted_access().

◆ copy_from()

virtual void utility::options::Option::copy_from ( Option const & other )

pure virtual

Copy operation – requires that other match the type of this.

◆ deactivate()

virtual Option& utility::options::Option::deactivate ( )

pure virtual

Deactivate.

◆ default_active()

virtual bool utility::options::Option::default_active ( ) const

pure virtual

Default active?

◆ default_inactive()

virtual bool utility::options::Option::default_inactive ( ) const

pure virtual

Default inactive?

◆ default_size()

virtual Size utility::options::Option::default_size ( ) const

pure virtual

Default size (number of default values)

◆ default_string()

virtual std::string utility::options::Option::default_string ( ) const

pure virtual

Default value string representation.

Referenced by utility::options::OptionCollection::show_option_help(), utility::options::OptionCollection::show_table_text(), and utility::options::OptionCollection::show_table_Wiki().

◆ description()

virtual std::string const& utility::options::Option::description ( ) const

pure virtual

Description.

Referenced by utility::options::OptionCollection::show_option_help(), utility::options::OptionCollection::show_option_help_hier(), utility::options::OptionCollection::show_table_text(), and utility::options::OptionCollection::show_table_Wiki().

◆ equals_string()

virtual std::string utility::options::Option::equals_string ( ) const

pure virtual

=Value string representation

Referenced by utility::options::OptionCollection::show_all(), and utility::options::OptionCollection::show_all_hier().

◆ has_default()

virtual bool utility::options::Option::has_default ( ) const

pure virtual

Has a default?

◆ id()

virtual std::string const& utility::options::Option::id ( ) const

pure virtual

ID.

◆ identifier()

virtual std::string const& utility::options::Option::identifier ( ) const

pure virtual

Identifier.

◆ is_been_accessed()

bool utility::options::Option::is_been_accessed ( ) const

inline

Return true if option value was anyhow accessed.

References been_accessed_.

Referenced by utility::options::show_accessed_options_T(), utility::options::OptionCollection::show_inaccessed_user_options(), utility::options::show_unused_options_T(), and utility::options::OptionCollection::show_user().

◆ is_cl_value()

virtual bool utility::options::Option::is_cl_value ( std::string const & value_str ) const

pure virtual

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

Implemented in utility::options::StringVectorOption, utility::options::StringOption, utility::options::ResidueChainVectorOption, utility::options::RealVectorOption, utility::options::RealOption, utility::options::PathVectorOption, utility::options::PathOption, utility::options::IntegerVectorOption, utility::options::IntegerOption, utility::options::FileVectorOption, utility::options::FileOption, utility::options::BooleanVectorOption, and utility::options::BooleanOption.

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

◆ is_group() [1/2]

bool utility::options::Option::is_group ( ) const

inline

Is this the synonymous option for an option group (e.g. -in:file:file)

References is_group_.

◆ is_group() [2/2]

Option& utility::options::Option::is_group ( bool value )

inline

References is_group_, and value.

Referenced by utility::options::show_unused_options_T().

◆ is_value()

virtual bool utility::options::Option::is_value ( std::string const & value_str ) const

pure virtual

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

Implemented in utility::options::RealVectorOption, utility::options::RealOption, utility::options::IntegerVectorOption, utility::options::IntegerOption, utility::options::BooleanVectorOption, utility::options::BooleanOption, utility::options::StringVectorOption, utility::options::StringOption, utility::options::ResidueChainVectorOption, utility::options::PathVectorOption, utility::options::PathOption, utility::options::FileVectorOption, and utility::options::FileOption.

◆ key()

virtual Key const& utility::options::Option::key ( ) const

pure virtual

Key.

◆ legal()

virtual bool utility::options::Option::legal ( ) const

pure virtual

Legal value?

Referenced by options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionCC(), and options_class.Option::getWikiTableRow().

◆ legal_check()

virtual void utility::options::Option::legal_check ( ) const

pure virtual

Legal value check.

◆ legal_default()

virtual bool utility::options::Option::legal_default ( ) const

pure virtual

Legal or inactive default value?

◆ legal_default_check()

virtual void utility::options::Option::legal_default_check ( ) const

pure virtual

Legal default value check.

◆ legal_default_report()

virtual bool utility::options::Option::legal_default_report ( ) const

pure virtual

Legal default value check: Report and return error state.

◆ legal_limits_report()

virtual bool utility::options::Option::legal_limits_report ( ) const

pure virtual

Legal value limits check: Report and return error state.

◆ legal_report()

virtual bool utility::options::Option::legal_report ( ) const

pure virtual

Legal value check: Report and return error state.

◆ legal_size_report()

virtual bool utility::options::Option::legal_size_report ( ) const

pure virtual

Legal size limits check: Report and return error state.

◆ legal_specs_report()

virtual bool utility::options::Option::legal_specs_report ( ) const

pure virtual

Legal specifications check: Report and return error state.

◆ legal_string()

virtual std::string utility::options::Option::legal_string ( ) const

pure virtual

Legal value string representation.

Referenced by utility::options::OptionCollection::show_option_help(), utility::options::OptionCollection::show_table_text(), and utility::options::OptionCollection::show_table_Wiki().

◆ n_default_value()

virtual Size utility::options::Option::n_default_value ( ) const

pure virtual

Number of default values (default size)

◆ n_value()

virtual Size utility::options::Option::n_value ( ) const

pure virtual

Number of values (size)

◆ name()

virtual std::string const& utility::options::Option::name ( ) const

pure virtual

Name.

Referenced by pyrosetta.distributed.docs.ComponentDoc::__repr__(), options_class.Option::getCName(), options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionKeysCC(), options_class.Option::getWikiTableRow(), enumerate_junctions.DHR::print(), enumerate_junctions.DHR::to_component(), and enumerate_junctions.DHR::write_to_file().

◆ operator=()

Option& utility::options::Option::operator= ( Option const & option )

inlineprotected

Copy assignment.

References been_accessed_, is_group_, option, and restricted_access_.

Referenced by utility::options::ScalarOption_T_< K, T >::operator=(), and utility::options::VectorOption_T_< K, T >::operator=().

◆ print_error_message()

void utility::options::Option::print_error_message ( std::string const & message )

static

Print an error message. As a separate function to keep stream handling from being part of the header files.

References utility::io::oc::cerr, and pyrosetta.utility.array::message.

◆ raw_default_string()

virtual std::string utility::options::Option::raw_default_string ( ) const

pure virtual

Default value string representation.

◆ raw_value_string()

virtual std::string utility::options::Option::raw_value_string ( ) const

pure virtual

Value string representation.

◆ restrict_access()

Option& utility::options::Option::restrict_access ( bool setting )

inline

Restrict direct access to option for general use.

In the past, protocols were able to access the values of options in the option system directly. However this tied protocol behavior tightly to setting specific options on the command line, making it difficult to use Rosetta using other workflows. Now, options are accessed through the resource manager, which has control over which options are passed to which protocols.

basic::resource_manager::ResourceManager::get_instance()->get_option(key);

To incrementally deprectate direct usage of options, an option is set to have restricted access in basic/options/options_rosetta.py

References restricted_access_.

Referenced by options_class.Option::getOptionCC().

◆ set_accessed()

void utility::options::Option::set_accessed ( bool setting ) const

inline

References been_accessed_.

Referenced by utility::options::OptionCollection::show_inaccessed_user_options(), utility::options::show_unused_options_T(), and utility::options::OptionCollection::show_user().

◆ set_cl_value()

virtual void utility::options::Option::set_cl_value ( std::string const & value_str )

pure virtual

Set the value of the option from a string from the commandline options.

The difference between set_value() and set_cl_value() is that set_cl_value() assumes that the options have been pre-vectorized by the commandline, and the string is being passed in (multiple) vectorized pieces. set_value(), in contrast, assumes that it's being passed a pre-vectorized string.

Implemented in utility::options::VectorOption, and utility::options::ScalarOption.

◆ set_value()

virtual void utility::options::Option::set_value	(	std::string const &	value_str,
		bool	reset = `false`
	)

pure virtual

Set the value of the option from a string.

The difference between set_value() and set_cl_value() is that set_cl_value() assumes that the options have been pre-vectorized by the commandline, and the string is being passed in (multiple) vectorized pieces. set_value(), in contrast, assumes that it's being passed a pre-vectorized string. For scalar options, set_value() will set the value as-is, including any spaces. For vector options, it will split according to spaces. If reset is false, set_value() will act like multiple instances of the option on the commandline. If reset is true, vector options will be cleared before adding the new items.

Implemented in utility::options::ScalarOption, and utility::options::VectorOption.

◆ short_description()

virtual std::string const& utility::options::Option::short_description ( ) const

pure virtual

short_Description

◆ size()

virtual Size utility::options::Option::size ( ) const

pure virtual

Size (number of values)

◆ size_constraint_string()

virtual std::string utility::options::Option::size_constraint_string ( ) const

pure virtual

Size constraint string representation.

◆ specified_check()

virtual void utility::options::Option::specified_check ( ) const

pure virtual

Required specified option check.

◆ specified_report()

virtual bool utility::options::Option::specified_report ( ) const

pure virtual

Required specified option check: Report and return error state.

◆ to_default()

virtual Option& utility::options::Option::to_default ( )

pure virtual

Set to default value, if any.

◆ type_string()

virtual std::string utility::options::Option::type_string ( ) const

pure virtual

Option type code string representation.

Referenced by utility::options::OptionCollection::show_option_help_hier(), utility::options::OptionCollection::show_table_text(), and utility::options::OptionCollection::show_table_Wiki().

◆ user()

virtual bool utility::options::Option::user ( ) const

pure virtual

User-specified? That is, the option value was specified on the command line. You should probably use active() instead in almost all cases!

Referenced by utility::options::OptionCollection::show_inaccessed_user_options(), utility::options::show_unused_options_T(), and utility::options::OptionCollection::show_user().

◆ value_string()

virtual std::string utility::options::Option::value_string ( ) const

pure virtual

Value string representation.

Referenced by utility::options::OptionCollection::show_inaccessed_user_options(), utility::options::OptionCollection::show_option_help_hier(), utility::options::show_unused_options_T(), and utility::options::OptionCollection::show_user().

Friends And Related Function Documentation

◆ operator<

bool operator<	(	Option const &	a,
		Option const &	b
	)

friend

Option < Option.

Note: Key-based ordering; Needed for use as option in associative containers

Member Data Documentation

◆ been_accessed_

bool utility::options::Option::been_accessed_

mutableprivate

flag, will be true if application was trying to anyhow access/check option value. Used to create option usage reports. False by default, any access functions ie: user(), active(), value(), operator()() will set it to true.

Referenced by been_accessed(), is_been_accessed(), operator=(), and set_accessed().

◆ is_group_

bool utility::options::Option::is_group_

private

Is this a synonymous option for an option group (e.g. -in:file:file)

Referenced by is_group(), and operator=().

◆ restricted_access_

bool utility::options::Option::restricted_access_

private

Is directly accessing this option deprecated in favor of accessing it through the resource manager?

Referenced by check_restricted_access(), operator=(), and restrict_access().

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

src/utility/options/Option.hh
src/utility/options/Option.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Key

◆ key_type

◆ Size

◆ size_type

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ Option() [1/2]

◆ Option() [2/2]

◆ ~Option()

Member Function Documentation

◆ activate()

◆ active()

◆ been_accessed()

◆ can_hold_another()

◆ check_restricted_access()

◆ cl_value()

◆ clear()

◆ clone()

◆ code()

◆ copy_from()

◆ deactivate()

◆ default_active()

◆ default_inactive()

◆ default_size()

◆ default_string()

◆ description()

◆ equals_string()

◆ has_default()

◆ id()

◆ identifier()

◆ is_been_accessed()

◆ is_cl_value()

◆ is_group() [1/2]

◆ is_group() [2/2]

◆ is_value()

◆ key()

◆ legal()

◆ legal_check()

◆ legal_default()

◆ legal_default_check()

◆ legal_default_report()

◆ legal_limits_report()

◆ legal_report()

◆ legal_size_report()

◆ legal_specs_report()

◆ legal_string()

◆ n_default_value()

◆ n_value()

◆ name()

◆ operator=()

◆ print_error_message()

◆ raw_default_string()

◆ raw_value_string()

◆ restrict_access()

◆ set_accessed()

◆ set_cl_value()

◆ set_value()

◆ short_description()

◆ size()

◆ size_constraint_string()

◆ specified_check()

◆ specified_report()

◆ to_default()

◆ type_string()

◆ user()

◆ value_string()

Friends And Related Function Documentation

◆ operator<

Member Data Documentation

◆ been_accessed_