You.i Engine
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  ErrorType {
  ErrorType::None = 0,
  ErrorType::DataHasError,
  ErrorType::InvalidObject,
  ErrorType::DataFieldMissing,
  ErrorType::DataFieldUnrecognized,
  ErrorType::FileReadError
}
 

Public Member Functions

 CYIParsingError ()
 
virtual ~CYIParsingError ()
 
virtual ErrorType GetParsingErrorCode () const
 
virtual CYIString GetParsingErrorMessage () const
 
virtual void SetParsingErrorCode (ErrorType errorCode)
 
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

◆ ErrorType

Enumerated type for storing the current parsing error status.

Enumerator
None 
DataHasError 
InvalidObject 
DataFieldMissing 
DataFieldUnrecognized 
FileReadError 

Constructor & Destructor Documentation

◆ CYIParsingError()

CYIParsingError::CYIParsingError ( )

◆ ~CYIParsingError()

virtual CYIParsingError::~CYIParsingError ( )
virtual

Member Data Documentation

◆ DATA_FIELD_MISSING_MESSAGE

const CYIString CYIParsingError::DATA_FIELD_MISSING_MESSAGE
static

◆ DATA_FIELD_UNRECOGNIZED_MESSAGE

const CYIString CYIParsingError::DATA_FIELD_UNRECOGNIZED_MESSAGE
static

◆ FILE_READ_ERROR_MESSAGE

const CYIString CYIParsingError::FILE_READ_ERROR_MESSAGE
static

◆ INVALID_OBJECT_MESSAGE

const CYIString CYIParsingError::INVALID_OBJECT_MESSAGE
static

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