Class option_description . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Class option_description

boost::program_options::option_description

Synopsis

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

class option_description {
public:
  enum match_result { no_match, full_match, approximate_match };
  // construct/copy/destruct
  option_description();
  option_description(const char *, const value_semantic *);
  option_description(const char *, const value_semantic *, const char *);
  ~option_description();
  // public member functions
  match_result match(const std::string &, bool, bool, bool) const;
  const std::string & key(const std::string &) const;
  std::string canonical_display_name(int = 0) const;
  const std::string & long_name() const;
  const std::string & description() const;
  shared_ptr< const value_semantic > semantic() const;
  std::string format_name() const;
  std::string format_parameter() const;
  // private member functions
  option_description & set_name(const char *);
};

Description

Описывает одну из возможных опций командной строки / файла конфигурации. Существует два вида свойств опциона. Сначала описать его синтаксически и используются только для проверки ввода. Второе влияет на интерпретацию опциона, например, значение по умолчанию для него или функцию, которая должна называться, когда значение, наконец, известно. Рутины, которые выполняют разбор, никогда не используют свойства второго рода — они не имеют побочных эффектов.

Смотрите также:

Варианты_описание

`option_description` public construct/copy/destruct

<
```
option_description();
```
>
<
```
option_description(constchar*name,constvalue_semantic*s);
```
>
Инициализирует объект с переданными данными.
Примечание: было бы неплохо сделать второй параметр auto_ptr, чтобы явно передать право собственности. К сожалению, это часто необходимо для создания объектов типов, полученных из<value_semantic>:<options_description>d; d.add_options()("a", parameter("n")->default_value(1)); Здесь статический тип, возвращаемый «параметром», должен быть получен из<value_semantic>.
Увы, производное->конверсия базы для auto_ptr на самом деле не работает, см.http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html #84
Итак, мы должны использовать простые старые указатели. Кроме того, пользователи не должны использовать конструктор напрямую.
Параметр «имя» интерпретируется следующими правилами:
- если нет «», символ в «имя», он указывает длинное имя
- в противном случае, часть перед "", указывает длинное имя и часть после - короткое имя.

option_description(constchar*name,constvalue_semantic*s,
                  constchar*description);

Инициирует класс с переданными данными.

<
```
~option_description();
```
>

`option_description` public member functions

<
```
match_result
match(conststd::string&option,boolapprox,boollong_ignore_case,
     boolshort_ignore_case)const;
```
>
С учетом "варианта", указанного в источнике ввода, возвращается "истинно", если "вариант" указывает *это.
<
```
conststd::string&key(conststd::string&option)const;
```
>
Возвращает ключ, который должен идентифицировать опцию, в частности в классе<variables_map>. Параметр «вариант» - это орфография опции от источника ввода. Если имя опции содержит «*», возвращает «вариант». Если было указано длинное имя, это длинное имя, в противном случае это короткое имя с заранее подготовленным '-'
.
<
```
std::stringcanonical_display_name(intcanonical_option_style=0)const;
```
>
Возвращает каноническое имя описания опции, чтобы пользователь мог распознать соответствующую опцию. 1) Для коротких вариантов ('-', '/') возвращается короткое имя с приставкой. 2) Для длинных вариантов ('–'/'-) возвращается длинное имя с префиксом 3) Все остальные случаи возвращают длинное имя (если оно присутствует) или короткое имя, неисправленное.
<
```
conststd::string&long_name()const;
```
>
<
```
conststd::string&description()const;
```
>Объяснение этого варианта.
```
shared_ptr<constvalue_semantic>semantic()const;
```
Семантика значения опциона.
```
std::stringformat_name()const;
```
Возвращает имя опции, отформатированное соответствующим образом для сообщения об использовании.
<
```
std::stringformat_parameter()const;
```
>
Возвращает имя параметра и свойства, отформатированные соответствующим образом для сообщения об использовании.

`option_description` private member functions

option_description&set_name(constchar*name);

Статья Class option_description раздела The Boost C++ Libraries BoostBook Documentation Subset Reference может быть полезна для разработчиков на c++ и boost.

Class option_description

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Boost C++ Libraries

Class option_description

Synopsis

Description

option_description public construct/copy/destruct

option_description public member functions

option_description private member functions

`option_description` public construct/copy/destruct

`option_description` public member functions

`option_description` private member functions