MOAB: Mesh Oriented datABase  (version 5.3.0)
mhdf_public.h File Reference
#include <H5Tpublic.h>
+ Include dependency graph for mhdf_public.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  struct_mhdf_Status
 Struct used to return error status. More...
struct  mhdf_EntDesc
struct  mhdf_TagDesc
struct  mhdf_ElemDesc
struct  mhdf_FileDesc

Defines

#define MHDF_MESSAGE_BUFFER_LEN   160
#define mhdf_EDGE_TYPE_NAME   "Edge"
 Name to use for edge element.
#define mhdf_TRI_TYPE_NAME   "Tri"
 Name to use for triangle element.
#define mhdf_QUAD_TYPE_NAME   "Quad"
 Name to use for quadrilateral element.
#define mhdf_POLYGON_TYPE_NAME   "Polygon"
 Name to use for general polygon element.
#define mhdf_TET_TYPE_NAME   "Tet"
 Name to use for tetrahedral element.
#define mhdf_PYRAMID_TYPE_NAME   "Pyramid"
 Name to use for quad-based pyramid element.
#define mhdf_PRISM_TYPE_NAME   "Prism"
 Name to use for triangular prism element.
#define mdhf_KNIFE_TYPE_NAME   "Knife"
 Name to use for knife element.
#define mdhf_HEX_TYPE_NAME   "Hex"
 Name to use for quad-sided hexahedral element.
#define mhdf_POLYHEDRON_TYPE_NAME   "Polyhedron"
 Name to use for general polyhedron specified as a arbitrary-length list of faces.
#define mhdf_SEPTAHEDRON_TYPE_NAME   "Septahedron"
 Name to use for hexagonal-based pyramid.

Typedefs

typedef struct struct_mhdf_Status mhdf_Status
 Struct used to return error status.
typedef mhdf_Status MHDF_Status
typedef enum mhdf_TagDataType MHDF_TagDataType
 Enum for tag data type class.
typedef long mhdf_index_t
 Type used when creating index tables.
typedef void * mhdf_FileHandle
 Opaque handle to an open file.
typedef mhdf_FileHandle MHDF_FileHandle
typedef struct mhdf_EntDesc MHDF_EntDesc
typedef struct mhdf_TagDesc MHDF_TagDesc
typedef struct mhdf_ElemDesc MHDF_ElemDesc
typedef struct mhdf_FileDesc MHDF_FileDesc

Enumerations

enum  mhdf_TagDataType {
  mhdf_OPAQUE = 0, mhdf_INTEGER, mhdf_FLOAT, mhdf_BITFIELD,
  mhdf_BOOLEAN, mhdf_ENTITY_ID
}
 Enum for tag data type class. More...

Functions

int mhdf_isError (mhdf_Status const *)
 Return 1 if passed status object indicates an error. Zero otherwise.
const char * mhdf_message (mhdf_Status const *)
 Get the error message given a status object.
mhdf_FileHandle mhdf_createFile (const char *filename, int overwrite, const char **elem_type_list, size_t elem_type_list_len, hid_t id_type, mhdf_Status *status)
 Create a new file.
mhdf_FileHandle mhdf_openFile (const char *filename, int writable, unsigned long *max_id, hid_t id_type, mhdf_Status *status)
 Open an existing file.
mhdf_FileHandle mhdf_openFileWithOpt (const char *filename, int writable, unsigned long *max_id, hid_t id_type, hid_t options, mhdf_Status *status)
 Open an existing file with options.
int mhdf_countOpenHandles (mhdf_FileHandle h)
 Get number of open HDF5 objects from file.
MHDF_FileDescmhdf_getFileSummary (mhdf_FileHandle file_handle, hid_t file_id_type, mhdf_Status *status, int extraSetInfo)
 Get summary of data tables contained within file.
void mhdf_fixFileDesc (struct mhdf_FileDesc *copy_ptr, const struct mhdf_FileDesc *orig_addr)
 Fix nested pointers for copied/moved FileDesc struct.
void mhdf_closeFile (mhdf_FileHandle handle, mhdf_Status *status)
 Close the file.

Define Documentation

#define MHDF_MESSAGE_BUFFER_LEN   160

Definition at line 11 of file mhdf_public.h.

Referenced by mhdf_setFail().


Typedef Documentation

typedef long mhdf_index_t

Type used when creating index tables.

The data type used by mhdf_create* functions that create tables if indices (e.g. mhdf_createSetMeta, mhdf_createVarLenTag, etc.).

Definition at line 76 of file mhdf_public.h.

Struct used to return error status.

Definition at line 16 of file mhdf_public.h.

Enum for tag data type class.

Enumerates known types for tag data


Enumeration Type Documentation

Enum for tag data type class.

Enumerates known types for tag data

Enumerator:
mhdf_OPAQUE 

Opaque/unknown type

mhdf_INTEGER 

Integer type

mhdf_FLOAT 

Floating point value

mhdf_BITFIELD 

Bit field

mhdf_BOOLEAN 

Boolean values stored as one byte each

mhdf_ENTITY_ID 

Global ID referencing another entity in file

Definition at line 62 of file mhdf_public.h.

                              {
  mhdf_OPAQUE = 0, /**< Opaque/unknown type */
  mhdf_INTEGER,    /**< Integer type */
  mhdf_FLOAT,      /**< Floating point value */
  mhdf_BITFIELD,   /**< Bit field */
  mhdf_BOOLEAN,    /**< Boolean values stored as one byte each */
  mhdf_ENTITY_ID   /**< Global ID referencing another entity in file */
} MHDF_TagDataType;

Function Documentation

int mhdf_isError ( mhdf_Status const *  status)

Return 1 if passed status object indicates an error. Zero otherwise.

MOAB, a Mesh-Oriented datABase, is a software component for creating, storing and accessing finite element mesh data.

Copyright 2004 Sandia Corporation. Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains certain rights in this software.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

Definition at line 26 of file status.c.

References struct_mhdf_Status::message.

Referenced by alloc_file_desc(), check_valid_adjacencies(), check_valid_elem_conn(), check_valid_parents_children(), check_valid_poly_conn(), check_valid_set_contents(), check_valid_sets(), check_valid_tag(), check_valid_var_len_tag(), moab::ReadHDF5::create_tag(), get_elem_desc(), get_tag_desc(), iMOAB_ReadHeaderInfo(), moab::ReadHDF5::is_error(), main(), mhdf_getFileSummary(), moab::ReadHDF5::read_qa(), moab::ReadHDF5::read_tag_values_all(), moab::ReadHDF5::read_tag_values_partial(), realloc_data(), moab::ReadHDF5::set_up_read(), and moab::WriteHDF5::write_file().

{
    return !!status->message[ 0 ];
}
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines