Class mgr args::Args::Arg

Материал из ISPWiki
Перейти к: навигация, поиск

Класс mgr_args::Args::Arg

Вспомогательный класс для регистрации параметров

#include <mgrargs.h> 

Описание:

class mgr_args::Args::Arg


Открытые члены (кратко)

Arg & AddOption ( const string &name , char short_name , const string &help )

Добавить дополнительный параметр


Arg & AddSuboption ( const string &name , char short_name , const string &help )

Добавить зависимый параметр


Arg & SetValidator ( test::Valid valid )

Добавить валидатор для значения параметра


Arg & SetDefault ( const string &def_value )

Установить значение по умолчанию


Arg & SetGroup ( const string &group )

Объединить параметры в группу


Arg & SetRequired ()

Указать обязательный параметр


Arg & SetParam ()

Установить признак наличия аргументов у параметра


Arg & SetMultiple ()

Указывает что параметр может иметь более одного значения


Arg & Last () const

Завершает определение зависимых параметров

Приватные члены (кратко)

Методы

Arg &AddOption ( const string &name , char short_name , const string &help )

Добавить дополнительный параметр

See also: Args::AddOption

Arg &AddSuboption ( const string &name , char short_name , const string &help )

Добавить зависимый параметр

Наличие данного параметра будет анализироваться только при наличии родительского

See also: Args::AddOption
See also: Last

Arg &SetValidator ( test::Valid valid )

Добавить валидатор для значения параметра

Значение параметра будет проверено при помощи указанной функции. В случае, если проверка не пройдет будет сгенерированно Args::UsageError. Этот метод вызывает так же SetParam, если он небыл вызван ранее

See also: SetParam

Arg &SetDefault ( const string &def_value )

Установить значение по умолчанию

Если параметр небыл указан в командной строке, метод Result::Param и operator[] будет возвращать это значение Этот метод вызывает так же SetParam, если он небыл вызван ранее

Arg &SetGroup ( const string &group )

Объединить параметры в группу

Может быть использован только один параметр из группы

Arg &SetRequired ()

Указать обязательный параметр

В случае отсутствия обязательного параметра будет сгенерировано исключение Args::UsageError Этот метод вызывает так же SetParam, если он небыл вызван ранее

See also: SetParam

Arg &SetParam ()

Установить признак наличия аргументов у параметра

Параметр, следующий в командной строке за указанным будет считаться его аргументом Если было использовано короткое имя параметра, аргументы будут взяты из командной строки согласно порядку перечисления параметров в короткой записи. Например: ./a.out -asd value1 value2 если -a и -s имеют дополнительный аргумент, то -a получит значение value1, а -s значение value2 Если в комендной строке недостаточно параметров, будет сгенерированно исключение Args::UsageError

Arg &SetMultiple ()

Указывает что параметр может иметь более одного значения

Arg &Last () const

Завершает определение зависимых параметров

вызов метода AddSuboption начинает определение зависимых параметров, все параметры добавленные после этого через AddOption считаются зависищими от последнего зарегистрированного перед вызовом AddSuboption.