libCZI
Reading CZI documents made easy
libCZI::LibCZIQueryParseException Class Reference

Exception for signaling errors when parsing a query-string. More...

#include <libCZI_exceptions.h>

Inheritance diagram for libCZI::LibCZIQueryParseException:
libCZI::LibCZIException

Public Types

enum  ErrorType { SyntaxError, UnbalancedParenthesis, IllformedExpression, InvalidNumberFormat }
 Values that represent different error conditions.
 

Public Member Functions

 LibCZIQueryParseException (const char *szErrMsg, ErrorType errorType)
 
 LibCZIQueryParseException (const char *szErrMsg, ErrorType errorType, int indexOfParseError)
 
ErrorType GetErrorType () const
 
int GetPositionAfterWhichParserErrorOccurred () const
 
- Public Member Functions inherited from libCZI::LibCZIException
 LibCZIException (const char *szErrMsg)
 

Detailed Description

Exception for signaling errors when parsing a query-string.

Constructor & Destructor Documentation

◆ LibCZIQueryParseException() [1/2]

libCZI::LibCZIQueryParseException::LibCZIQueryParseException ( const char *  szErrMsg,
ErrorType  errorType 
)
inline

Constructor for the LibCZIQueryParseException-exception. This exception is used to signal errors when parsing a query-string.

Parameters
szErrMsgMessage describing the error.
errorTypeType of the error.

◆ LibCZIQueryParseException() [2/2]

libCZI::LibCZIQueryParseException::LibCZIQueryParseException ( const char *  szErrMsg,
ErrorType  errorType,
int  indexOfParseError 
)
inlineexplicit

Constructor for the LibCZIQueryParseException-exception. This exception is used to signal errors when parsing a query-string.

Parameters
szErrMsgMessage describing the error.
errorTypeType of the error.
indexOfParseErrorThe index to the character of the query string where the error was detected. If negative, this value is not valid.

Member Function Documentation

◆ GetErrorType()

ErrorType libCZI::LibCZIQueryParseException::GetErrorType ( ) const
inline

Gets error type

Returns
The error type.

◆ GetPositionAfterWhichParserErrorOccurred()

int libCZI::LibCZIQueryParseException::GetPositionAfterWhichParserErrorOccurred ( ) const
inline

Gets position of the character in the query-string after which the parser error occurred. If negative, this value is not valid.

Returns
The position after which parser error occurred.

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