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

Program file option class. More...

#include <FileOption.hh>

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

List of all members.

Public Types

typedef char const * CHAR_CONST_P
 function to allow atomatic conversion to the char *.

Public Member Functions

 FileOption ()
 Default constructor.
 FileOption (FileOptionKey const &key_a, std::string const &description_a)
 Key + description constructor.
FileOptionclone () const
 Clone this.
virtual ~FileOption ()
 Destructor.
FileOptiondefault_value (std::string const &value_a)
 Default value assignment.
FileOptiondef (std::string const &value_a)
 Default value assignment.
FileOptionvalue (std::string const &value_a)
 Value assignment.
FileOptionoperator() (std::string const &value_a)
 Value assignment.
 operator std::string ()
 function to allow atomatic conversion to the string.
 operator CHAR_CONST_P ()
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 file option class.


Member Typedef Documentation

function to allow atomatic conversion to the char *.


Constructor & Destructor Documentation

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

Default constructor.

Referenced by clone().

utility::options::FileOption::FileOption ( FileOptionKey const &  key_a,
std::string const &  description_a 
) [inline]

Key + description constructor.

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

Destructor.


Member Function Documentation

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

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

Implements utility::options::Option.

utility::options::FileOption::operator CHAR_CONST_P ( ) [inline]
utility::options::FileOption::operator std::string ( ) [inline]

function to allow atomatic conversion to the string.

References utility::options::ScalarOption_T_< FileOptionKey, file::FileName >::value().

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

Option type code string representation.

Implements utility::options::Option.

FileOption& utility::options::FileOption::value ( std::string const &  value_a) [inline]
Value utility::options::FileOption::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