boost::program_options::basic_parsed_options< charT > Singleton Reference

Results of parsing an input source. More...

#include <variables_map.hpp>

Inheritance diagram for boost::program_options::basic_parsed_options< charT >:

Collaboration diagram for boost::program_options::basic_parsed_options< charT >:

Public Member Functions
	basic_parsed_options (const options_description *xdescription, int options_prefix=0)

Public Attributes
std::vector< basic_option < charT > >	options
	Options found in the source. More...
const options_description *	description
	Options description that was used for parsing. More...
int	m_options_prefix
	Mainly used for the diagnostic messages in exceptions. More...

Detailed Description

template<class charT>
singleton boost::program_options::basic_parsed_options< charT >

Results of parsing an input source.

The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself.

Constructor & Destructor Documentation

template<class charT>

boost::program_options::basic_parsed_options< charT >::basic_parsed_options ( const options_description *  xdescription, int  options_prefix = 0  )

inlineexplicit

Member Data Documentation

template<class charT>

const options_description* boost::program_options::basic_parsed_options< charT >::description

Options description that was used for parsing.

Parsers should return pointer to the instance of option_description passed to them, and issues of lifetime are up to the caller. Can be NULL.

template<class charT>

int boost::program_options::basic_parsed_options< charT >::m_options_prefix

Mainly used for the diagnostic messages in exceptions.

The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short

template<class charT>

std::vector< basic_option<charT> > boost::program_options::basic_parsed_options< charT >::options

Options found in the source.

---

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

• boost_1_57_0/boost/program_options/parsers.hpp