Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::program_options::variables_map Class Reference

Concrete variables map which store variables in real map. More...

#include <variables_map.hpp>

Inheritance diagram for boost::program_options::variables_map:
Collaboration diagram for boost::program_options::variables_map:

Public Member Functions

 variables_map ()
 
 variables_map (const abstract_variables_map *next)
 
const variable_valueoperator[] (const std::string &name) const
 
void clear ()
 
void notify ()
 
void next (abstract_variables_map *next)
 Sets next variable map, which will be used to find variables not found in *this. More...
 

Public Attributes

keys
 STL member. More...
 
T elements
 STL member. More...
 

Friends

BOOST_PROGRAM_OPTIONS_DECL void store (const basic_parsed_options< char > &options, variables_map &xm, bool utf8)
 Stores in 'm' all options that are defined in 'options'. More...
 

Detailed Description

Concrete variables map which store variables in real map.

This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content.

Constructor & Destructor Documentation

boost::program_options::variables_map::variables_map ( )
boost::program_options::variables_map::variables_map ( const abstract_variables_map next)

Member Function Documentation

void boost::program_options::variables_map::clear ( )
void boost::program_options::abstract_variables_map::next ( abstract_variables_map next)
inherited

Sets next variable map, which will be used to find variables not found in *this.

void boost::program_options::variables_map::notify ( )
const variable_value& boost::program_options::variables_map::operator[] ( const std::string &  name) const
inline

Friends And Related Function Documentation

BOOST_PROGRAM_OPTIONS_DECL void store ( const basic_parsed_options< char > &  options,
variables_map xm,
bool  utf8 
)
friend

Stores in 'm' all options that are defined in 'options'.

If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value.

Member Data Documentation

T std::map< K, T >::elements
inherited

STL member.

K std::map< K, T >::keys
inherited

STL member.


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