Class mgr args::Result

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

Класс mgr_args::Result

Результат разбора командной строки

#include <mgrargs.h> 

Описание:

class mgr_args::Result

Класс Args содержит внутренний указатель на результат

Классы

struct mgr_args::Result::ParamValue

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

string operator[] ( const string &name )

Получить значение параметра по имени


string Param ( const string &name , int index = -1 )

Получить значение параметра по имени


size_t ParamCount ( const string &name )

Получить количество значений параметра


bool Has ( const string &name )

Был ли использован указанный параметр


const StringVector & Args () const

Получить все значения нераспознанных параметров


string Args ( int index )

Получить значение нераспознанного параметра


size_t ArgsCount () const

Получить количество нераспознанных параметров


void SetParam ( const string &name , const string &value )

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

Методы

string operator[] ( const string &name )

Получить значение параметра по имени

Возвращает последнее значение указанное в командной строке для данного параметра. Или exception UsageError если параметр не указан

string Param ( const string &name , int index = -1 )

Получить значение параметра по имени

в отличие от оператора, позволяет получить любое из значений параметра (по умолчанию последнее)

Аргументы:
name полное имя параметра
index порядковый номер значения (начиная с 0)
Returned: В случае, если запрошенного значения нет, возвращает пустую строку
See also: ParamCount

size_t ParamCount ( const string &name )

Получить количество значений параметра

Для параметров с выставленным флагом Miltiple может быть указано множество значений. Для этого они должны быть использованы несколько раз. Например: ./a.out test 1 test 2 Параметр test получит два значения: 1 и 2. Вызов args["test"] вернет значение '2'. Вызов args.Param("test", 0) значение '1'

Returned: Возвращает количество доступных значений

bool Has ( const string &name )

Был ли использован указанный параметр

Returned: true, если параметр был передан в командной строке, и false, если не был. Наличие значения по умолчанию у параметра никак не влияет на результат данного метода
See also: Args::SetDefault

const StringVector &Args () const

Получить все значения нераспознанных параметров

В массив нераспознанных параметров попадают все неописанные параметры, а так же все параметры после "--" (первый параметр "--" в массив не заносится)

string Args ( int index )

Получить значение нераспознанного параметра

size_t ArgsCount () const

Получить количество нераспознанных параметров

void SetParam ( const string &name , const string &value )

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