Класс Error

Класс Error представляет собой контейнер для кода ошибки и текстового сообщения, применяемый для унифицированной обработки сбоев в API RuntimeManager. Подробнее...

Подключение:

#include <RuntimeManager/Error>

Публичные типы

enum Code { NoError = 0 , Failed , HandlerNotFound , HandlerFailed , InvalidParameters , NotImplemented , PermissionDenied , ProcessNotHandled , ApplicationNotRunning , ApplicationAlreadyRunning , ApplicationAlreadyLaunching }

Коды ошибок. Подробнее...

Публичные функции

Error (Code code=Code::NoError, const QString &message=QString())	Конструктор.
~Error ()=default	Деструктор.
bool isError () const	Проверяет, не представляет ли этот экземпляр ошибку.
operator bool () const	Логический оператор.
Code code () const	Получает код ошибки.
QString message () const	Получает текстовое сообщение об ошибке.

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

Обработка ошибок.

Класс Error предназначен для унифицированной обработки ошибок, вызванных API RuntimeManager. Использование данного класса позволяет разработчику получать информацию о коде ошибки и сопутствующем текстовом сообщении, а также проверять успешность выполнения операций.

Описание перечислений

Code

enum RuntimeManager::Error::Code

Коды ошибок.

Перечисления
NoError	Ошибки не произошло
Failed	Сбой, причина которого не указана или неизвестна
HandlerNotFound	Обработчик для запрошенной операции найден не был
HandlerFailed	Обработчику не удалось выполнить запрошенную операцию
InvalidParameters	Указанные параметры некорректны
NotImplemented	Функциональность не реализована
PermissionDenied	У вызывающей стороны недостаточно прав для выполнения операции
ProcessNotHandled	Этот процесс неизвестен менеджеру среды выполнения
ApplicationNotRunning	В данный момент приложение неактивно
ApplicationAlreadyRunning	Приложение уже запущено
ApplicationAlreadyLaunching	Приложение уже запускается

Описание конструкторов и деструктора

Error()

RuntimeManager::Error::Error (Code code = Code::NoError, const QString & message = QString() )

Конструктор.

Создаёт экземпляр ошибки. Если параметры не заданы, то экземпляр не будет содержать ошибок и будет использоваться для указания на то, что операция выполнена успешно.

Параметры

code	Код ошибки
message	Текстовое представление ошибки

Описание функций-членов

code()

Code RuntimeManager::Error::code () const

Получает код ошибки.

Возвращает код ошибки.

isError()

bool RuntimeManager::Error::isError () const

Проверяет, не представляет ли этот экземпляр ошибку.

Возвращает true если произошла ошибка, в противном случае — false.

message()

QString RuntimeManager::Error::message () const

Получает текстовое сообщение об ошибке.

Следует обратить внимание, что сообщение может быть совершенно пустым, даже если произошла ошибка. В этом случае причину следует определять по коду, возвращаемому методом code().

Возвращает текстовое представление ошибки.

См. также code, isError

operator bool()

RuntimeManager::Error::operator bool () const

Логический оператор.

Проверяет, не произошла ли ошибка. Этот оператор предоставляется для удобства. Оператор возвращает true при наличии ошибки (код отличен от NoError) и false при успешном выполнении операции.

Error error = MyObject.doSomething(...);
if (error) {
    // произошла ошибка
} else {
    // все прошло нормально
}

См. также isError