This is the base class for the templated vul_arg<T>s.
More...
#include <vul_arg.h>
|
| char const * | option () |
| |
| char const * | help () |
| |
| bool | set () const |
| | Returns true if arg was set on the command line. More...
|
| |
| virtual std::ostream & | print_value (std::ostream &)=0 |
| |
|
| char const * | type_ |
| | Static text describing type of option (e.g. bool or double). More...
|
| |
This is the base class for the templated vul_arg<T>s.
Definition at line 35 of file vul_arg.h.
◆ vul_arg_base() [1/2]
| vul_arg_base::vul_arg_base |
( |
vul_arg_info_list & |
l, |
|
|
char const * |
option_string, |
|
|
char const * |
helpstring, |
|
|
bool |
required = false |
|
) |
| |
|
protected |
◆ vul_arg_base() [2/2]
| vul_arg_base::vul_arg_base |
( |
char const * |
option_string, |
|
|
char const * |
helpstring, |
|
|
bool |
required = false |
|
) |
| |
|
protected |
◆ ~vul_arg_base()
| virtual vul_arg_base::~vul_arg_base |
( |
| ) |
|
|
protectedvirtualdefault |
◆ add_to_current()
◆ display_usage()
| void vul_arg_base::display_usage |
( |
char const * |
msg = nullptr | ) |
|
|
static |
◆ display_usage_and_exit()
| void vul_arg_base::display_usage_and_exit |
( |
char const * |
msg = nullptr | ) |
|
|
static |
◆ help()
| char const * vul_arg_base::help |
( |
| ) |
|
◆ include_deprecated()
Add another vul_arg_info_list to the current one.
This allows for the inclusion of different sets of arguments into the main program, from different libraries.
Definition at line 84 of file vul_arg.cxx.
◆ option()
| char const * vul_arg_base::option |
( |
| ) |
|
◆ parse()
| virtual int vul_arg_base::parse |
( |
char ** |
argv | ) |
|
|
protectedpure virtual |
◆ parse_deprecated()
| void vul_arg_base::parse_deprecated |
( |
int & |
argc, |
|
|
char **& |
argv, |
|
|
bool |
warn_about_unrecognized_arguments = true |
|
) |
| |
|
static |
The main static method.
Definition at line 96 of file vul_arg.cxx.
◆ print_value()
| virtual std::ostream& vul_arg_base::print_value |
( |
std::ostream & |
| ) |
|
|
pure virtual |
◆ set()
| bool vul_arg_base::set |
( |
| ) |
const |
Returns true if arg was set on the command line.
Definition at line 72 of file vul_arg.cxx.
◆ set_help_description()
| void vul_arg_base::set_help_description |
( |
char const * |
str | ) |
|
|
static |
◆ set_help_option()
| void vul_arg_base::set_help_option |
( |
char const * |
str | ) |
|
|
static |
◆ set_help_precis()
| void vul_arg_base::set_help_precis |
( |
char const * |
str | ) |
|
|
static |
◆ vul_arg_info_list
◆ help_
| std::string vul_arg_base::help_ |
|
protected |
Description of argument.
Definition at line 77 of file vul_arg.h.
◆ is_required
◆ option_
| std::string vul_arg_base::option_ |
|
protected |
Option flag including "-" or "--".
Definition at line 75 of file vul_arg.h.
◆ required_
| bool vul_arg_base::required_ |
|
protected |
if true, this flag must be set on command line.
Definition at line 73 of file vul_arg.h.
◆ set_
After parsing, true iff value was set on command line.
Definition at line 71 of file vul_arg.h.
◆ type_
| char const* vul_arg_base::type_ |
Static text describing type of option (e.g. bool or double).
Definition at line 68 of file vul_arg.h.
The documentation for this class was generated from the following files:
