HDF5 C++ API Reference Manual

 

 

 

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Examples

H5AtomType.h

Go to the documentation of this file.
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 // Class AtomType is a base class, from which IntType, FloatType, StrType, 00017 // and PredType inherit. It provides the services that are common to these 00018 // subclasses. It also inherits from DataType and passes down the 00019 // services that are common to all the datatypes. 00020 00021 #ifndef _H5AtomType_H 00022 #define _H5AtomType_H 00023 00024 #ifndef H5_NO_NAMESPACE 00025 namespace H5 { 00026 #endif 00027 class H5_DLLCPP AtomType : public DataType { 00028 public: 00029 // Returns the byte order of an atomic datatype. 00030 H5T_order_t getOrder( string& order_string ) const; 00031 00032 // Sets the byte ordering of an atomic datatype. 00033 void setOrder( H5T_order_t order ) const; 00034 00035 // Retrieves the bit offset of the first significant bit. 00036 // 12/05/00 - changed return type to int from size_t - C API 00037 int getOffset() const; 00038 00039 // Sets the bit offset of the first significant bit. 00040 void setOffset( size_t offset ) const; 00041 00042 // Retrieves the padding type of the least and most-significant bit padding. 00043 void getPad( H5T_pad_t& lsb, H5T_pad_t& msb ) const; 00044 00045 // Sets the least and most-significant bits padding types 00046 void setPad( H5T_pad_t lsb, H5T_pad_t msb ) const; 00047 00048 // Returns the precision of an atomic datatype. 00049 size_t getPrecision() const; 00050 00051 // Sets the precision of an atomic datatype. 00052 void setPrecision( size_t precision ) const; 00053 00054 // Sets the total size for an atomic datatype. 00055 void setSize( size_t size ) const; 00056 00057 // Copy constructor - makes copy of the original object 00058 AtomType( const AtomType& original ); 00059 00060 // Default destructor 00061 virtual ~AtomType(); 00062 00063 protected: 00064 #ifndef DOXYGEN_SHOULD_SKIP_THIS 00065 // Default constructor 00066 AtomType(); 00067 00068 // Constructor that takes an existing id 00069 AtomType( const hid_t existing_id ); 00070 #endif // DOXYGEN_SHOULD_SKIP_THIS 00071 }; 00072 #ifndef H5_NO_NAMESPACE 00073 } 00074 #endif 00075 #endif

Generated on Thu Aug 5 00:22:37 2004 by doxygen 1.3.7-20040718