Структура err_code_t

#include <err_code.hpp>

Полный список членов класса

---

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

Код ошибки с пояснениями.

Тип предназначен для связывание в одном объекте целочисленого кода ошибки, описания места возникновения ошибки и, возможно, описания ошибки.

Открытые члены
	err_code_t (const std::string &file, int line)
	err_code_t (int_t code, const std::string &file, int line, const std::string &desc)
	err_code_t (const err_code_t &o)
	Конструктор копирования.
err_code_t &	operator= (const err_code_t &o)
	Опреатор копирования.
	operator bool () const
	Отличен ли от нуля?
bool	operator== (int c) const
	Равенство с целым.
bool	operator== (const err_code_t &o) const
	Равенство.
bool	operator!= (int c) const
	Неравенство с целым.
bool	operator!= (const err_code_t &o) const
	Неравенство.
bool	operator! () const
	Равен ли нулю?
Открытые атрибуты
int_t	m_code
	Целочисленный код ошибки.
std::string	m_file
	Имя файла, в котором был создан объект err_code_t.
int	m_line
	err_code_t.
std::string	m_desc
	Текстовое описание ошибки. Возможно пустое.

---

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

err_code_t	(	const std::string &	file,
		int	line
	)

Предназначен для кода отсутствия ошибки. Полю m_code присваивается 0, заполняются только поля m_file и m_line.

Аргументы:

file	Имя файла, в котором был создан объект err_code_t.
line	Номер строки файла, в которой был создан объект err_code_t.

err_code_t	(	int_t	code,
		const std::string &	file,
		int	line,
		const std::string &	desc
	)

Предназначен для полного определения объекта.

Аргументы:

code	Целочисленный код ошибки.
file	Имя файла, в котором был создан объект err_code_t.
line	Номер строки файла, в которой был создан объект err_code_t.
desc	Текстовое описание ошибки.

---

Методы

operator bool

(

)

const [inline]

Отличен ли от нуля?

Возвращает:

true, если m_code отличен от нуля (что свидетельствует о наличии ошибки). false, если m_code равен 0 (нет ошибки).

bool operator!

(

)

const [inline]

Равен ли нулю?

Возвращает:

true, если m_code равен 0 (нет ошибки). false, если m_code отличен от нуля (что свидетельствует о наличии ошибки).

bool operator!=

(

const err_code_t &

o

)

const [inline]

Неравенство.

Сравнивается только m_code.

bool operator!=

(

int

c

)

const [inline]

Неравенство с целым.

Предназначен для случаев:

    if( err != 3 ) ...

bool operator==

(

const err_code_t &

o

)

const [inline]

Равенство.

Сравнивается только m_code.

bool operator==

(

int

c

)

const [inline]

Равенство с целым.

Предназначен для случаев:

    if( err == 3 ) ...

---

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

std::string m_desc

Текстовое описание ошибки. Возможно пустое.

Предполагается, что для кода отсутствия ошибки (обычно 0), это поле будет пустым.

Заметки:

Предпочтительнее использовать описания, не содержащие русских букв. В противном случае в Windows возникнут проблемы с кодировками (например, консоль использует CP866, а оконная система -- CP1251).

int m_line

err_code_t.

Предполагается, что для задания этого поля всегда будет использоваться стандартный марос __LINE__.

---

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

• oess_1/defs/h/err_code.hpp
• oess_1/defs/err_code.cpp

---