libCZI
Reading and Writing CZI documents made easy
libCZI::LibCZIInvalidPlaneCoordinateException Struct Reference

Exception for signaling an incorrect plane-coordinate object. More...

#include <libCZI_exceptions.h>

Inheritance diagram for libCZI::LibCZIInvalidPlaneCoordinateException:
libCZI::LibCZIException

Public Types

enum class  ErrorCode { SurplusDimension , MissingDimension , InvalidDimension , CoordinateOutOfRange }
 Values that represent different error conditions. More...
 

Public Member Functions

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

Detailed Description

Exception for signaling an incorrect plane-coordinate object.

Member Enumeration Documentation

◆ ErrorCode

Values that represent different error conditions.

Enumerator
SurplusDimension 

An enum constant representing a dimension was specified which is not found in the document.

MissingDimension 

An enum constant representing that the plane-coordinate did not contain a coordinate which is required to specify a plane.

InvalidDimension 

An enum constant representing that the plane-coordinate contained a dimension which is not used to specify a plane.

CoordinateOutOfRange 

An enum constant representing that a coordinate was given which is out-of-range.

Constructor & Destructor Documentation

◆ LibCZIInvalidPlaneCoordinateException()

libCZI::LibCZIInvalidPlaneCoordinateException::LibCZIInvalidPlaneCoordinateException ( const char *  szErrMsg,
ErrorCode  code 
)
inline

Constructor for the LibCZIInvalidPlaneCoordinateException. This type is used to signal that a plane-coordinate was determined to be invalid.

Parameters
szErrMsgMessage describing the error.
codeThe error code.

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