file-handle.h File Reference

#include "mhdf.h"

Include dependency graph for file-handle.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	struct_FileHandle

Typedefs
typedef struct struct_FileHandle	FileHandle

Functions
FileHandle *	mhdf_alloc_FileHandle (hid_t hdf_handle, hid_t id_type, mhdf_Status *status)
int	mhdf_check_valid_file (FileHandle *handle, mhdf_Status *status)

Typedef Documentation

FileHandle

typedef struct struct_FileHandle FileHandle

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.

Function Documentation

mhdf_alloc_FileHandle()

FileHandle* mhdf_alloc_FileHandle	(	hid_t	hdf_handle,
		hid_t	id_type,
		mhdf_Status *	status
	)

Definition at line 43 of file file-handle.c.

{
    FileHandle* rval;
 
    /* check that id_type is sane */
    if( id_type == -1 )
    {
        id_type = H5T_NATIVE_ULONG;
    }
    else if( H5T_INTEGER != H5Tget_class( id_type ) )
    {
        mhdf_setFail( status, "Invalid ID type: not integer class" );
        return 0;
    }
 
    rval = (FileHandle*)mhdf_malloc( sizeof( FileHandle ), status );
    if( !rval ) return NULL;
 
    rval->magic             = FILE_HANDLE_MAGIC;
    rval->hdf_handle        = hdf_table;
    rval->open_handle_count = 0;
    rval->id_type           = id_type;
    rval->max_id            = 0L;
    return rval;
}

References FILE_HANDLE_MAGIC, struct_FileHandle::hdf_handle, struct_FileHandle::id_type, struct_FileHandle::magic, struct_FileHandle::max_id, mhdf_malloc(), mhdf_setFail(), and struct_FileHandle::open_handle_count.

Referenced by mhdf_createFile(), and mhdf_openFileWithOpt().

mhdf_check_valid_file()

int mhdf_check_valid_file	(	FileHandle *	handle,
		mhdf_Status *	status
	)

Definition at line 26 of file file-handle.c.

{
    if( !handle )
    {
        mhdf_setFail( status, "NULL file handle." );
        return 0;
    }
 
    if( handle->magic != FILE_HANDLE_MAGIC )
    {
        mhdf_setFail( status, "Invalid file handle." );
        return 0;
    }
 
    return 1;
}

References FILE_HANDLE_MAGIC, struct_FileHandle::magic, and mhdf_setFail().

Referenced by create_tag_common(), get_tag(), mhdf_addElement(), mhdf_checkOpenHandles(), mhdf_closeData(), mhdf_closeFile(), mhdf_createAdjacency(), mhdf_createConnectivity(), mhdf_createDenseTagData(), mhdf_createNodeCoords(), mhdf_createPolyConnectivity(), mhdf_createSetChildren(), mhdf_createSetData(), mhdf_createSetMeta(), mhdf_createSetParents(), mhdf_getElemHandles(), mhdf_getElemName(), mhdf_getElemTypeName(), mhdf_getNextStartId(), mhdf_getNumberTags(), mhdf_getTagDataType(), mhdf_getTagNames(), mhdf_haveAdjacency(), mhdf_haveDenseTag(), mhdf_haveNodes(), mhdf_haveSets(), mhdf_isPolyElement(), mhdf_openAdjacency(), mhdf_openConnectivity(), mhdf_openConnectivitySimple(), mhdf_openDenseTagData(), mhdf_openNodeCoords(), mhdf_openNodeCoordsSimple(), mhdf_openPolyConnectivity(), mhdf_openSetChildren(), mhdf_openSetData(), mhdf_openSetMeta(), mhdf_openSetMetaSimple(), mhdf_openSetParents(), mhdf_readHistory(), and mhdf_writeHistory().