libCZI::LibCZIReaderWriteException Class Reference

Exception for signaling errors when using the CziReaderWriter-object. More...

#include <libCZI_exceptions.h>

Inheritance diagram for libCZI::LibCZIReaderWriteException:

Public Types
enum class	ErrorType { InvalidSubBlkId , InvalidAttachmentId , AddCoordinateAlreadyExisting , AddAttachmentAlreadyExisting }
	Values that represent different error conditions. More...

Public Member Functions
	LibCZIReaderWriteException (const char *szErrMsg, ErrorType code)
ErrorType	GetErrorType () const
Public Member Functions inherited from libCZI::LibCZIException
	LibCZIException (const char *szErrMsg)

Detailed Description

Exception for signaling errors when using the CziReaderWriter-object.

Member Enumeration Documentation

ErrorType

enum class libCZI::LibCZIReaderWriteException::ErrorType

strong

Values that represent different error conditions.

Enumerator
InvalidSubBlkId	An invalid subblock-id was specified.
InvalidAttachmentId	An invalid attachment-id was specified.
AddCoordinateAlreadyExisting	A subblock with the same coordinate and same M-index was added before.
AddAttachmentAlreadyExisting	An attachment with the same key was added before.

Constructor & Destructor Documentation

LibCZIReaderWriteException()

libCZI::LibCZIReaderWriteException::LibCZIReaderWriteException ( const char *  szErrMsg, ErrorType  code  )

inline

Constructor for the LibCZIReaderWriteException. This type is used to signal errors when using the CziReaderWriter-object.

Parameters

szErrMsg	Message describing the error.
code	The error code.

Member Function Documentation

GetErrorType()

ErrorType libCZI::LibCZIReaderWriteException::GetErrorType ( ) const

inline

Gets error code.

Returns

The error code.

---

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

• libCZI/libCZI_exceptions.h