Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class abstract_variables_map

boost::program_options::abstract_variables_map

Synopsis

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


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

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

  // private member functions
  variable_value & () ;
};

Description

Implements string->string mapping with convenient value casting facilities.

abstract_variables_map public construct/copy/destruct

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

abstract_variables_map public member functions

  1. variable_value & ( name) ;

    Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.

    • if there's no value in *this.

      • if there's next variable map, returns value from it

      • otherwise, returns empty value

    • if there's defaulted value

      • if there's next variable map, which has a non-defaulted value, return that

      • otherwise, return value from *this

    • if there's a non-defaulted value, returns it.

  2.  (abstract_variables_map * next);

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

abstract_variables_map private member functions

  1. variable_value & ( name) ;

    Returns value of variable 'name' stored in *this, or empty value otherwise.


PrevUpHomeNext