H5CppDoc.h 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. // C++ informative line for the emacs editor: -*- C++ -*-
  2. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  3. * Copyright by The HDF Group. *
  4. * Copyright by the Board of Trustees of the University of Illinois. *
  5. * All rights reserved. *
  6. * *
  7. * This file is part of HDF5. The full HDF5 copyright notice, including *
  8. * terms governing use, modification, and redistribution, is contained in *
  9. * the COPYING file, which can be found at the root of the source code *
  10. * distribution tree, or in https://www.hdfgroup.org/licenses. *
  11. * If you do not have access to either file, you may request a copy from *
  12. * help@hdfgroup.org. *
  13. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  14. #ifndef H5CppDoc_H
  15. #define H5CppDoc_H
  16. //-------------------------------------------------------------------------
  17. // The following section will be used to generate the 'Mainpage'
  18. // and the 'Examples' for the RM.
  19. // ------------------------------------------------------------------------
  20. /*! \mainpage notitle
  21. * <br />
  22. * \section intro_sec Introduction
  23. *
  24. * The C++ API provides C++ wrappers for the HDF5 C Library.
  25. *
  26. * It is assumed that the user has knowledge of the HDF5 file format and its
  27. * components. For more information on the HDF5 C Library, please refer to
  28. * the HDF5 Software Documentation page.
  29. *
  30. * Because the HDF5 C Library maps very well to
  31. * the object oriented design approach, classes in the C++ API can
  32. * closely represent the interfaces of the C APIs as follows:
  33. *
  34. * \verbatim
  35. HDF5 C APIs C++ Classes
  36. ----------- -----------
  37. Attribute Interface (H5A) Attribute
  38. Datasets Interface (H5D) DataSet
  39. Error Interface (H5E) Exception
  40. File Interface (H5F) H5File
  41. Group Interface (H5G) Group
  42. Identifier Interface (H5I) IdComponent
  43. Property List Interface (H5P) PropList and subclasses
  44. Dataspace Interface (H5S) DataSpace
  45. Datatype Interface (H5T) DataType and subclasses
  46. \endverbatim
  47. *
  48. * This <a href="./C2Cppfunction_map.htm">
  49. * table </a> provides a map from the C APIs to the C++ member functions.
  50. * <br />
  51. * \section install_sec Installation
  52. *
  53. * The HDF5 C++ API is included with the HDF5 source code.
  54. *
  55. * Please refer to the release_docs/INSTALL file under the top directory
  56. * of the HDF5 source code for information about installing, building,
  57. * and testing the C++ API.
  58. *
  59. * <br />
  60. */
  61. /// This example shows how to create datasets.
  62. ///\par
  63. ///\example create.cpp
  64. ///\par
  65. /// This example shows how to write datasets.
  66. ///\example writedata.cpp
  67. ///\par
  68. /// This example shows how to read datasets.
  69. ///\example readdata.cpp
  70. ///\par
  71. /// This example shows how to create a compound datatype,
  72. /// write an array which has the compound datatype to the file,
  73. /// and read back fields' subsets.
  74. ///\example compound.cpp
  75. ///\par
  76. /// This example shows how to work with extendible datasets.
  77. ///\example extend_ds.cpp
  78. ///\par
  79. /// This example shows how to read data from a chunked dataset.
  80. ///\example chunks.cpp
  81. ///\par
  82. /// This example shows how to work with groups.
  83. ///\example h5group.cpp
  84. #endif // H5CppDoc_H