Rosetta 3.3
Public Member Functions | Protected Member Functions | Friends
utility::options::StringOption Class Reference

Program string option class. More...

#include <StringOption.hh>

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

List of all members.

Public Member Functions

 StringOption ()
 Default constructor.
 StringOption (StringOptionKey const &key_a, std::string const &description_a)
 Key + description constructor.
StringOptionclone () const
 Clone this.
virtual ~StringOption ()
 Destructor.
bool is_value (std::string const &) 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.

Friends

std::string operator+ (StringOption const &option1, StringOption const &option2)
 StringOption + StringOption.
std::string operator+ (StringOption const &option, std::string const &s)
 StringOption + std::string.
std::string operator+ (std::string const &s, StringOption const &option)
 std::string + StringOption

Detailed Description

Program string option class.


Constructor & Destructor Documentation

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

Default constructor.

Referenced by clone().

utility::options::StringOption::StringOption ( StringOptionKey const &  key_a,
std::string const &  description_a 
) [inline]

Key + description constructor.

virtual utility::options::StringOption::~StringOption ( ) [inline, virtual]

Destructor.


Member Function Documentation

StringOption* utility::options::StringOption::clone ( ) const [inline, virtual]
bool utility::options::StringOption::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 ObjexxFCL::is_any_of().

bool utility::options::StringOption::is_value ( std::string const &  ) const [inline, virtual]

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

Implements utility::options::Option.

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

Option type code string representation.

Implements utility::options::Option.

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

Friends And Related Function Documentation

std::string operator+ ( StringOption const &  option1,
StringOption const &  option2 
) [friend]
std::string operator+ ( std::string const &  s,
StringOption const &  option 
) [friend]

std::string + StringOption

std::string operator+ ( StringOption const &  option,
std::string const &  s 
) [friend]

StringOption + std::string.


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