libCZI::LibCZICZIParseException Struct Reference

Exception for signaling errors parsing the CZI-stream. More...

#include <libCZI_exceptions.h>

Inheritance diagram for libCZI::LibCZICZIParseException:

Public Types
enum class	ErrorCode { NotEnoughData , CorruptedData , NonConformingSubBlockDimensionEntry , InternalError }
	Values that represent different error conditions. More...

Public Member Functions
	LibCZICZIParseException (const char *szErrMsg, ErrorCode code)
ErrorCode	GetErrorCode () const
Public Member Functions inherited from libCZI::LibCZIException
	LibCZIException (const char *szErrMsg)

Detailed Description

Exception for signaling errors parsing the CZI-stream.

Member Enumeration Documentation

ErrorCode

enum libCZI::LibCZICZIParseException::ErrorCode

strong

Values that represent different error conditions.

Enumerator
NotEnoughData	An enum constant representing that not the expected amount of data could be read.
CorruptedData	An enum constant representing that the data was detected to be bogus.
NonConformingSubBlockDimensionEntry	An enum constant representing that the dimension-entry of a subblock was found to be non-conforming.
InternalError	An internal error was detected.

Constructor & Destructor Documentation

LibCZICZIParseException()

libCZI::LibCZICZIParseException::LibCZICZIParseException ( const char *  szErrMsg, ErrorCode  code  )

inline

Constructor for the LibCZICZIParseException. This type is used to signal that there was a parsing error.

Parameters

szErrMsg	Message describing the error.
code	The error code.

Member Function Documentation

GetErrorCode()

ErrorCode libCZI::LibCZICZIParseException::GetErrorCode ( ) const

inline

Gets error code.

Returns

The error code.

---

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

• libCZI/libCZI_exceptions.h