Woolz Image Processing  Version 1.8.3
WlzError.h
Go to the documentation of this file.
1 #ifndef WLZ_ERROR_H
2 #define WLZ_ERROR_H
3 #if defined(__GNUC__)
4 #ident "University of Edinburgh $Id: 84044fb8797ac1d0279153bdbfdf7e7cddb82dfe $"
5 #else
6 static char _WlzError_h[] = "University of Edinburgh $Id: 84044fb8797ac1d0279153bdbfdf7e7cddb82dfe $";
7 #endif
8 /*!
9 * \file libWlz/WlzError.h
10 * \author Bill Hill
11 * \date March 1999
12 * \version $Id: 84044fb8797ac1d0279153bdbfdf7e7cddb82dfe $
13 * \par
14 * Address:
15 * MRC Human Genetics Unit,
16 * MRC Institute of Genetics and Molecular Medicine,
17 * University of Edinburgh,
18 * Western General Hospital,
19 * Edinburgh, EH4 2XU, UK.
20 * \par
21 * Copyright (C), [2012],
22 * The University Court of the University of Edinburgh,
23 * Old College, Edinburgh, UK.
24 *
25 * This program is free software; you can redistribute it and/or
26 * modify it under the terms of the GNU General Public License
27 * as published by the Free Software Foundation; either version 2
28 * of the License, or (at your option) any later version.
29 *
30 * This program is distributed in the hope that it will be
31 * useful but WITHOUT ANY WARRANTY; without even the implied
32 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
33 * PURPOSE. See the GNU General Public License for more
34 * details.
35 *
36 * You should have received a copy of the GNU General Public
37 * License along with this program; if not, write to the Free
38 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
39 * Boston, MA 02110-1301, USA.
40 * \brief Definitions of Woolz error codes.
41 * \ingroup WlzError
42 */
43 
44 #ifndef WLZ_EXT_BIND
45 #ifdef __cplusplus
46 extern "C" {
47 #endif /* __cplusplus */
48 #endif /* WLZ_EXT_BIND */
49 
50 /*!
51 * \enum _WlzErrorNum
52 * \ingroup WlzError
53 * \brief Woolz error codes (or error numbers) have an integer value
54 * with WLZ_ERR_NONE, the no error code, defined to be zero.
55 * Typedef: WlzErrorNum.
56 */
57 typedef enum _WlzErrorNum
58 {
59  WLZ_ERR_NONE = 0, /*!< No error, defined to be zero. */
60  WLZ_ERR_EOO, /*!< End of objects, not necessarily an
61  error. */
62  WLZ_ERR_OBJECT_NULL, /*!< Object pointer NULL. */
63  WLZ_ERR_OBJECT_TYPE, /*!< Object type is invalid or
64  inappropriate. */
65  WLZ_ERR_OBJECT_DATA, /*!< Object data is invalid or
66  inappropriate. */
67  WLZ_ERR_DOMAIN_NULL, /*!< Domain pointer NULL. */
68  WLZ_ERR_DOMAIN_TYPE, /*!< Domain type is invalid or
69  inappropriate. */
70  WLZ_ERR_DOMAIN_DATA, /*!< Domain data is invalid or
71  inappropriate. */
72  WLZ_ERR_VALUES_NULL, /*!< Values pointer NULL. */
73  WLZ_ERR_VALUES_TYPE, /*!< Values type is invalid or
74  inappropriate. */
75  WLZ_ERR_VALUES_DATA, /*!< Values data is invalid or
76  inappropriate. */
77  WLZ_ERR_PROPERTY_NULL, /*!< Property pointer NULL. */
78  WLZ_ERR_PROPERTY_TYPE, /*!< Property type is invalid or
79  inappropriate. */
80  WLZ_ERR_GMELM_NULL, /*!< Geometric model element pointer is
81  NULL. */
82  WLZ_ERR_GMELM_TYPE, /*!< Geometric model element type is invalid
83  or inappropriate. */
84  WLZ_ERR_GMELM_DATA, /*!< Geometric model element data is invalid
85  or inappropriate. */
86  WLZ_ERR_PARAM_NULL, /*!< A library function parameter is NULL. */
87  WLZ_ERR_PARAM_TYPE, /*!< A library function parameter's type is
88  invalid or inappropriate. */
89  WLZ_ERR_PARAM_DATA, /*!< A library function parameter's data is
90  invalid or inappropriate. */
91  WLZ_ERR_INT_DATA, /*!< Data is not int. */
92  WLZ_ERR_SHORT_DATA, /*!< Data is not short. */
93  WLZ_ERR_UBYTE_DATA, /*!< Data is not unsigned byte. */
94  WLZ_ERR_FLOAT_DATA, /*!< Data is not float. */
95  WLZ_ERR_DOUBLE_DATA, /*!< Data is not double. */
96  WLZ_ERR_GREY_TYPE, /*!< Grey value type is invalid or
97  inappropriate. */
98  WLZ_ERR_GREY_DATA, /*!< Grey value data is invalid or
99  inappropriate. */
100  WLZ_ERR_PLANEDOMAIN_TYPE, /*!< Plane domain type is invalid or
101  inappropriate. */
102  WLZ_ERR_PLANEDOMAIN_DATA, /*!< Plane domain data is invalid or
103  inappropriate. */
104  WLZ_ERR_INTERVALDOMAIN_NULL, /*!< Interval domain pointer is NULL. */
105  WLZ_ERR_INTERVALDOMAIN_TYPE, /*!< Interval domain type is invalid or
106  inappropriate. */
107  WLZ_ERR_INTERVALLINE_NULL, /*!< Interval line pointer is NULL. */
108  WLZ_ERR_INTERVAL_NULL, /*!< Interval pointer is NULL. */
109  WLZ_ERR_INTERVAL_DATA, /*!< Interval data is invalid. */
110  WLZ_ERR_INTERVAL_ADJACENT, /*!< Interval is adjacent to another
111  interval. */
112  WLZ_ERR_INTERVAL_BOUND, /*!< Interval bounds are invalid. */
113  WLZ_ERR_INTERVAL_NUMBER, /*!< Number of intervals is incorrect. */
114  WLZ_ERR_TRANSFORM_NULL, /*!< Transform is NULL. */
115  WLZ_ERR_TRANSFORM_DATA, /*!< Transform data is invalid or
116  inappropriate. */
117  WLZ_ERR_TRANSFORM_TYPE, /*!< Transform type is invalid or
118  inappropriate. */
119  WLZ_ERR_VOXELVALUES_TYPE, /*!< Voxel values type is invalid or
120  inappropriate. */
121  WLZ_ERR_COLUMN_DATA, /*!< Domain column bounds are invalid. */
122  WLZ_ERR_LINE_DATA, /*!< Domain line bounds are invalid. */
123  WLZ_ERR_PLANE_DATA, /*!< Domain plane bounds are invalid. */
124  WLZ_ERR_BINARY_OPERATOR_TYPE, /*!< Binary operator type is invalid. */
125  WLZ_ERR_COMPTHRESH_TYPE, /*!< Automatic threshold computation method
126  is invalid. */
127  WLZ_ERR_CONNECTIVITY_TYPE, /*!< Connectivity type is invalid or
128  inappropriate. */
129  WLZ_ERR_INTERPOLATION_TYPE, /*!< Interpolation method is invalid or
130  inappropriate. */
131  WLZ_ERR_POLYGON_TYPE, /*!< Polygon type is invalid or
132  inappropriate. */
133  WLZ_ERR_RASTERDIR_TYPE, /*!< Raster direction is invalid or
134  inappropriate. */
135  WLZ_ERR_LINKCOUNT_DATA, /*!< Link count value is invalid because an
136  object, domain or value table or some
137  other element has been freed. */
138  WLZ_ERR_MEM_ALLOC, /*!< Memory allocation failure. */
139  WLZ_ERR_MEM_FREE, /*!< Memory freeing failure. */
140  WLZ_ERR_READ_EOF, /*!< End of file encountered when reading an
141  object, not necessarily an error. */
142  WLZ_ERR_READ_INCOMPLETE, /*!< End of file or some other error
143  during an object being read. */
144  WLZ_ERR_WRITE_EOF, /*!< End of file encountered when writing to
145  a file. */
146  WLZ_ERR_WRITE_INCOMPLETE, /*!< End of file or some other error during
147  an object being written. */
148  WLZ_ERR_ALG, /*!< General algorithm failure. */
149  WLZ_ERR_ALG_SINGULAR, /*!< Algorithm failure due to a singular
150  matrix or value. */
151  WLZ_ERR_ALG_HOMOGENEOUS, /*!< Algorithm failure due to a homogeneous
152  matrix. */
153  WLZ_ERR_ALG_CONDITION, /*!< Algorithm matrix condition number. */
154  WLZ_ERR_ALG_CONVERGENCE, /*!< Algorithm convergence failure. */
155  WLZ_ERR_ALG_NONGLOBAL, /*!< Algorithm convergence to local not
156  global solution. */
157  WLZ_ERR_UNIMPLEMENTED, /*!< A function has not been implemented. */
158  WLZ_ERR_UNSPECIFIED, /*!< All other errors. */
159  WLZ_ERR_FILE_OPEN, /*!< Error opening a file */
160  WLZ_ERR_FILE_FORMAT, /*!< Format error in input stream or file */
161  WLZ_ERR_IMAGE_TYPE, /*!< Invalid image type for Woolz */
162  WLZ_ERR_DEGENERATE, /*!< Degenerate case, eg planar not volume
163  or all vertices equal. */
164  /* Keep WLZ_ERR_COUNT the last enumerator! */
165  WLZ_ERR_COUNT /*!< Not an error but the number of errors! */
166 } WlzErrorNum;
167 
168 #ifndef WLZ_EXT_BIND
169 #ifdef __cplusplus
170 }
171 #endif /* __cplusplus */
172 #endif /* WLZ_EXT_BIND */
173 
174 #endif /* !WLZ_ERROR_H Don't put anything after this line */
Definition: WlzError.h:135
Definition: WlzError.h:72
Definition: WlzError.h:133
Definition: WlzError.h:94
Definition: WlzError.h:159
Definition: WlzError.h:161
Definition: WlzError.h:77
Definition: WlzError.h:60
Definition: WlzError.h:80
Definition: WlzError.h:155
Definition: WlzError.h:102
Definition: WlzError.h:93
Definition: WlzError.h:131
Definition: WlzError.h:67
Definition: WlzError.h:114
Definition: WlzError.h:109
Definition: WlzError.h:153
Definition: WlzError.h:123
Definition: WlzError.h:84
Definition: WlzError.h:158
Definition: WlzError.h:107
Definition: WlzError.h:138
Definition: WlzError.h:82
Definition: WlzError.h:98
Definition: WlzError.h:95
Definition: WlzError.h:125
Definition: WlzError.h:63
Definition: WlzError.h:89
Definition: WlzError.h:124
Definition: WlzError.h:154
Definition: WlzError.h:75
Definition: WlzError.h:104
Definition: WlzError.h:162
Definition: WlzError.h:65
Definition: WlzError.h:149
Definition: WlzError.h:110
Definition: WlzError.h:146
Definition: WlzError.h:160
Definition: WlzError.h:68
Definition: WlzError.h:91
Definition: WlzError.h:73
Definition: WlzError.h:139
Definition: WlzError.h:92
Definition: WlzError.h:165
Definition: WlzError.h:113
Definition: WlzError.h:115
Definition: WlzError.h:59
Definition: WlzError.h:121
Definition: WlzError.h:105
_WlzErrorNum
Woolz error codes (or error numbers) have an integer value with WLZ_ERR_NONE, the no error code...
Definition: WlzError.h:57
Definition: WlzError.h:117
Definition: WlzError.h:142
Definition: WlzError.h:157
Definition: WlzError.h:112
Definition: WlzError.h:62
Definition: WlzError.h:119
Definition: WlzError.h:144
Definition: WlzError.h:78
enum _WlzErrorNum WlzErrorNum
Definition: WlzError.h:86
Definition: WlzError.h:108
Definition: WlzError.h:129
Definition: WlzError.h:151
Definition: WlzError.h:127
Definition: WlzError.h:87
Definition: WlzError.h:148
Definition: WlzError.h:96
Definition: WlzError.h:122
Definition: WlzError.h:140
Definition: WlzError.h:100
Definition: WlzError.h:70