hoover_chess_utils::pgn_reader::PgnError Class Reference

PGN error exception. More...

#include <pgnreader-error.h>

Inheritance diagram for hoover_chess_utils::pgn_reader::PgnError:

Collaboration diagram for hoover_chess_utils::pgn_reader::PgnError:

Public Member Functions
	PgnError (PgnErrorCode code, std::string_view details)
	Constructor: error code and error message.
	PgnError (const PgnScanner &scanner, const PgnError &ex)
	Constructor: adds position to a PGN error.
const char *	what () const noexcept override
	Returns the error message.
PgnErrorCode	getCode () const noexcept
	Returns the error code.

Static Public Member Functions
static std::string_view	getStringForCode (PgnErrorCode code) noexcept
	Returns error string for code.

Private Attributes
std::string	m_str
	Error string.
PgnErrorCode	m_code
	Error code.

Detailed Description

PGN error exception.

Constructor & Destructor Documentation

PgnError() [1/2]

hoover_chess_utils::pgn_reader::PgnError::PgnError	(	PgnErrorCode	code,
		std::string_view	details
	)

Constructor: error code and error message.

Parameters

[in]	code	Error code
[in]	details	Error message (additional details)

PgnError() [2/2]

hoover_chess_utils::pgn_reader::PgnError::PgnError	(	const PgnScanner &	scanner,
		const PgnError &	ex
	)

Constructor: adds position to a PGN error.

Parameters

[in]	scanner	Tokenizer for error location
[in]	ex	Exception

Member Function Documentation

getCode()

PgnErrorCode hoover_chess_utils::pgn_reader::PgnError::getCode ( ) const

inlinenoexcept

Returns the error code.

Returns

Error code

getStringForCode()

static std::string_view hoover_chess_utils::pgn_reader::PgnError::getStringForCode ( PgnErrorCode  code )

staticnoexcept

Returns error string for code.

Parameters

[in]

code

Error code

Returns

Error string

what()

const char * hoover_chess_utils::pgn_reader::PgnError::what ( ) const

inlineoverridenoexcept

Returns the error message.

Returns

Error message

Member Data Documentation

m_code

PgnErrorCode hoover_chess_utils::pgn_reader::PgnError::m_code

private

Error code.

m_str

std::string hoover_chess_utils::pgn_reader::PgnError::m_str

private

Error string.

---

The documentation for this class was generated from the following file:

• pgn-reader/include/pgnreader-error.h