Main   Classes   Namespace members   Examples   Recipes   Rationale   Related pages

boost::program_options::option_description_easy_init< Derived > Class Template Reference

Class which provides convenient creation syntax to option_description. More...

#include <options_description.hpp>

Inherits boost::program_options::option_description.

Inheritance diagram for boost::program_options::option_description_easy_init< Derived >:

Inheritance graph
[legend]
Collaboration diagram for boost::program_options::option_description_easy_init< Derived >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

return_type & description (const char *desc)
 Sets the description.

return_type & parameter (const char *parameter)
 Sets the parameter name.

return_type & flags (char f)
 Sets flags to the passed value.

return_type & default_value (const char *v)
 Sets default value of the option.

return_type & default_parameter (const char *p)
 Sets default value of the option's parameter.

return_type & validator (const validator_function &vf)
 Sets validator to be used for the options's parameter.

return_type & notify (const notify_function &nf)
 Sets notify function to be used with this option.


Detailed Description

template<typename Derived>
class boost::program_options::option_description_easy_init< Derived >

Class which provides convenient creation syntax to option_description.

Any option description class which desires to have easy init syntax, should derive from this one.


Member Function Documentation

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::description const char *    desc
 

Sets the description.

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::parameter const char *    parameter
 

Sets the parameter name.

See also:
boost::program_options::parameter

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::flags char    f
 

Sets flags to the passed value.

The value of 'c' has the same meaning as in cmdline::add_option.

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::default_value const char *    v
 

Sets default value of the option.

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::default_parameter const char *    p
 

Sets default value of the option's parameter.

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::validator const validator_function   vf
 

Sets validator to be used for the options's parameter.

Reimplemented from boost::program_options::option_description.

template<class Derived>
option_description_easy_init< Derived >::return_type & boost::program_options::option_description_easy_init< Derived >::notify const notify_function   nf
 

Sets notify function to be used with this option.

Reimplemented from boost::program_options::option_description.


The documentation for this class was generated from the following files:
Generated on 23 May 2003 with
doxygen