Astra Linux Directory Client Core API  1.7.0

#include "ALDCommand.h"

Граф наследования:ALD::CALDCommand:
ALD::CALDCmdCmd ALD::CALDCmdHelp ALD::CALDCmdInternalInfo ALD::CALDCmdStatus

Открытые члены

const string & section () const
 
const string & name () const
 
const string & desc () const
 
string argument () const
 
acArgumentNecessity hasArgument () const
 
bool IsPrivileged () const
 
bool IsIndependent () const
 
virtual void ShowUsage () const =0
 
virtual int Run ()
 
CALDCommandOptionsOptions ()
 
bool OptionIsActive (const string &opt)
 
CALDCommandOptionPtr OptionByName (const string &strName)
 
void AddArgument (const string &arg)
 
virtual void Clear ()
 
virtual void FillRLArguments (const string &option, ald_string_list &list, bool &isfile)
 
virtual void FillRLOptions (ald_string_list &list)
 
 CALDCommand (IALDCore &Core)
 

Защищенные члены

bool CheckArguments ()
 
virtual int Execute ()=0
 

Защищенные данные

string m_strSection
 
string m_strName
 
string m_strDesc
 
CALDCommandOptions m_Options
 
ald_string_list m_lstArguments
 
acArgumentNecessity m_HasArgument
 
IALDCorem_pCore
 
bool m_bPrivileged
 
bool m_bIndependent
 

Подробное описание

Абстрактный базовый класс команды

Конструктор(ы)

◆ CALDCommand()

ALD::CALDCommand::CALDCommand ( IALDCore Core)

Конструктор

Методы

◆ AddArgument()

void ALD::CALDCommand::AddArgument ( const string &  arg)

Добавляет аргумент

◆ argument()

string ALD::CALDCommand::argument ( ) const

Возвращает текстовое представление аргумента

◆ CheckArguments()

bool ALD::CALDCommand::CheckArguments ( )
protected

Проверка аргументов по типу необходимости

◆ Clear()

virtual void ALD::CALDCommand::Clear ( )
virtual

Перегружаемая функция очистки аргументов и состояния опций

◆ desc()

const string& ALD::CALDCommand::desc ( ) const
inline

Возвращает описание

◆ Execute()

virtual int ALD::CALDCommand::Execute ( )
protectedpure virtual

Перегружаемая рабочая функция команды

Замещается в ALD::CALDCmdInternalInfo, ALD::CALDCmdCmd, ALD::CALDCmdStatus и ALD::CALDCmdHelp.

◆ FillRLArguments()

virtual void ALD::CALDCommand::FillRLArguments ( const string &  option,
ald_string_list list,
bool &  isfile 
)
virtual

Перегружаемая функция заполнения аргументов в ReadLine.

Переопределяется в ALD::CALDCmdCmd и ALD::CALDCmdHelp.

◆ FillRLOptions()

virtual void ALD::CALDCommand::FillRLOptions ( ald_string_list list)
virtual

Перегружаемая функция заполнения опций в ReadLine.

◆ hasArgument()

acArgumentNecessity ALD::CALDCommand::hasArgument ( ) const
inline

Возвращает тип необходимости аргумента

◆ IsIndependent()

bool ALD::CALDCommand::IsIndependent ( ) const
inline

Возвращает признак независимой команды

◆ IsPrivileged()

bool ALD::CALDCommand::IsPrivileged ( ) const
inline

Возвращает признак привилегированной команды

◆ name()

const string& ALD::CALDCommand::name ( ) const
inline

Возвращает имя

◆ OptionByName()

CALDCommandOptionPtr ALD::CALDCommand::OptionByName ( const string &  strName)
inline

Возвращет опцию по имени

◆ OptionIsActive()

bool ALD::CALDCommand::OptionIsActive ( const string &  opt)
inline

Возвращает активность опции команды по имени

◆ Options()

CALDCommandOptions& ALD::CALDCommand::Options ( )
inline

Возвращает контейнер опций

◆ Run()

virtual int ALD::CALDCommand::Run ( )
virtual

Перегружаемая функция выполнения команды

◆ section()

const string& ALD::CALDCommand::section ( ) const
inline

Возвращает секцию команды

◆ ShowUsage()

virtual void ALD::CALDCommand::ShowUsage ( ) const
pure virtual

Перегружаемая функция описания использования

Замещается в ALD::CALDCmdInternalInfo, ALD::CALDCmdCmd, ALD::CALDCmdStatus и ALD::CALDCmdHelp.

Данные класса

◆ m_bIndependent

bool ALD::CALDCommand::m_bIndependent
protected

Признак независимой команды

◆ m_bPrivileged

bool ALD::CALDCommand::m_bPrivileged
protected

Признак привилегированной команды

◆ m_HasArgument

acArgumentNecessity ALD::CALDCommand::m_HasArgument
protected

Тип необходимости аргумента

◆ m_lstArguments

ald_string_list ALD::CALDCommand::m_lstArguments
protected

Список аргументов

◆ m_Options

CALDCommandOptions ALD::CALDCommand::m_Options
protected

Опции команды

◆ m_pCore

IALDCore* ALD::CALDCommand::m_pCore
protected

Указатель на интерфейс ядра Astra Linux Directory.

◆ m_strDesc

string ALD::CALDCommand::m_strDesc
protected

Описание

◆ m_strName

string ALD::CALDCommand::m_strName
protected

Имя

◆ m_strSection

string ALD::CALDCommand::m_strSection
protected

Секция помощи


Объявления и описания членов класса находятся в файле: