Rosetta 3.3
Public Member Functions | Static Public Member Functions | Protected Member Functions
utility::options::BooleanOption Class Reference

Program boolean option class. More...

#include <BooleanOption.hh>

Inheritance diagram for utility::options::BooleanOption:
Inheritance graph
[legend]
Collaboration diagram for utility::options::BooleanOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BooleanOption ()
 Default constructor.
 BooleanOption (BooleanOptionKey const &key_a, std::string const &description_a)
 Key + description constructor.
BooleanOptionclone () const
 Clone this.
virtual ~BooleanOption ()
 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.
std::string legal_string () const
 Legal value string representation.
std::string default_string () const
 Default value string representation.
std::string value_string () const
 Value string representation.
std::string equals_string () const
 =Value string representation

Static Public Member Functions

static BooleanOption NoDefault (BooleanOptionKey const &key_a, std::string const &description_a)
 Key + description no-default named constructor.

Protected Member Functions

Value value_of (std::string const &value_str) const
 Value of a string.
bool is_true_value (std::string const &value_str) const
 String accepted as a true value?
bool is_false_value (std::string const &value_str) const
 String accepted as a true value?

Detailed Description

Program boolean option class.


Constructor & Destructor Documentation

utility::options::BooleanOption::BooleanOption ( ) [inline]

Default constructor.

Referenced by clone(), and NoDefault().

utility::options::BooleanOption::BooleanOption ( BooleanOptionKey const &  key_a,
std::string const &  description_a 
) [inline]
virtual utility::options::BooleanOption::~BooleanOption ( ) [inline, virtual]

Destructor.


Member Function Documentation

BooleanOption* utility::options::BooleanOption::clone ( ) const [inline, virtual]
std::string utility::options::BooleanOption::default_string ( ) const [inline, virtual]

Default value string representation.

Reimplemented from utility::options::ScalarOption_T_< BooleanOptionKey, bool >.

std::string utility::options::BooleanOption::equals_string ( ) const [inline, virtual]
bool utility::options::BooleanOption::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::BooleanOption::is_false_value ( std::string const &  value_str) const [inline, protected]

String accepted as a true value?

Referenced by is_value(), and value_of().

bool utility::options::BooleanOption::is_true_value ( std::string const &  value_str) const [inline, protected]

String accepted as a true value?

Referenced by is_value(), and value_of().

bool utility::options::BooleanOption::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 is_false_value(), and is_true_value().

Referenced by is_cl_value().

std::string utility::options::BooleanOption::legal_string ( ) const [inline, virtual]

Legal value string representation.

Reimplemented from utility::options::ScalarOption_T_< BooleanOptionKey, bool >.

static BooleanOption utility::options::BooleanOption::NoDefault ( BooleanOptionKey const &  key_a,
std::string const &  description_a 
) [inline, static]

Key + description no-default named constructor.

References BooleanOption().

std::string utility::options::BooleanOption::type_string ( ) const [inline, virtual]

Option type code string representation.

Implements utility::options::Option.

Value utility::options::BooleanOption::value_of ( std::string const &  value_str) const [inline, protected, virtual]
std::string utility::options::BooleanOption::value_string ( ) const [inline, virtual]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines