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

Inheritance diagram for libCZI::LibCZIWriteException:

Public Types
enum class	ErrorType { AddCoordinateContainsUnexpectedDimension , AddCoordinateAlreadyExisting , AddAttachmentAlreadyExisting , NotEnoughDataWritten , GetDataCallError , SubBlockCoordinateOutOfBounds , SubBlockCoordinateInsufficient }
	Values that represent different error conditions. More...

Public Member Functions
	LibCZIWriteException (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 CziWriter-object.

Member Enumeration Documentation

strong

Values that represent different error conditions.

Enumerator
AddCoordinateContainsUnexpectedDimension	the coordinate of the subblock to be added contains a dimension that was not expected.
AddCoordinateAlreadyExisting	A subblock with the same coordinate and same M-index was added before.
AddAttachmentAlreadyExisting	An attachment with the same key was added before.
NotEnoughDataWritten	A write-operation reported that less data was written than requested.
GetDataCallError	A call to a getData-functor gave an invalid result.
SubBlockCoordinateOutOfBounds	The subblock's coordinate was determined to be out-of-bounds.
SubBlockCoordinateInsufficient	The subblock's coordinate was determined to be insufficient.

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

inline

Constructor for the LibCZIWriteException. This type is used to signal that an error occurred during writing to a CZI.

Parameters

szErrMsg	Message describing the error.
code	The error code.

ErrorType libCZI::LibCZIWriteException::GetErrorType ( ) const

inline

Gets error code.

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