|
Astra Linux Directory Client Core API
1.7.0
|
См. документацию.
57 inline const string &
name()
const {
return m_strName;}
59 inline int ident()
const {
return m_iShortIdent;}
61 inline bool IsActive()
const {
return m_bActive;}
63 inline bool multiple()
const {
return m_bMultiple;}
65 inline bool mandatory()
const {
return m_bMandatory;}
86 bool bMultiple =
false,
bool bMandatory =
false);
129 inline size_t Size()
const {
return m_mapOptions.size();}
154 inline const string &
section()
const {
return m_strSection;}
156 inline const string &
name()
const {
return m_strName;}
158 inline const string &
desc()
const {
return m_strDesc;}
234 #endif // ALD_COMMAND
acArgumentNecessity hasArgument() const
Возвращает тип необходимости аргумента
Definition: ALDCommand.h:67
ald_string_list & Arguments()
Возвращает список аргументов
Definition: ALDCommand.h:79
CALDCommandPtr CommandByName(const string &strName)
Возвращает команду по имени
bool IsActive() const
Возвращает признак активности
Definition: ALDCommand.h:61
CALDCommandOption(const string &strName, int iShortIdent=0, acArgumentNecessity HasArgument=anNoArgument, acArgumentType ArgumentType=acatText, bool bMultiple=false, bool bMandatory=false)
Конструктор
int ident() const
Возвращает короткое значение
Definition: ALDCommand.h:59
acArgumentNecessity
Тип необходимости аргумента
Definition: ALDCommand.h:26
CALDCommandOptionPtr next()
Продвижение итератора с возвратом текущей опции
@ anOptionalArgument
Аргумент может быть
Definition: ALDCommand.h:29
bool CheckArguments()
Проверка аргументов по типу необходимости
void SetActive(const string &arg)
Устанавливает активность опции с указанием аргумента
shared_ptr< CALDCommand > CALDCommandPtr
Разделяемый указатель на команду
Definition: ALDCommand.h:191
bool m_bActive
Признак активности
Definition: ALDCommand.h:47
ald_string_list m_lstArguments
Список аргументов
Definition: ALDCommand.h:54
string argument() const
Возвращает текстовое представление аргумента
acArgumentNecessity m_HasArgument
Тип необходимости аргумента
Definition: ALDCommand.h:144
string m_strName
Имя опции
Definition: ALDCommand.h:50
CALDCommandOptions & Options()
Возвращает контейнер опций
Definition: ALDCommand.h:172
void Assign(const CALDCommands &Commands)
Заполнение контейнера команд содержимым другого контейнера команд
acArgumentType argumentType() const
Возвращает ожидаемый тип аргумента
Definition: ALDCommand.h:69
Класс контейнера команд
Definition: ALDCommand.h:199
void Remove(const string &strName)
Удаляет команду по имени
void AddArgument(const string &arg)
Добавляет аргумент
bool m_bMultiple
Признак множественности
Definition: ALDCommand.h:48
string m_strSection
Секция помощи
Definition: ALDCommand.h:139
void begin()
Установка итератора на начало
ald_string_list m_lstArguments
Список аргументов
Definition: ALDCommand.h:143
void RemoveCommands(CALDCommands &Commands)
Удаляет команды перечисленные в другом контейнере команд
void Add(CALDCommands &Commands)
Добавляет команду
void Add(CALDCommand *pCommand)
Добавляет команду
virtual void Clear()
Очистка состояния опции
void Add(CALDCommandOption *pOption)
Добавляет опцию
void Clear()
Очистка контейнера
@ acatHex
Шестнадцатиричное число
Definition: ALDCommand.h:36
CALDCommandOptions m_Options
Опции команды
Definition: ALDCommand.h:142
bool multiple() const
Возвращает признак множественности
Definition: ALDCommand.h:63
bool m_bPrivileged
Признак привилегированной команды
Definition: ALDCommand.h:146
CALDCommandOptionPtr OptionByName(const string &strName)
Возвращает опцию по имени
string argument() const
Возвращает текстовое представление аргумента
void Add(CALDCommandOptionPtr Option)
Добавляет опцию
void Assign(const CALDCommandOptions &Options)
Заполнение контейнера опций содержимым другого контейнера опции
Абстрактный класс IALDCore - основной интерфейс клиента Astra Linux Directory, с помощью которого вып...
Definition: ALDCore.h:242
map< string, CALDCommandPtr > ald_command_map
Карта команд (имя=>разделяемый указатель на команду
Definition: ALDCommand.h:193
ald_command_map m_mapCommands
Карта команд
Definition: ALDCommand.h:201
shared_ptr< CALDCommandOption > CALDCommandOptionPtr
Разделяемый указатель на опцию
Definition: ALDCommand.h:91
map< string, CALDCommandOptionPtr > ald_command_option_map
Карта опций (имя=>разделяемый указатель на опцию)
Definition: ALDCommand.h:94
virtual void FillRLOptions(ald_string_list &list)
Перегружаемая функция заполнения опций в ReadLine.
unsigned int uargument() const
Возвращает целое представление аргумента
acArgumentNecessity hasArgument() const
Возвращает тип необходимости аргумента
Definition: ALDCommand.h:162
virtual int Run()
Перегружаемая функция выполнения команды
IALDCore * m_pCore
Указатель на интерфейс ядра Astra Linux Directory.
Definition: ALDCommand.h:145
const string & desc() const
Возвращает описание
Definition: ALDCommand.h:158
void CopyFrom(CALDCommandOptions &Options)
Копирование опций из другого контейнера опций
ald_command_option_map::iterator m_itOption
Итератор опций
Definition: ALDCommand.h:103
acArgumentType m_ArgumentType
Ожидаемый тип аргумента
Definition: ALDCommand.h:53
virtual void FillRLArguments(const string &option, ald_string_list &list, bool &isfile)
Перегружаемая функция заполнения аргументов в ReadLine.
virtual void Clear()
Перегружаемая функция очистки аргументов и состояния опций
Базовый класс опции команды
Definition: ALDCommand.h:45
bool IsIndependent() const
Возвращает признак независимой команды
Definition: ALDCommand.h:166
acArgumentNecessity m_HasArgument
Тип необходимости аргумента
Definition: ALDCommand.h:52
void Remove(const string &strName)
Удаляет опцию по имени
int m_iShortIdent
Короткое значение
Definition: ALDCommand.h:51
Абстрактный базовый класс команды
Definition: ALDCommand.h:137
const string & name() const
Возвращает имя
Definition: ALDCommand.h:57
ald_command_option_map m_mapOptions
Карта опций
Definition: ALDCommand.h:102
@ acatNumber
Десятичное число
Definition: ALDCommand.h:35
ald_command_map::iterator m_itCommand
Итератор команд
Definition: ALDCommand.h:202
const string & section() const
Возвращает секцию команды
Definition: ALDCommand.h:154
Основной заголовочный файл, содержащий необходимый минимум предварительных объявлений и включений дру...
bool mandatory() const
Возвращает признак необходимости
Definition: ALDCommand.h:65
@ acatText
Текст
Definition: ALDCommand.h:34
Пространство имен основного интерфейса Astra Linux Directory.
Definition: action-definitions.h:10
@ anRequiredArgument
Аргумент обязателен
Definition: ALDCommand.h:28
CALDCommandPtr next()
Продвижение итератора с возвратом текущей команды
void begin()
Установка итератора на начало
void ClearOptionsState()
Очистка состояния опций контейнера
const string & name() const
Возвращает имя
Definition: ALDCommand.h:156
virtual void ShowUsage() const =0
Перегружаемая функция описания использования
Объявление основного интерфейса клиента Astra Linux Directory и необходимых для него типов и интерфей...
void SetActive()
Устанавливает активность безаргументной опции
void Clear()
Очистка контейнера опций
string m_strDesc
Описание
Definition: ALDCommand.h:141
@ anNoArgument
Аргумент не требуется
Definition: ALDCommand.h:27
virtual int Execute()=0
Перегружаемая рабочая функция команды
CALDCommandOptionPtr OptionByName(const string &strName)
Возвращет опцию по имени
Definition: ALDCommand.h:176
Класс контейнера опций команды
Definition: ALDCommand.h:100
@ acatOct
Восьмеричное число
Definition: ALDCommand.h:37
bool OptionIsActive(const string &opt)
Возвращает активность опции команды по имени
Definition: ALDCommand.h:174
CALDCommand(IALDCore &Core)
Конструктор
bool m_bMandatory
Признак необходимости
Definition: ALDCommand.h:49
list< string > ald_string_list
Список строк
Definition: ALDUtils.h:152
bool IsActive(const string &opt)
Возвращает активность опци по имени
void Add(CALDCommandPtr Command)
Добавляет команду
bool IsPrivileged() const
Возвращает признак привилегированной команды
Definition: ALDCommand.h:164
@ acatTPeriod
Период времени
Definition: ALDCommand.h:38
acArgumentType
Ожидаемый тип аргумента
Definition: ALDCommand.h:33
bool m_bIndependent
Признак независимой команды
Definition: ALDCommand.h:147
size_t Size() const
Размер контейнера (количество опций)
Definition: ALDCommand.h:129
string m_strName
Имя
Definition: ALDCommand.h:140
size_t Size() const
Размер контейнера (количество команд)