Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class variables_map

boost::program_options::variables_map

Synopsis

// In header: <boost/program_options/variables_map.hpp>


class variables_map : public , public  {
public:
  // construct/copy/destruct
  ();
  (abstract_variables_map *);

  // public member functions
  variable_value & () ;
   ();
   ();

  // private member functions
  variable_value & () ;

  // friend functions
   
  (basic_parsed_options< , variables_map &, );
};

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.

variables_map public construct/copy/destruct

  1. ();
  2. (abstract_variables_map * next);

variables_map public member functions

  1. variable_value & ( name) ;
  2.  ();
  3.  ();

variables_map private member functions

  1. variable_value & ( name) ;

    Implementation of abstract_variables_map::get which does 'find' in *this.

variables_map friend functions

  1.  
    (basic_parsed_options<  options, variables_map & xm, 
           utf8);

    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.


PrevUpHomeNext