Commit 3f7c84db authored by gsell's avatar gsell

header files and documentation reorganized

parent c5a05a12
This diff is collapsed.
......@@ -18,7 +18,6 @@
#include "h5core/h5b_attribs.h"
/**
\ingroup h5block_c_api
\addtogroup h5block_attrib
@{
*/
......
......@@ -16,7 +16,6 @@
#include "h5core/h5b_io.h"
/**
\ingroup h5block_c_api
\addtogroup h5block_io
@{
*/
......
......@@ -16,7 +16,6 @@
#include "h5core/h5b_model.h"
/**
\ingroup h5block_c_api
\addtogroup h5block_model
@{
*/
......
......@@ -16,7 +16,6 @@
#include "h5core/h5u_io.h"
/**
\ingroup h5part_c_api
\addtogroup h5part_io
@{
*/
......
......@@ -16,7 +16,6 @@
#include "h5core/h5u_model.h"
/**
\ingroup h5part_c_api
\addtogroup h5part_model
@{
*/
......
......@@ -8,8 +8,7 @@
!
INTERFACE
!>
!! \ingroup \h5hut_f90_api
!! \addtogroup \h5hut_file_attribs_f
!! \addtogroup \h5_file_attribs_f
!! @{
! __ _ _ _ _ _ _ _
! / _(_) | ___ __ _| |_| |_ _ __(_) |__ _ _| |_ ___ ___
......@@ -193,9 +192,7 @@
!> @}
!>
!! \ingroup \h5hut_f90_api
!! \addtogroup \h5hut_step_attribs_f
!> \addtogroup \h5_step_attribs_f
!! @{
! _ _ _ _ _ _
......
!
! Copyright (c) 2006-2016, The Regents of the University of California,
! through Lawrence Berkeley National Laboratory (subject to receipt of any
! required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
! Institut (Switzerland). All rights reserved.!
!
! License: see file COPYING in top level of source distribution.
!
INTERFACE
!> \addtogroup h5_debug_f
!! @{
!>
!! Set debug mask. The debug mask is an or'ed value of
!!
!! - \c H5_DEBUG_API: C-API calls
!! - \c H5_DEBUG_CORE_API: core API calls. The core API is used by the C- and Fortran API.
!! - \c H5_DEBUG_PRIV_API: private API calls
!! - \c H5_DEBUG_PRIV_FUNC: static functions
!! - \c H5_DEBUG_HDF5: HDF5 wrapper calls
!! - \c H5_DEBUG_MPI: MPI wrapper calls
!! - \c H5_DEBUG_MALLOC: memory allocation
!! - \c H5_DEBUG_ALL: enable all
!!
!! \return \c H5_SUCCESS
!!
!! \see h5_get_debug_mask()
SUBROUTINE h5_set_debug_mask ( mask )
INTEGER*9, INTEGER(IN) :: mask !< [in] debug mask
END SUBROUTINE h5_set_debug_mask
!>
!! Get debug mask.
!!
!! \return debug mask
!!
!! \see h5_set_debug_mask()
INTEGER*8 FUNCTION h5_get_debug_mask ()
END FUNCTION h5_get_debug_mask
!> @}
END INTERFACE
/*
Copyright (c) 2006-2016, The Regents of the University of California,
through Lawrence Berkeley National Laboratory (subject to receipt of any
required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
Institut (Switzerland). All rights reserved.
License: see file COPYING in top level of source distribution.
*/
#ifndef __H5_DEBUG_H
#define __H5_DEBUG_H
#include "h5core/h5_types.h"
/**
\addtogroup h5_debug
@{
*/
/**
Set debug mask. The debug mask is an or'ed value of
- \c H5_DEBUG_API: C-API calls
- \c H5_DEBUG_CORE_API: core API calls.
- \c H5_DEBUG_PRIV_API: private API calls
- \c H5_DEBUG_PRIV_FUNC: static functions
- \c H5_DEBUG_HDF5: HDF5 wrapper calls
- \c H5_DEBUG_MPI: MPI wrapper calls
- \c H5_DEBUG_MALLOC: memory allocation
- \c H5_DEBUG_ALL: enable all
\return \c H5_SUCCESS
\see H5GetDebugMask()
\note
| Release | Change |
| :------ | :----- |
| \c 1.99.15 | Function introduced in this release. |
*/
static inline h5_err_t
H5SetDebugMask (
const h5_id_t mask ///< [in] debug mask
) {
return h5_set_debuglevel (mask & ~0x03);
}
/**
Get debug mask.
\return debug mask
\see H5SetDebugMask()
\note
| Release | Change |
| :------ | :----- |
| \c 1.99.15 | Function introduced in this release. |
*/
static inline h5_id_t
H5GetDebugMask (
void
) {
return (h5_get_debuglevel () & ~0x03);
}
///< @}
#endif
!
! Copyright (c) 2006-2016, The Regents of the University of California,
! through Lawrence Berkeley National Laboratory (subject to receipt of any
! required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
! Institut (Switzerland). All rights reserved.!
!
! License: see file COPYING in top level of source distribution.
!
INTERFACE
!> \addtogroup h5_error_f
!! @{
!>
!! Report error, do not abort program. The error must be handled in the programm.
SUBROUTINE h5_report_on_error ()
END SUBROUTINE h5_report_on_error
!>
!! Abort program on error.
SUBROUTINE h5_abort_on_error ()
END SUBROUTINE h5_abort_on_error
!>
!! Get last error code.
!!
!! Error codes are:
!!
!! - \c H5_ERR_BADF: Something is wrong with the file handle.
!! - \c H5_ERR_NOMEM: Out of memory.
!! - \c H5_ERR_INVAL: Invalid argument.
!!
!! - \c H5_ERR_VIEW: Something is wrong with the view.
!! - \c H5_ERR_NOENTRY: A lookup failed.
!!
!! - \c H5_ERR_MPI: A MPI error occured.
!! - \c H5_ERR_HDF5: A HDF5 error occured.
!! - \c H5_ERR_H5: Unspecified error in H5 module.
!! - \c H5_ERR_H5PART: Unspecified error in H5Part module.
!! - \c H5_ERR_H5BLOCK: Unspecified error in H5Block module.
!! - \c H5_ERR_H5FED: Unspecified error in H5Fed module.
!!
!! - \c H5_ERR_INTERNAL: Internal error.
!! - \c H5_ERR_NOT_IMPLEMENTED: Function not yet implemented.
!!
!! \return error code
INTEGER*8 FUNCTION h5_get_error_number ()
END FUNCTION h5_get_error_number
!> @}
END INTERFACE
/*
Copyright (c) 2006-2016, The Regents of the University of California,
through Lawrence Berkeley National Laboratory (subject to receipt of any
required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
Institut (Switzerland). All rights reserved.
License: see file COPYING in top level of source distribution.
*/
#ifndef __H5_ERROR_H
#define __H5_ERROR_H
#include "h5core/h5_types.h"
#include "h5core/h5.h"
#include "h5core/h5_debug.h"
/**
\addtogroup h5_error
@{
*/
/**
Report error, do not abort program. The error must be handled in the programm.
\return \c H5_SUCCESS
\see H5SetErrorHandler()
\see H5ReportErrorhandler()
*/
static inline h5_err_t
H5ReportOnError (
void
) {
H5_API_ENTER (h5_err_t, "%s", "");
H5_API_RETURN (h5_set_errorhandler (h5_report_errorhandler));
}
/**
Abort program on error.
\return \c H5_SUCCESS
\see H5SetErrorHandler()
\see H5AbortErrorhandler()
*/
static inline h5_err_t
H5AbortOnError (
void
) {
H5_API_ENTER (h5_err_t, "%s", "");
H5_API_RETURN (h5_set_errorhandler (h5_abort_errorhandler));
}
/**
Set error handler to \c handler.
\return \c H5_SUCCESS
\see H5GetErrorHandler()
\see H5ReportErrorhandler()
\see H5AbortErrorhandler()
*/
static inline h5_err_t
H5SetErrorHandler (
h5_errorhandler_t handler ///< [in] error handler to set.
) {
H5_API_ENTER (h5_err_t, "handler=%p", handler);
H5_API_RETURN (h5_set_errorhandler (handler));
}
/**
Get current error handler.
\return Pointer to error handler.
\see H5SetErrorHandler()
\see H5ReportErrorhandler()
\see H5AbortErrorhandler()
*/
static inline h5_errorhandler_t
H5GetErrorHandler (
void
) {
H5_API_ENTER (h5_errorhandler_t, "%s", "void");
H5_API_RETURN (h5_get_errorhandler());
}
/**
The report error handler writes a message to stderr, sets the error number
and returns.
\return \c H5_FAILURE
*/
static inline h5_err_t
H5ReportErrorhandler (
const char* fmt, ///< [in] format string of error message.
va_list ap ///< [in] arguments to format string.
) {
return h5_report_errorhandler (fmt, ap);
}
/**
The abort error handler writes a message to stderr and exits the programm.
\return does not return.
*/
static inline h5_err_t
H5AbortErrorhandler (
const char* fmt, ///< [in] format string of error message.
va_list ap ///< [in] arguments to format string.
) {
return h5_abort_errorhandler (fmt, ap);
}
/**
Get last error code.
Error codes are:
- \c H5_ERR_BADF: Something is wrong with the file handle.
- \c H5_ERR_NOMEM: Out of memory.
- \c H5_ERR_INVAL: Invalid argument.
- \c H5_ERR_VIEW: Something is wrong with the view.
- \c H5_ERR_NOENTRY: A lookup failed.
- \c H5_ERR_MPI: A MPI error occured.
- \c H5_ERR_HDF5: A HDF5 error occured.
- \c H5_ERR_H5: Unspecified error in H5 module.
- \c H5_ERR_H5PART: Unspecified error in H5Part module.
- \c H5_ERR_H5BLOCK: Unspecified error in H5Block module.
- \c H5_ERR_H5FED: Unspecified error in H5Fed module.
- \c H5_ERR_INTERNAL: Internal error.
- \c H5_ERR_NOT_IMPLEMENTED: Function not yet implemented.
\return error code
*/
static inline h5_err_t
H5GetErrno (
void
) {
return h5_get_errno ();
}
///< @}
#endif
......@@ -7,8 +7,7 @@
! License: see file COPYING in top level of source distribution.
!
INTERFACE
!> \ingroup h5hut_f90_api
!! \addtogroup h5hut_file_f
!> \addtogroup h5_file_f
!! @{
!>
......@@ -251,118 +250,4 @@
END FUNCTION h5_finalize
!> @}
!> \ingroup h5hut_f90_api_error_handling_and_debugging
!! \addtogroup h5hut_verbosity_f
!! @{
!>
!! Set verbosity level to \c level.
!!
!! Verbosity levels are:
!! - \c H5_VERBOSE_NONE: be quiet
!! - \c H5_VERBOSE_ERROR: output error messages
!! - \c H5_VERBOSE_WARN: output error messages and warning
!! - \c H5_VERBOSE_INFO: output error messages, warnings and informational messages
!!
!! The default verbosity level ist \c H5_VERBOSE_ERROR.
!!
!! \return \c H5_SUCCESS
!!
!! \see h5_get_verbosity_level()
SUBROUTINE h5_set_verbosity_level ( level )
INTEGER*8, INTENT(IN) :: level !< the level from 0 (no output) to 5 (most detailed)
END SUBROUTINE h5_set_verbosity_level
!>
!! Get verbosity level.
!!
!! \return verbosity level
!!
!! \see h5_set_verbosity_level()
INTEGER*8 FUNCTION h5_get_verbosity_level ()
END FUNCTION h5_get_verbosity_level
!> @}
!> \addtogroup h5hut_debug_f
!! @{
!>
!! Set debug mask. The debug mask is an or'ed value of
!!
!! - \c H5_DEBUG_API: C-API calls
!! - \c H5_DEBUG_CORE_API: core API calls. The core API is used by the C- and Fortran API.
!! - \c H5_DEBUG_PRIV_API: private API calls
!! - \c H5_DEBUG_PRIV_FUNC: static functions
!! - \c H5_DEBUG_HDF5: HDF5 wrapper calls
!! - \c H5_DEBUG_MPI: MPI wrapper calls
!! - \c H5_DEBUG_MALLOC: memory allocation
!! - \c H5_DEBUG_ALL: enable all
!!
!! \return \c H5_SUCCESS
!!
!! \see h5_get_debug_mask()
SUBROUTINE h5_set_debug_mask ( mask )
INTEGER*9, INTEGER(IN) :: mask !< [in] debug mask
END SUBROUTINE h5_set_debug_mask
!>
!! Get debug mask.
!!
!! \return debug mask
!!
!! \see h5_set_debug_mask()
INTEGER*8 FUNCTION h5_get_debug_mask ()
END FUNCTION h5_get_debug_mask
!> @}
!> \addtogroup h5hut_error_f
!! @{
!>
!! Report error, do not abort program. The error must be handled in the programm.
SUBROUTINE h5_report_on_error ()
END SUBROUTINE h5_report_on_error
!>
!! Abort program on error.
SUBROUTINE h5_abort_on_error ()
END SUBROUTINE h5_abort_on_error
!>
!! Get last error code.
!!
!! Error codes are:
!!
!! - \c H5_ERR_BADF: Something is wrong with the file handle.
!! - \c H5_ERR_NOMEM: Out of memory.
!! - \c H5_ERR_INVAL: Invalid argument.
!!
!! - \c H5_ERR_VIEW: Something is wrong with the view.
!! - \c H5_ERR_NOENTRY: A lookup failed.
!!
!! - \c H5_ERR_MPI: A MPI error occured.
!! - \c H5_ERR_HDF5: A HDF5 error occured.
!! - \c H5_ERR_H5: Unspecified error in H5 module.
!! - \c H5_ERR_H5PART: Unspecified error in H5Part module.
!! - \c H5_ERR_H5BLOCK: Unspecified error in H5Block module.
!! - \c H5_ERR_H5FED: Unspecified error in H5Fed module.
!!
!! - \c H5_ERR_INTERNAL: Internal error.
!! - \c H5_ERR_NOT_IMPLEMENTED: Function not yet implemented.
!!
!! \return error code
INTEGER*8 FUNCTION h5_get_error_number ()
END FUNCTION h5_get_error_number
!> @}
END INTERFACE
This diff is collapsed.
This diff is collapsed.
!
! Copyright (c) 2006-2016, The Regents of the University of California,
! through Lawrence Berkeley National Laboratory (subject to receipt of any
! required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
! Institut (Switzerland). All rights reserved.!
!
! License: see file COPYING in top level of source distribution.
!
INTERFACE
!> \addtogroup h5_log_f
!! @{
!>
!! Set verbosity level to \c level.
!!
!! Verbosity levels are:
!! - \c H5_VERBOSE_NONE: be quiet
!! - \c H5_VERBOSE_ERROR: output error messages
!! - \c H5_VERBOSE_WARN: output error messages and warning
!! - \c H5_VERBOSE_INFO: output error messages, warnings and informational messages
!!
!! The default verbosity level ist \c H5_VERBOSE_ERROR.
!!
!! \return \c H5_SUCCESS
!!
!! \see h5_get_verbosity_level()
SUBROUTINE h5_set_verbosity_level ( level )
INTEGER*8, INTENT(IN) :: level !< the level from 0 (no output) to 5 (most detailed)
END SUBROUTINE h5_set_verbosity_level
!>
!! Get verbosity level.
!!
!! \return verbosity level
!!
!! \see h5_set_verbosity_level()
INTEGER*8 FUNCTION h5_get_verbosity_level ()
END FUNCTION h5_get_verbosity_level
!> @}
END INTERFACE
/*
Copyright (c) 2006-2016, The Regents of the University of California,
through Lawrence Berkeley National Laboratory (subject to receipt of any
required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
Institut (Switzerland). All rights reserved.
License: see file COPYING in top level of source distribution.
*/
#ifndef __H5_LOG_H
#define __H5_LOG_H
#include "h5core/h5_types.h"
#include "h5core/h5_debug.h"
#if H5HUT_API_VERSION == 2
#define H5SetVerbosityLevel2 H5SetVerbosityLevel
#elif H5HUT_API_VERSION == 1
#define H5SetVerbosityLevel1 H5SetVerbosityLevel
#endif
/**
\addtogroup h5_log
@{
*/
/**
Set verbosity level to \c level.
Verbosity levels are:
- \c H5_VERBOSE_NONE: be quiet
- \c H5_VERBOSE_ERROR: output error messages
- \c H5_VERBOSE_WARN: output error messages and warning
- \c H5_VERBOSE_INFO: output error messages, warnings and informational messages
The default verbosity level is \c H5_VERBOSE_ERROR.
\return \c H5_SUCCESS
\see H5GetVerbosityLevel()
\note
| Release | Change |
| :------ | :----- |
| \c 1.99.15 | Function cannot be used to set the debug level. |
*/
static inline h5_err_t
H5SetVerbosityLevel2 (
const h5_id_t level ///< [in] verbosity level.
) {
return h5_set_debuglevel (level & 0x03);
}
/**
Set verbosity and debug level to \p level.
Verbosity levels are:
- \c H5_VERBOSE_NONE: be quiet
- \c H5_VERBOSE_ERROR: output error messages
- \c H5_VERBOSE_WARN: output error messages and warning
- \c H5_VERBOSE_INFO: output error messages, warnings and informational messages
The default verbosity level is \c H5_VERBOSE_ERROR.
\return \c H5_SUCCESS
\see H5GetVerbosityLevel()
*/
static inline h5_err_t
H5SetVerbosityLevel1 (
const h5_id_t level ///< [in] verbosity level.
) {
return h5_set_debuglevel (level);
}
/**
Get verbosity level.
\return verbosity level
\see H5SetVerbosityLevel()
*/
static inline h5_id_t
H5GetVerbosityLevel (
void
) {
return h5_get_debuglevel () & 0x03;
}
///< @}
#endif
......@@ -7,9 +7,7 @@
! License: see file COPYING in top level of source distribution.
!
INTERFACE
!>
!! \ingroup h5hut_f90_api
!! \addtogroup h5hut_model_f
!> \addtogroup h5_model_f
!! @{
!>
......
......@@ -16,7 +16,6 @@
#include "h5core/h5_model.h"
/**
\ingroup h5_c_api
\addtogroup h5_model
@{
*/
......
......@@ -9,9 +9,13 @@
MODULE H5hut
include 'H5_const.f90'
include 'H5.f90'
include 'H5_attribs.f90'
include 'H5_file.f90'
include 'H5_model.f90'
include 'H5_file_attribs.f90'
include 'H5_step_attribs.f90'
include 'H5_log.f90'
include 'H5_debug.f90'
include 'H5_error.f90'
include 'H5Part_model.f90'
include 'H5Part_io.f90'
......
......@@ -19,7 +19,7 @@ extern "C" {
#endif
/**
\addtogroup h5hut_error
\addtogroup h5_error
@{
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment