Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class value_semantic

boost::program_options::value_semantic

Synopsis

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


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

  // public member functions
   () ;
   () ;
   () ;
   () ;
   () ;
   
  (, , ) ;
   () ;
   () ;
};

Description

Class which specifies how the option's value is to be parsed and converted into C++ types.

value_semantic public construct/copy/destruct

  1. ~();

value_semantic public member functions

  1.  () ;

    Returns the name of the option. The name is only meaningful for automatic help message.

  2.  () ;

    The minimum number of tokens for this option that should be present on the command line.

  3.  () ;

    The maximum number of tokens for this option that should be present on the command line.

  4.  () ;

    Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded.

  5.  () ;

    Returns true if value must be given. Non-optional value

  6.  
    ( value_store,  new_tokens, 
           utf8) ;

    Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once.

  7.  ( value_store) ;

    Called to assign default value to 'value_store'. Returns true if default value is assigned, and false if no default value exists.

  8.  ( value_store) ;

    Called when final value of an option is determined.


PrevUpHomeNext