CYIParsingError Class Reference

Detailed Description

A class to store errors in the parsing of encoded data, such as JSON or XML.

#include <utility/YiParsingError.h>

Public Types
enum	PARSING_ERROR {   NONE = 0,   DATA_HAS_ERROR,   INVALID_OBJECT,   DATA_FIELD_MISSING,   DATA_FIELD_UNRECOGNIZED,   FILE_READ_ERROR }

Public Member Functions
	CYIParsingError ()
virtual	~CYIParsingError ()
virtual int32_t	GetParsingErrorCode () const
virtual CYIString	GetParsingErrorMessage () const
virtual void	SetParsingErrorCode (int32_t eErrorCode)
virtual void	SetParsingErrorMessage (CYIString errorMessage)
virtual bool	HasError () const
virtual bool	IsRequiredField (const CYIString &rFieldName) const

Static Public Attributes
static const CYIString	DATA_FIELD_MISSING_MESSAGE
static const CYIString	DATA_FIELD_UNRECOGNIZED_MESSAGE
static const CYIString	INVALID_OBJECT_MESSAGE
static const CYIString	FILE_READ_ERROR_MESSAGE

Member Enumeration Documentation

enum CYIParsingError::PARSING_ERROR

Enumerated type for storing the current parsing error status.

Enumerator
NONE
DATA_HAS_ERROR
INVALID_OBJECT
DATA_FIELD_MISSING
DATA_FIELD_UNRECOGNIZED
FILE_READ_ERROR

Constructor & Destructor Documentation

CYIParsingError::CYIParsingError

(

)

virtual CYIParsingError::~CYIParsingError ( )

virtual

Member Data Documentation

const CYIString CYIParsingError::DATA_FIELD_MISSING_MESSAGE

static

const CYIString CYIParsingError::DATA_FIELD_UNRECOGNIZED_MESSAGE

static

const CYIString CYIParsingError::FILE_READ_ERROR_MESSAGE

static

const CYIString CYIParsingError::INVALID_OBJECT_MESSAGE

static

---

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

• utility/YiParsingError.h