Main Page

00001 // C++ informative line for the emacs editor: -*- C++ -*-
00002 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
00013  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 // PredType holds the definition of all the HDF5 predefined datatypes.
00017 // These types can only be made copy of, not created by H5Tcreate or
00018 // closed by H5Tclose.  They are treated as constants.
00020 
00021 #ifndef _H5PredType_H
00022 #define _H5PredType_H
00023 
00024 #ifndef H5_NO_NAMESPACE
00025 namespace H5 {
00026 #endif
00027 
00028 class H5_DLLCPP PredType : public AtomType {
00029    public:
00030         // Returns this class name
00031         virtual H5std_string fromClass () const { return("PredType"); }
00032 
00033         // Makes a copy of the predefined type and stores the new
00034         // id in the left hand side object.
00035         PredType& operator=( const PredType& rhs );
00036 
00037         // Copy constructor - makes copy of the original object
00038         PredType( const PredType& original );
00039 
00040         // Noop destructor
00041         virtual ~PredType();
00042 
00043         // Declaration of predefined types; their definition is in H5PredType.cpp
00044         static const PredType STD_I8BE;
00045         static const PredType STD_I8LE;
00046         static const PredType STD_I16BE;
00047         static const PredType STD_I16LE;
00048         static const PredType STD_I32BE;
00049         static const PredType STD_I32LE;
00050         static const PredType STD_I64BE;
00051         static const PredType STD_I64LE;
00052         static const PredType STD_U8BE;
00053         static const PredType STD_U8LE;
00054         static const PredType STD_U16BE;
00055         static const PredType STD_U16LE;
00056         static const PredType STD_U32BE;
00057         static const PredType STD_U32LE;
00058         static const PredType STD_U64BE;
00059         static const PredType STD_U64LE;
00060         static const PredType STD_B8BE;
00061         static const PredType STD_B8LE;
00062         static const PredType STD_B16BE;
00063         static const PredType STD_B16LE;
00064         static const PredType STD_B32BE;
00065         static const PredType STD_B32LE;
00066         static const PredType STD_B64BE;
00067         static const PredType STD_B64LE;
00068         static const PredType STD_REF_OBJ;
00069         static const PredType STD_REF_DSETREG;
00070 
00071         static const PredType C_S1;
00072         static const PredType FORTRAN_S1;
00073 
00074         static const PredType IEEE_F32BE;
00075         static const PredType IEEE_F32LE;
00076         static const PredType IEEE_F64BE;
00077         static const PredType IEEE_F64LE;
00078 
00079         static const PredType UNIX_D32BE;
00080         static const PredType UNIX_D32LE;
00081         static const PredType UNIX_D64BE;
00082         static const PredType UNIX_D64LE;
00083 
00084         static const PredType INTEL_I8;
00085         static const PredType INTEL_I16;
00086         static const PredType INTEL_I32;
00087         static const PredType INTEL_I64;
00088         static const PredType INTEL_U8;
00089         static const PredType INTEL_U16;
00090         static const PredType INTEL_U32;
00091         static const PredType INTEL_U64;
00092         static const PredType INTEL_B8;
00093         static const PredType INTEL_B16;
00094         static const PredType INTEL_B32;
00095         static const PredType INTEL_B64;
00096         static const PredType INTEL_F32;
00097         static const PredType INTEL_F64;
00098 
00099         static const PredType ALPHA_I8;
00100         static const PredType ALPHA_I16;
00101         static const PredType ALPHA_I32;
00102         static const PredType ALPHA_I64;
00103         static const PredType ALPHA_U8;
00104         static const PredType ALPHA_U16;
00105         static const PredType ALPHA_U32;
00106         static const PredType ALPHA_U64;
00107         static const PredType ALPHA_B8;
00108         static const PredType ALPHA_B16;
00109         static const PredType ALPHA_B32;
00110         static const PredType ALPHA_B64;
00111         static const PredType ALPHA_F32;
00112         static const PredType ALPHA_F64;
00113 
00114         static const PredType MIPS_I8;
00115         static const PredType MIPS_I16;
00116         static const PredType MIPS_I32;
00117         static const PredType MIPS_I64;
00118         static const PredType MIPS_U8;
00119         static const PredType MIPS_U16;
00120         static const PredType MIPS_U32;
00121         static const PredType MIPS_U64;
00122         static const PredType MIPS_B8;
00123         static const PredType MIPS_B16;
00124         static const PredType MIPS_B32;
00125         static const PredType MIPS_B64;
00126         static const PredType MIPS_F32;
00127         static const PredType MIPS_F64;
00128 
00129         static const PredType NATIVE_CHAR;
00130         static const PredType NATIVE_SCHAR;
00131         static const PredType NATIVE_UCHAR;
00132         static const PredType NATIVE_SHORT;
00133         static const PredType NATIVE_USHORT;
00134         static const PredType NATIVE_INT;
00135         static const PredType NATIVE_UINT;
00136         static const PredType NATIVE_LONG;
00137         static const PredType NATIVE_ULONG;
00138         static const PredType NATIVE_LLONG;
00139         static const PredType NATIVE_ULLONG;
00140         static const PredType NATIVE_FLOAT;
00141         static const PredType NATIVE_DOUBLE;
00142         static const PredType NATIVE_LDOUBLE;
00143         static const PredType NATIVE_B8;
00144         static const PredType NATIVE_B16;
00145         static const PredType NATIVE_B32;
00146         static const PredType NATIVE_B64;
00147         static const PredType NATIVE_OPAQUE;
00148         static const PredType NATIVE_HSIZE;
00149         static const PredType NATIVE_HSSIZE;
00150         static const PredType NATIVE_HERR;
00151         static const PredType NATIVE_HBOOL;
00152 
00153         static const PredType NATIVE_INT8;
00154         static const PredType NATIVE_UINT8;
00155 #if H5_SIZEOF_INT_LEAST8_T != 0
00156         static const PredType NATIVE_INT_LEAST8;
00157 #endif /* H5_SIZEOF_INT_LEAST8_T */
00158 #if H5_SIZEOF_UINT_LEAST8_T != 0
00159         static const PredType NATIVE_UINT_LEAST8;
00160 #endif /* H5_SIZEOF_UINT_LEAST8_T */
00161         //static const PredType NATIVE_INT_FAST8;
00162         //static const PredType NATIVE_UINT_FAST8;
00163 
00164         static const PredType NATIVE_INT16;
00165         static const PredType NATIVE_UINT16;
00166 #if H5_SIZEOF_INT_LEAST16_T != 0
00167         static const PredType NATIVE_INT_LEAST16;
00168 #endif /* H5_SIZEOF_INT_LEAST16_T */
00169 #if H5_SIZEOF_UINT_LEAST16_T != 0
00170         static const PredType NATIVE_UINT_LEAST16;
00171 #endif /* H5_SIZEOF_UINT_LEAST16_T */
00172         //static const PredType NATIVE_INT_FAST16;
00173         //static const PredType NATIVE_UINT_FAST16;
00174 
00175         static const PredType NATIVE_INT32;
00176         static const PredType NATIVE_UINT32;
00177 #if H5_SIZEOF_INT_LEAST32_T != 0
00178         static const PredType NATIVE_INT_LEAST32;
00179 #endif /* H5_SIZEOF_INT_LEAST32_T */
00180 #if H5_SIZEOF_UINT_LEAST32_T != 0
00181         static const PredType NATIVE_UINT_LEAST32;
00182 #endif /* H5_SIZEOF_UINT_LEAST32_T */
00183         //static const PredType NATIVE_INT_FAST32;
00184         //static const PredType NATIVE_UINT_FAST32;
00185 
00186         static const PredType NATIVE_INT64;
00187         static const PredType NATIVE_UINT64;
00188 #if H5_SIZEOF_INT_LEAST64_T != 0
00189         static const PredType NATIVE_INT_LEAST64;
00190 #endif /* H5_SIZEOF_INT_LEAST64_T */
00191 #if H5_SIZEOF_UINT_LEAST64_T != 0
00192         static const PredType NATIVE_UINT_LEAST64;
00193 #endif /* H5_SIZEOF_UINT_LEAST64_T */
00194         //static const PredType NATIVE_INT_FAST64;
00195         //static const PredType NATIVE_UINT_FAST64;
00196 
00197 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00198         // These dummy functions do not inherit from DataType - they'll
00199         // throw a DataTypeIException if invoked.
00200         void commit( H5Object& loc, const H5std_string& name );
00201         void commit( H5Object& loc, const char* name );
00202         bool committed();
00203 #endif // DOXYGEN_SHOULD_SKIP_THIS
00204 
00205    private:
00206         // added this to work around the atexit/global destructor problem
00207         // temporarily - it'll prevent the use of atexit to clean up
00208         static const PredType NotAtexit;        // not working yet
00209 
00210    protected:
00211 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00212         // Default constructor
00213         PredType();
00214 
00215         // Creates a pre-defined type using an HDF5 pre-defined constant
00216         PredType( const hid_t predtype_id );  // used by the library only
00217 
00218 #endif // DOXYGEN_SHOULD_SKIP_THIS
00219 
00220 };
00221 #ifndef H5_NO_NAMESPACE
00222 }
00223 #endif
00224 #endif
H5PredType.h
