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

Class options_description

boost::program_options::options_description

Synopsis

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

class options_description {
public:
  // construct/copy/destruct
  options_description(unsigned = m_default_line_length, 
                      unsigned = m_default_line_length/2);
  options_description(const std::string &, unsigned = m_default_line_length, 
                      unsigned = m_default_line_length/2);
  // public member functions
  void add(shared_ptr< option_description >);
  options_description & add(const options_description &);
  unsigned get_option_column_width() const;
  options_description_easy_init add_options();
  const option_description & 
  find(const std::string &, bool, bool = false, bool = false) const;
  const option_description * 
  find_nothrow(const std::string &, bool, bool = false, bool = false) const;
  const std::vector< shared_ptr< option_description > > & options() const;
  void print(std::ostream &, unsigned = 0) const;
  // friend functions
  friend BOOST_PROGRAM_OPTIONS_DECL std::ostream & 
  operator<<(std::ostream &, const options_description &);
  // public data members
  static const unsigned m_default_line_length;
};

Description

Набор описаний опций. Это обеспечивает удобный интерфейс для добавления нового метода опции (Add_options) и возможности поиска опций по имени.

Смотрите здесь для добавления опции обсуждения интерфейса.

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

Option_description

`options_description` public construct/copy/destruct

опции_описаниелиния_длина=m_default_line_длина,неподписаннаямин_описание_длина=m_default_line_длина/2;

Создает экземпляр.

```
conststd::строка&подпись,неподписаннаялиния_длина=m_default_line_длина,неподписаннаяm_default_line_длинаm_default_line_длина/2;
```
Создает экземпляр. Параметр «caption» дает название этому экземпляруoptions_description. В первую очередь полезны для производства. В «description_length» указывается количество столбцов, которые должны быть зарезервированы для текста описания; если текст опции посягает на это, то описание начнется на следующей строке.

`options_description` public member functions

```
voidaddshared_ptr<option_description>desc;
```
Добавлено новое описание переменных. Бросает duplicate_variable_error, если короткое или длинное имя совпадает с уже существующим.
```
options_description&addconstoptions_description&desc];
```
Добавляет группу опций описания. Это имеет тот же эффект, что и добавление всех опционов в «desc» отдельно, за исключением того, что оператор вывода покажет отдельную группу. Возвращает *это.
```
unsignedget_option_column_widthconst;
```
Найдите максимальную ширину колонки опций, включая опции в группах.
```
options_description_easy_initadd_options;
```
Возвращает объект реализации определенного типа, пригодный для добавления опций вoptions_description. Возвращенный объект будет иметь перегруженного оператора() с параметрами типа, соответствующими конструкторам. Позвонив оператору, создадим новыйопцию_описаниеэкземпляр и добавим его.

constoption_description&findstd&name,boolapprox,boollong_ignore_case=boolshort_ignore_case=falseconst

constoption_descriptionfind_nothrowconststd&название,boolapprox,boollong_ignore_case=boolshort_ignore_case=falseconst;

conststd::вектор<shared_ptr<option_description>>&const;

```
voidprintstd::ostream&os,неподписаннаяширина=0const;
```
Выходы 'desc' в указанный поток, вызывающие 'f' для вывода каждогоэлемента опции_описания.

`options_description` friend functions

```
другBOOST_PROGRAM_OPTIONS_DECLstd::ostream&операторstdostream&os,constопции_описание&desc;
```
Производит считываемый человеком выход «desc», перечисляя варианты, их описания и разрешенные параметры. Другиеэкземпляры, ранее переданные для добавления, будут выводиться отдельно.

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

Class options_description

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

Boost C++ Libraries

Class options_description

Synopsis

Description

options_description public construct/copy/destruct

options_description public member functions

options_description friend functions

`options_description` public construct/copy/destruct

`options_description` public member functions

`options_description` friend functions