utility::options::IntegerOption Class Reference

Program integer option class. More...

#include <IntegerOption.hh>

Inheritance diagram for utility::options::IntegerOption:

Collaboration diagram for utility::options::IntegerOption:

List of all members.

Public Member Functions
	IntegerOption ()
	Default constructor.
	IntegerOption (IntegerOptionKey const &key_a, std::string const &description_a)
	Key + description constructor.
IntegerOption *	clone () const
	Clone this.
virtual	~IntegerOption ()
	Destructor.
bool	is_value (std::string const &value_str) const
	Is a string readable as this option's value type?
bool	is_cl_value (std::string const &value_str) const
	Is a string readable as this option's value type and a legal command line value?
std::string	type_string () const
	Option type code string representation.
Protected Member Functions
Value	value_of (std::string const &value_str) const
	Value of a string.

---

Detailed Description

Program integer option class.

---

Constructor & Destructor Documentation

utility::options::IntegerOption::IntegerOption

(

)

[inline]

Default constructor.

Referenced by clone().

utility::options::IntegerOption::IntegerOption	(	IntegerOptionKey const &	key_a,
		std::string const &	description_a
	)		[inline]

Key + description constructor.

virtual utility::options::IntegerOption::~IntegerOption

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

IntegerOption* utility::options::IntegerOption::clone

(

)

const [inline, virtual]

Clone this.

Implements utility::options::ScalarOption_T_< IntegerOptionKey, int >.

References IntegerOption().

bool utility::options::IntegerOption::is_cl_value

(

std::string const &

value_str

)

const [inline, virtual]

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

Implements utility::options::Option.

References is_value().

bool utility::options::IntegerOption::is_value

(

std::string const &

value_str

)

const [inline, virtual]

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

Implements utility::options::Option.

References ObjexxFCL::is_int().

Referenced by is_cl_value().

std::string utility::options::IntegerOption::type_string

(

)

const [inline, virtual]

Option type code string representation.

Implements utility::options::Option.

Value utility::options::IntegerOption::value_of

(

std::string const &

value_str

)

const [inline, protected, virtual]

Value of a string.

Implements utility::options::ScalarOption_T_< IntegerOptionKey, int >.

References utility::exit(), ObjexxFCL::int_of(), ObjexxFCL::is_int(), and utility::options::mpi_safe_std_err().

---

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

• src/utility/options/IntegerOption.hh