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

Program path option class. More...

#include <PathOption.hh>

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

List of all members.

Public Member Functions

 PathOption ()
 Default constructor.
 PathOption (PathOptionKey const &key_a, std::string const &description_a)
 Key + description constructor.
PathOptionclone () const
 Clone this.
virtual ~PathOption ()
 Destructor.
PathOptiondefault_value (std::string const &value_a)
 Default value assignment.
PathOptiondef (std::string const &value_a)
 Default value assignment.
PathOptionvalue (std::string const &value_a)
 Value assignment.
PathOptionoperator() (std::string const &value_a)
 Value assignment.
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.

Detailed Description

Program path option class.


Constructor & Destructor Documentation

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

Default constructor.

Referenced by clone().

utility::options::PathOption::PathOption ( PathOptionKey const &  key_a,
std::string const &  description_a 
) [inline]

Key + description constructor.

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

Destructor.


Member Function Documentation

PathOption* utility::options::PathOption::clone ( ) const [inline, virtual]
PathOption& utility::options::PathOption::def ( std::string const &  value_a) [inline]
PathOption& utility::options::PathOption::default_value ( std::string const &  value_a) [inline]
bool utility::options::PathOption::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::PathOption::is_value ( std::string const &  ) const [inline, virtual]

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

Implements utility::options::Option.

PathOption& utility::options::PathOption::operator() ( std::string const &  value_a) [inline]
std::string utility::options::PathOption::type_string ( ) const [inline, virtual]

Option type code string representation.

Implements utility::options::Option.

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

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