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

#include <ScalarOption_T_.hh>

Inheritance diagram for utility::options::ScalarOption_T_< K, T >:

Public Types
typedef K	key_type

typedef T	value_type

typedef K	Key

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
virtual ScalarOption_T_ *	clone () const =0
	Clone this. More...

virtual	~ScalarOption_T_ ()
	Destructor. More...

	operator Value const & () const
	Value conversion. More...

ScalarOption_T_ &	activate ()
	Activate. More...

ScalarOption_T_ &	deactivate ()
	Deactivate. More...

ScalarOption_T_ &	to_default ()
	Set to default value, if any. More...

ScalarOption_T_ &	clear ()
	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)
	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
	Legal specifications check: Report and return error state. More...

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

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

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

void	legal_default_check () const
	Legal default value check. More...

void	legal_default_check (Value const &value_a) const
	Legal default value check. More...

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

void	legal_check () const
	Legal value check. More...

void	legal_check (Value const &value_a) const
	Legal value check. More...

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

void	specified_check () const
	Required specified option check. More...

Key const &	key () const
	Key. More...

std::string const &	id () const
	ID. More...

std::string const &	identifier () const
	Identifier. More...

std::string const &	code () const
	Code. More...

std::string const &	name () const
	Name. More...

std::string const &	description () const
	Description. More...

std::string const &	short_description () const
	Short Description. More...

void	short_description (std::string const &sd)

void	description (std::string const &sd)

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

bool	legal () const
	Legal value? More...

bool	legal_value (Value const &value_a) const
	Is the given value legal? More...

bool	has_default () const
	Has a default? More...

bool	default_active () const
	Default active? More...

bool	default_inactive () const
	Default inactive? More...

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

bool	user () const
	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
	Can another value be added and stay within any size constraints? More...

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

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

Size	size () const
	Size (number of values) More...

Size	n_value () const
	Number of values (size) More...

bool	has_any_of_characters (std::string const str_, std::string const s) const
	Has Any Character of a std::string? non ambiguous vesrion for Python binding. More...

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

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

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

std::string	value_string () const
	Value string representation. More...

std::string	equals_string () const
	=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
virtual	~ScalarOption ()
	Destructor. More...

Public Member Functions inherited from utility::options::Option
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
	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 &option)
	Copy constructor. More...

ScalarOption &	operator= (ScalarOption const &)
	Copy assignment. More...

Protected Member Functions inherited from utility::options::Option
	Option ()
	Default constructor. More...

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

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

Private Types
typedef ScalarOption	Super

typedef std::set< T >	LegalValues

typedef Bound< T >	LegalBound

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...