STXXL  1.4-dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stxxl::cmdline_parser::argument_double Struct Reference

Detailed Description

specialization of argument for double options or parameters

Definition at line 211 of file cmdline.h.

+ Inheritance diagram for stxxl::cmdline_parser::argument_double:
+ Collaboration diagram for stxxl::cmdline_parser::argument_double:

Public Member Functions

 argument_double (char key, const std::string &longkey, const std::string &keytype, const std::string &desc, bool required, double &dest)
 contructor filling most attributes More...
 
virtual void print_value (std::ostream &os) const
 format value to ostream More...
 
virtual bool process (int &argc, const char *const *&argv)
 parse unsigned integer using sscanf. More...
 
virtual const char * type_name () const
 return formatted type name to user More...
 
- Public Member Functions inherited from stxxl::cmdline_parser::argument
 argument (char key, const std::string &longkey, const std::string &keytype, const std::string &desc, bool required)
 contructor filling most attributes More...
 
virtual ~argument ()
 empty virtual destructor More...
 
std::string option_text () const
 return '-s, –longkey [keytype]' More...
 
std::string param_text () const
 return 'longkey [keytype]' More...
 

Public Attributes

double & m_dest
 
- Public Attributes inherited from stxxl::cmdline_parser::argument
std::string m_desc
 longer description, which will be wrapped More...
 
bool m_found
 found during processing of command line More...
 
char m_key
 single letter short option, or 0 is none More...
 
std::string m_keytype
 option type description, e.g. "<#>" to indicate numbers More...
 
std::string m_longkey
 long option key or name for parameters More...
 
bool m_repeated
 repeated argument, i.e. std::vector<std::string> More...
 
bool m_required
 required, process() fails if the option/parameter is not found. More...
 

Constructor & Destructor Documentation

stxxl::cmdline_parser::argument_double::argument_double ( char  key,
const std::string &  longkey,
const std::string &  keytype,
const std::string &  desc,
bool  required,
double &  dest 
)
inline

contructor filling most attributes

Definition at line 216 of file cmdline.h.

Member Function Documentation

virtual void stxxl::cmdline_parser::argument_double::print_value ( std::ostream &  os) const
inlinevirtual

format value to ostream

Implements stxxl::cmdline_parser::argument.

Definition at line 240 of file cmdline.h.

virtual bool stxxl::cmdline_parser::argument_double::process ( int &  argc,
const char *const *&  argv 
)
inlinevirtual

parse unsigned integer using sscanf.

Implements stxxl::cmdline_parser::argument.

Definition at line 228 of file cmdline.h.

virtual const char* stxxl::cmdline_parser::argument_double::type_name ( ) const
inlinevirtual

return formatted type name to user

Implements stxxl::cmdline_parser::argument.

Definition at line 224 of file cmdline.h.

Member Data Documentation

double& stxxl::cmdline_parser::argument_double::m_dest

Definition at line 213 of file cmdline.h.


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