Просмотр

== Класс CoreError ==

Класс CoreError предназначен для хранения и обработки ошибок.

Данный класс является наследником класса QObject и имеет имя "CoreError".


=== Слоты предоставляемые классом CoreError ===

Слоты предоставляемые классом CoreError:
# Загрузка перечня ошибок (Load);
# Сохранение данных в файл (Save);
# Добавление ошибки в перечень ошибок (AddError);
# Добавление ошибок в перечень ошибок (AddErrors);
# Удаление ошибки из перечня ошибок (DelError);
# Удаление ошибок из перечня ошибок (DelErrors);
# Установка текущей ошибки (SetCurrentError);
# Запрос кода текущей ошибки (GetErrorNum);
# Запрос текста текущей ошибки (GetErrorName);
# Запрос текста ошибки по коду (GetNameByNum);
# Запрос списка кодов ошибок (GetErrorNums);
# Запрос списка ошибок (GetErrors).

Перечень ошибок представляет собой сочитание кода ошибки и шаблона описания ошибки.

Пример шаблона:
 Ошибка открытия файла %1

Значение параметра "%1" берется из параметров (params) при вызове слота установки текущей ошибки (SetCurrentError). 

==== Загрузка перечня ошибок (Load) ====

Слот <b>Load</b> предназначен для загрузки перечня ошибок.

Описание:
 void Load(const QString& file, int& res);
где
* file (входной параметр) - полный или относительный путь к файлу с перечнем ошибок;
* res (выходной параметр) - результат загрузки перечня ошибок.

Параметр res может принимать следующие значения:
* 0 - загрузка выполнена успешно;
* 1 - не указано имя файла;
* 2 - ошибка чтения файла;
* -1 - создан файл.

==== Сохранение данных в файл (Save) ====

Слот <b>Save</b> предназначен для сохранения перечня ошибок.

Описание:
 void Save(const QString& file, int& res);
где
* file (входной параметр) - полный или относительный путь к файлу;
* res (выходной параметр) - результат сохранения файла.

Параметр res может принимать следующие значения:
* 0 - сохранение выполнено успешно;
* 1 - не указано имя файла;
* 2 - ошибка сохранения файла.

==== Добавление ошибки в перечень ошибок (AddError) ====

Слот <b>AddError</b> предназначен для добавления ошибки в перечень ошибок.

Описание:
 void AddError(const int& num, const QString& desc, int& res);
где
* num(входной параметр) - код ошибки;
* desc(входной параметр) - описание ошибки;
* res (выходной параметр) - результат добавления ошибки.

Параметр res может принимать следующие значения:
* 0 - добавление выполнено успешно;
* 1 - не указан код ошибки;
* 2 - не указано описание ошибки;
* -1 - такая ошибка уже существует.

==== Добавление ошибок в перечень ошибок (AddErrors) ====

Слот <b>AddErrors</b> предназначен для добавления ошибок в перечень ошибок.

Описание:
 void AddErrors(const map<int, QString>& errs, int& res);
где
* errs(входной параметр) - массив ошибок;
* res (выходной параметр) - результат добавления массива ошибок.

Параметр res может принимать следующие значения:
* 0 - добавление выполнено успешно;
* 1 - ошибка добавления.

==== Удаление ошибки из списка ошибок (DelError) ====

Слот <b>DelError</b> предназначен для удаления ошибки из перечня ошибок.

Описание:
 void DelError(const int& num, int& res);
где
* num(входной параметр) - код ошибки;
* res (выходной параметр) - результат удаления ошибки.

Параметр res может принимать следующие значения:
* 0 - удаление выполнено успешно;
* 1 - не указан код ошибки;
* -1 - такая ошибка не существует.

==== Удаление ошибок из списка ошибок (DelErrors) ====

Слот <b>DelErrors</b> предназначен для удаления ошибок из перечня ошибок.

Описание:
 void DelErrors(const vector<int>& errs, int& res);
где
* errs(входной параметр) - массив кодов ошибок;
* res (выходной параметр) - результат удаления ошибки.

Параметр res может принимать следующие значения:
* 0 - удаление выполнено успешно;
* 1 - ошибка удаления.

==== Установка текущей ошибки (SetCurrentError) ====

Слот <b>SetCurrentError</b> предназначен для установки текущей ошибки.

Описание:
 void SetCurrentError(const int& num, const QString& source, const QStringList& params);
где
* num(входной параметр) - код текущей ошибки;
* source(входной параметр) - источник ошибки;
* params(входной параметр) - параметры ошибки.

==== Запрос кода текущей ошибки (GetErrorNum) ====

Слот <b>GetErrorNum</b> предназначен для запроса кода текущей ошибки.

Описание:
 void GetErrorNum(int& cod);
где
* cod(выходной параметр) - код ошибки (0 - если нет ошибки);

==== Запрос текста текущей ошибки (GetErrorText) ====

Слот <b>GetErrorText</b> предназначен для запроса текста текущей ошибки.

Описание:
 void GetErrorText(QString& text);
где
* text(выходной параметр) - текст ошибки;

==== Запрос текста ошибки по коду (GetNameByNum) ====

Слот <b>GetNameByNum</b> предназначен для запроса текста ошибки по коду.

Описание:
 void GetNameByNum(const int& num, QString& text);
где
* num(входной параметр) - код ошибки;
* text(выходной параметр) - текст ошибки;

==== Запрос списка кодов ошибок (GetErrorNums) ====

Слот <b>GetErrorNums</b> предназначен для запроса списка кодов ошибок.

Описание:
 void GetErrorNums(vector<int>& errs);
где
* errs(выходной параметр) - массив ошибок.

==== Запрос списка ошибок (GetErrors) ====

Слот <b>GetErrors</b> предназначен для запроса списка ошибок.

Описание:
 void GetErrors(map<int, QString>& errs);
где
* errs(выходной параметр) - массив ошибок.


=== Сигналы предоставляемые классом CoreError ===

Сигналы предоставляемые классом CoreError:

=== Взаимодействие с другими классами ===