Class LibCZIWriteException

• Defined in File libCZI_exceptions.h

Inheritance Relationships

Base Type

• public libCZI::LibCZIException (Class LibCZIException)

Class Documentation

class LibCZIWriteException : public libCZI::LibCZIException

Exception for signaling errors when using the CziWriter-object.

Public Types

enum class ErrorType

Values that represent different error conditions.

Values:

enumerator AddCoordinateContainsUnexpectedDimension

the coordinate of the subblock to be added contains a dimension that was not expected.

enumerator AddCoordinateAlreadyExisting

A subblock with the same coordinate and same M-index was added before.

enumerator AddAttachmentAlreadyExisting

An attachment with the same key was added before.

enumerator NotEnoughDataWritten

A write-operation reported that less data was written than requested.

enumerator GetDataCallError

A call to a getData-functor gave an invalid result.

enumerator SubBlockCoordinateOutOfBounds

The subblock’s coordinate was determined to be out-of-bounds.

enumerator SubBlockCoordinateInsufficient

The subblock’s coordinate was determined to be insufficient.

Public Functions

inline LibCZIWriteException(const char *szErrMsg, ErrorType code)

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.

inline ErrorType GetErrorType() const

Gets error code.

Returns:

The error code.