NeXusJavaBindings  1
 All Classes Namespaces Files Functions Variables Typedefs Macros Pages
HDFConstants.java
Go to the documentation of this file.
1 /****************************************************************************
2  * NCSA HDF *
3  * National Comptational Science Alliance *
4  * University of Illinois at Urbana-Champaign *
5  * 605 E. Springfield, Champaign IL 61820 *
6  * *
7  * For conditions of distribution and use, see the accompanying *
8  * hdf/COPYING file. *
9  * *
10  ****************************************************************************/
11 
12 package ncsa.hdf.hdflib;
13 
22 public class HDFConstants
23 {
25  public static final int FAIL = -1;
26 
27  // file access code definitions
28  public static final int DFACC_READ = 1;
29  public static final int DFACC_WRITE= 2;
30  public static final int DFACC_RDWR = 3;
31  public static final int DFACC_CREATE=4;
32  public static final int DFACC_RDONLY=DFACC_READ;
33  public static final int DFACC_DEFAULT=000;
34  public static final int DFACC_SERIAL=001;
35  public static final int DFACC_PARALLEL=011;
36 
37  // annotation type in HDF
38  public static final int AN_DATA_LABEL = 0;
39  public static final int AN_DATA_DESC = AN_DATA_LABEL + 1;
40  public static final int AN_FILE_LABEL = AN_DATA_LABEL + 2;
41  public static final int AN_FILE_DESC = AN_DATA_LABEL + 3;
42 
43  // HDF Tag Definations
44 
45  // HDF WILDCARD
46  public static final int DFTAG_WILDCARD = 0;
47  public static final int DFREF_WILDCARD = 0;
48 
49  // File identifier
50  public static final int DFTAG_FID = 100;
51 
52  // File Description
53  public static final int DFTAG_FD = 101;
54 
55  // Data Identifier Label
56  public static final int DFTAG_DIL = 104;
57 
58  // Data Identifier Annotation
59  public static final int DFTAG_DIA = 105;
60 
61  // 8-bits Raster image
62  public static final int DFTAG_RI8 = 202;
63  public static final int DFTAG_CI8 = 203;
64  public static final int DFTAG_II8 = 204;
65 
66  // 24-bits Raster image
67  public static final int DFTAG_RI = 302;
68  public static final int DFTAG_CI = 303;
69  public static final int DFTAG_RIG = 306;
70 
71  // SDS
72  public static final int DFTAG_SD = 702;
73  public static final int DFTAG_SDG = 700;
74  public static final int DFTAG_NDG = 720;
75 
76  // Vgroup or Vdata
77  public static final int DFTAG_VH = 1962;
78  public static final int DFTAG_VS = 1963;
79  public static final int DFTAG_VG = 1965;
80 
82  public static final int MFGR_INTERLACE_PIXEL = 0;
83 
85  public static final int MFGR_INTERLACE_LINE = MFGR_INTERLACE_PIXEL +1;
86 
88  public static final int MFGR_INTERLACE_COMPONENT = MFGR_INTERLACE_PIXEL +2;
89 
91  public static final int FULL_INTERLACE = 0;
92  public static final int NO_INTERLACE = 1;
93 
95  public static final int DFNT_UCHAR8 = 3;
96  public static final int DFNT_UCHAR = 3;
97 
99  public static final int DFNT_CHAR8 = 4;
100  public static final int DFNT_CHAR = 4;
101 
103  public static final int DFNT_CHAR16 = 42;
104  public static final int DFNT_UCHAR16= 43;
105 
106 
108  public static final int DFNT_FLOAT32 = 5;
109  public static final int DFNT_FLOAT = 5 ;
110 
111  //** double */
112  public static final int DFNT_FLOAT64 = 6;
113  public static final int DFNT_FLOAT128 = 7 ;
114  public static final int DFNT_DOUBLE = 6 ;
115 
117  public static final int DFNT_INT8 = 20;
118 
120  public static final int DFNT_UINT8 = 21;
121 
123  public static final int DFNT_INT16 = 22;
124 
126  public static final int DFNT_UINT16 = 23;
127 
129  public static final int DFNT_INT32 = 24;
130 
132  public static final int DFNT_UINT32 = 25;
133 
135  public static final int DFNT_INT64 = 26;
136  public static final int DFNT_UINT64 = 27;
137  public static final int DFNT_INT128 = 28;
138  public static final int DFNT_UINT128 = 30;
139  public static final int DFNT_LITEND = 0x00004000;
140 
141  public static final int DF_FORWARD = 1;
142  public static final int DFS_MAXLEN = 255;
143 
144  public static final int COMP_NONE = 0;
145  public static final int COMP_JPEG = 2;
146  public static final int COMP_RLE = 11;
147  public static final int COMP_IMCOMP = 12;
148  public static final int COMP_CODE_NONE = 0;
149  public static final int COMP_CODE_RLE = 1;
150  public static final int COMP_CODE_NBIT = 2;
151  public static final int COMP_CODE_SKPHUFF = 3;
152  public static final int COMP_CODE_DEFLATE = 4;
153  public static final int COMP_CODE_INVALID = 5;
154  public static final int COMP_MODEL_STDIO = 0;
155 
156  // Interlace schemes
157  public static final int DFIL_PIXEL = 0; /* Pixel Interlacing */
158  public static final int DFIL_LINE = 1; /* Scan Line Interlacing */
159  public static final int DFIL_PLANE = 2; /* Scan Plane Interlacing */
160 
161  public static final int SD_FILL = 0;
162  public static final int SD_NOFILL = 0x100;
163  public static final int SD_DIMVAL_BW_COMP = 1;
164  public static final int SD_DIMVAL_BW_INCOMP = 0;
165 
166  public static final int HDF_NONE = 0x0;
167  public static final int HDF_CHUNK = 0x1;
168  public static final int HDF_COMP = 0x3;
169  public static final int HDF_NBIT = 0x5;
170  public static final int MAX_VAR_DIMS =32;
171 
172  //the names of the Vgroups created by the GR interface
173  public static final String GR_NAME = "RIG0.0";
174  public static final String RI_NAME = "RI0.0";
175  public static final String RIGATTRNAME = "RIATTR0.0N";
176  public static final String RIGATTRCLASS = "RIATTR0.0C";
177 
178  // names of classes of the Vdatas/Vgroups created by the SD interface
179  public static final String HDF_ATTRIBUTE = "Attr0.0";
180  public static final String HDF_VARIABLE = "Var0.0";
181  public static final String HDF_DIMENSION = "Dim0.0";
182  public static final String HDF_UDIMENSION = "UDim0.0";
183  public static final String DIM_VALS = "DimVal0.0";
184  public static final String DIM_VALS01 = "DimVal0.1";
185  public static final String HDF_CHK_TBL = "_HDF_CHK_TBL_";
186  public static final String HDF_CDF = "CDF0.0";
187 
188  // names of data object types
189  public static final String ANNOTATION = "HDF_ANNOTATION";
190  public static final String RI8 = "HDF_RI8";
191  public static final String RI24 = "HDF_RI24";
192  public static final String GR = "HDF_GR";
193  public static final String SDS = "HDF_SDS";
194  public static final String VDATA = "HDF_VDATA";
195  public static final String VGROUP = "HDF_GROUP";
196 
197  // data types represented by Strings
198  public static final String UCHAR8 = "UCHAR8";
199  public static final String CHAR8 = "CHAR8";
200  public static final String UCHAR16 = "UCHAR16";
201  public static final String CHAR16 = "CHAR16";
202  public static final String FLOAT32 = "FLOAT32";
203  public static final String FLOAT64 = "FLOAT64";
204  public static final String FLOAT128 = "FLOAT128";
205  public static final String INT8 = "INT8";
206  public static final String UINT8 = "UINT8";
207  public static final String INT16 = "INT16";
208  public static final String UINT16 = "UINT16";
209  public static final String INT32 = "INT32";
210  public static final String UINT32 = "UINT32";
211  public static final String INT64 = "INT64";
212  public static final String UINT64 = "UINT64";
213  public static final String INT128 = "INT128";
214  public static final String UINT128 = "UINT128";
215 
216 
222  public static String getType(int type)
223  {
224  if (type == HDFConstants.DFNT_UCHAR8) return HDFConstants.UCHAR8;
225  else if (type == HDFConstants.DFNT_CHAR8) return HDFConstants.CHAR8;
226  else if (type == HDFConstants.DFNT_UCHAR16) return HDFConstants.UCHAR16;
227  else if (type == HDFConstants.DFNT_CHAR16) return HDFConstants.CHAR16;
228  else if (type == HDFConstants.DFNT_FLOAT32) return HDFConstants.FLOAT32;
229  else if (type == HDFConstants.DFNT_FLOAT64) return HDFConstants.FLOAT64;
230  else if (type == HDFConstants.DFNT_FLOAT128) return HDFConstants.FLOAT128;
231  else if (type == HDFConstants.DFNT_INT8) return HDFConstants.INT8;
232  else if (type == HDFConstants. DFNT_UINT8) return HDFConstants.UINT8;
233  else if (type == HDFConstants.DFNT_INT16) return HDFConstants.INT16;
234  else if (type == HDFConstants.DFNT_UINT16) return HDFConstants.UINT16;
235  else if (type == HDFConstants.DFNT_INT32) return HDFConstants.INT32;
236  else if (type == HDFConstants.DFNT_UINT32) return HDFConstants.UINT32;
237  else if (type == HDFConstants.DFNT_INT64) return HDFConstants.INT64;
238  else if (type == HDFConstants.DFNT_UINT64) return HDFConstants.UINT64;
239  else if (type == HDFConstants.DFNT_INT128) return HDFConstants.INT128;
240  else if (type == HDFConstants.DFNT_UINT128) return HDFConstants.UINT128;
241  else return "Undefined Data Type";
242  }
243 
249  public static int getType(String type)
250  {
251  if (type.equalsIgnoreCase(HDFConstants.UCHAR8)) return HDFConstants.DFNT_UCHAR8;
252  else if (type.equalsIgnoreCase(HDFConstants.CHAR8)) return HDFConstants.DFNT_CHAR8;
253  else if (type.equalsIgnoreCase(HDFConstants.UCHAR16)) return HDFConstants.DFNT_UCHAR16;
254  else if (type.equalsIgnoreCase(HDFConstants.CHAR16)) return HDFConstants.DFNT_CHAR16;
255  else if (type.equalsIgnoreCase(HDFConstants.FLOAT32)) return HDFConstants.DFNT_FLOAT32;
256  else if (type.equalsIgnoreCase(HDFConstants.FLOAT64)) return HDFConstants.DFNT_FLOAT64;
257  else if (type.equalsIgnoreCase(HDFConstants.FLOAT128)) return HDFConstants.DFNT_FLOAT128;
258  else if (type.equalsIgnoreCase(HDFConstants.INT8)) return HDFConstants.DFNT_INT8;
259  else if (type.equalsIgnoreCase(HDFConstants. UINT8)) return HDFConstants.DFNT_UINT8;
260  else if (type.equalsIgnoreCase(HDFConstants.INT16)) return HDFConstants.DFNT_INT16;
261  else if (type.equalsIgnoreCase(HDFConstants.UINT16)) return HDFConstants.DFNT_UINT16;
262  else if (type.equalsIgnoreCase(HDFConstants.INT32)) return HDFConstants.DFNT_INT32;
263  else if (type.equalsIgnoreCase(HDFConstants.UINT32)) return HDFConstants.DFNT_UINT32;
264  else if (type.equalsIgnoreCase(HDFConstants.INT64)) return HDFConstants.DFNT_INT64;
265  else if (type.equalsIgnoreCase(HDFConstants.UINT64)) return HDFConstants.DFNT_UINT64;
266  else if (type.equalsIgnoreCase(HDFConstants.INT128)) return HDFConstants.DFNT_INT128;
267  else if (type.equalsIgnoreCase(HDFConstants.UINT128)) return HDFConstants.DFNT_UINT128;
268  else return -1;
269  }
270 
277  public static int getTypeSize(int type)
278  {
279  int size = 0;
280 
281  switch(type)
282  {
287  size = 2;
288  break;
292  size = 4;
293  break;
297  size = 8;
298  break;
302  size = 16;
303  break;
304  default:
305  size = 1;
306  break;
307  }
308 
309  return size;
310  }
311 
312 }