mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-01-30 15:32:37 +08:00
bd995868ee
Description:
- Implemented the friend function
void f_PropList_setId(PropList* plist, hid_t new_id)
to work around the same problem described in trunk r26655, for the
API DataSet::getCreatePlist()
- Cleaned up some comments and obsolete functions
Platforms tested:
Linux/32 2.6 (jam)
Linux/64 (platypus)
Darwin (osx1010test)
101 lines
3.8 KiB
C++
101 lines
3.8 KiB
C++
// C++ informative line for the emacs editor: -*- C++ -*-
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* Copyright by the Board of Trustees of the University of Illinois. *
|
|
* All rights reserved. *
|
|
* *
|
|
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
|
* terms governing use, modification, and redistribution, is contained in *
|
|
* the files COPYING and Copyright.html. COPYING can be found at the root *
|
|
* of the source code distribution tree; Copyright.html can be found at the *
|
|
* root level of an installed copy of the electronic HDF5 document set and *
|
|
* is linked from the top-level documents page. It can also be found at *
|
|
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
|
|
* access to either file, you may request a copy from help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef __H5CppDoc_H
|
|
#define __H5CppDoc_H
|
|
|
|
//-------------------------------------------------------------------------
|
|
// The following section will be used to generate the 'Mainpage'
|
|
// and the 'Examples' for the RM.
|
|
// ------------------------------------------------------------------------
|
|
|
|
/*! \mainpage notitle
|
|
* <br />
|
|
* \section intro_sec Introduction
|
|
*
|
|
* The C++ API provides C++ wrappers for the HDF5 C Library.
|
|
*
|
|
* It is assumed that the user has knowledge of the
|
|
* <a href="https://www.hdfgroup.org/HDF5/doc/H5.format.html">
|
|
* HDF5 file format</a> and its components.
|
|
* For more information on the HDF5 C Library, see the
|
|
* <a href="https://www.hdfgroup.org/HDF5/doc/index.html">
|
|
* HDF5 Software Documentation</a> page.
|
|
*
|
|
* Because the HDF5 C Library maps very well to
|
|
* the object oriented design approach, classes in the C++ API can
|
|
* closely represent the interfaces of the C APIs as follows:
|
|
*
|
|
* \verbatim
|
|
HDF5 C APIs C++ Classes
|
|
----------- -----------
|
|
Attribute Interface (H5A) Attribute
|
|
Datasets Interface (H5D) DataSet
|
|
Error Interface (H5E) Exception
|
|
File Interface (H5F) H5File
|
|
Group Interface (H5G) Group
|
|
Identifier Interface (H5I) IdComponent
|
|
Property List Interface (H5P) PropList and subclasses
|
|
Dataspace Interface (H5S) DataSpace
|
|
Datatype Interface (H5T) DataType and subclasses
|
|
\endverbatim
|
|
* <br />
|
|
* \section install_sec Installation
|
|
*
|
|
* The HDF5 C++ API is included with the HDF5 source code and can
|
|
* be obtained from
|
|
* <a href="https://www.hdfgroup.org/HDF5/release/obtainsrc.html">
|
|
* https://www.hdfgroup.org/HDF5/release/obtainsrc.html</a>.
|
|
*
|
|
* Please refer to the release_docs/INSTALL file under the top directory
|
|
* of the HDF5 source code for information about installing, building,
|
|
* and testing the C++ API.
|
|
*
|
|
* <br />
|
|
*/
|
|
|
|
/// This example shows how to create datasets.
|
|
///\par
|
|
///\example create.cpp
|
|
|
|
///\par
|
|
/// This example shows how to write datasets.
|
|
///\example writedata.cpp
|
|
|
|
///\par
|
|
/// This example shows how to read datasets.
|
|
///\example readdata.cpp
|
|
|
|
///\par
|
|
/// This example shows how to create a compound datatype,
|
|
/// write an array which has the compound datatype to the file,
|
|
/// and read back fields' subsets.
|
|
///\example compound.cpp
|
|
|
|
///\par
|
|
/// This example shows how to work with extendible datasets.
|
|
///\example extend_ds.cpp
|
|
|
|
///\par
|
|
/// This example shows how to read data from a chunked dataset.
|
|
///\example chunks.cpp
|
|
|
|
///\par
|
|
/// This example shows how to work with groups.
|
|
///\example h5group.cpp
|
|
|
|
#endif // __H5CppDoc_H
|