utility::options::VectorOption Class Reference

Program vector-valued option interface class. More...

#include <VectorOption.hh>

Inheritance diagram for utility::options::VectorOption:

Collaboration diagram for utility::options::VectorOption:

List of all members.

Public Member Functions
virtual VectorOption *	clone () const =0
	Clone this.
virtual	~VectorOption ()
	Destructor.
virtual VectorOption &	activate ()=0
	Activate.
virtual VectorOption &	deactivate ()=0
	Deactivate.
virtual VectorOption &	to_default ()=0
	Set to default value, if any.
virtual VectorOption &	clear ()=0
	Clear.
virtual VectorOption &	cl_value (std::string const &value_str)=0
	Value assignment from a command line string.
virtual VectorOption &	n (Size const n_a)=0
	Fixed number of values required assignment.
virtual VectorOption &	n_lower (Size const n_a)=0
	Lower number of values allowed assignment.
virtual VectorOption &	n_upper (Size const n_a)=0
	Upper number of values allowed assignment.
virtual bool	fixed_size () const =0
	Fixed number of values required?
virtual Size	n () const =0
	Fixed number of values required (zero if none)
virtual Size	n_lower () const =0
	Lower number of values allowed (zero if none)
virtual Size	n_upper () const =0
	Upper number of values allowed (zero if none)
virtual bool	legal_default_value () const =0
	Legal or inactive default value?
virtual bool	legal_default_size () const =0
	Legal default value size?
virtual bool	legal_value () const =0
	Legal value?
virtual bool	legal_size () const =0
	Legal value size?
Protected Member Functions
	VectorOption ()
	Default constructor.
	VectorOption (VectorOption const &option)
	Copy constructor.
VectorOption &	operator= (VectorOption const &)
	Copy assignment.

---

Detailed Description

Program vector-valued option interface class.

---

Constructor & Destructor Documentation

utility::options::VectorOption::VectorOption

(

)

[inline, protected]

Default constructor.

utility::options::VectorOption::VectorOption

(

VectorOption const &

option

)

[inline, protected]

Copy constructor.

virtual utility::options::VectorOption::~VectorOption

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual VectorOption& utility::options::VectorOption::activate

(

)

[pure virtual]

Activate.

Implements utility::options::Option.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

Referenced by utility::options::VariantOption< VectorOption >::activate().

virtual VectorOption& utility::options::VectorOption::cl_value

(

std::string const &

value_str

)

[pure virtual]

Value assignment from a command line string.

Implements utility::options::Option.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

Referenced by utility::options::VariantOption< VectorOption >::cl_value().

virtual VectorOption& utility::options::VectorOption::clear

(

)

[pure virtual]

Clear.

Implements utility::options::Option.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

Referenced by utility::options::VariantOption< VectorOption >::clear().

virtual VectorOption* utility::options::VectorOption::clone

(

)

const [pure virtual]

Clone this.

Implements utility::options::Option.

Implemented in utility::options::AnyVectorOption< T >, utility::options::BooleanVectorOption, utility::options::FileVectorOption, utility::options::IntegerVectorOption, utility::options::PathVectorOption, utility::options::RealVectorOption, utility::options::StringVectorOption, utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

Referenced by utility::options::VariantOption< VectorOption >::operator=().

virtual VectorOption& utility::options::VectorOption::deactivate

(

)

[pure virtual]

Deactivate.

Implements utility::options::Option.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

Referenced by utility::options::VariantOption< VectorOption >::deactivate().

virtual bool utility::options::VectorOption::fixed_size

(

)

const [pure virtual]

Fixed number of values required?

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual bool utility::options::VectorOption::legal_default_size

(

)

const [pure virtual]

Legal default value size?

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual bool utility::options::VectorOption::legal_default_value

(

)

const [pure virtual]

Legal or inactive default value?

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual bool utility::options::VectorOption::legal_size

(

)

const [pure virtual]

Legal value size?

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual bool utility::options::VectorOption::legal_value

(

)

const [pure virtual]

Legal value?

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual Size utility::options::VectorOption::n

(

)

const [pure virtual]

Fixed number of values required (zero if none)

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual VectorOption& utility::options::VectorOption::n

(

Size const

n_a

)

[pure virtual]

Fixed number of values required assignment.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual Size utility::options::VectorOption::n_lower

(

)

const [pure virtual]

Lower number of values allowed (zero if none)

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual VectorOption& utility::options::VectorOption::n_lower

(

Size const

n_a

)

[pure virtual]

Lower number of values allowed assignment.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual VectorOption& utility::options::VectorOption::n_upper

(

Size const

n_a

)

[pure virtual]

Upper number of values allowed assignment.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

virtual Size utility::options::VectorOption::n_upper

(

)

const [pure virtual]

Upper number of values allowed (zero if none)

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

VectorOption& utility::options::VectorOption::operator=

(

VectorOption const &

)

[inline, protected]

Copy assignment.

virtual VectorOption& utility::options::VectorOption::to_default

(

)

[pure virtual]

Set to default value, if any.

Implements utility::options::Option.

Implemented in utility::options::VectorOption_T_< K, T >, utility::options::VectorOption_T_< PathVectorOptionKey, file::PathName >, utility::options::VectorOption_T_< IntegerVectorOptionKey, int >, utility::options::VectorOption_T_< RealVectorOptionKey, double >, utility::options::VectorOption_T_< FileVectorOptionKey, file::FileName >, utility::options::VectorOption_T_< StringVectorOptionKey, std::string >, utility::options::VectorOption_T_< AnyVectorOptionKey, T >, and utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >.

---

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

• src/utility/options/VectorOption.hh