F5Path.h

Go to the documentation of this file.

/*
 *
 * $Id: F5Path.h,v 1.7 2008/02/22 23:51:25 werner Exp $
 *
 */
 
#ifndef __F5Path_H
#define __F5Path_H
 
#include "F5L.h"
#include "F5Bchart.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/**\defgroup F5F Field Operations
   Interfacing data set creation/write routines using the F5Path structure.
   Calls the low-level Field operation functions, but is designed for the
   end-user.
  */
 
/**
 Field identifiers.
 This structure contains all HDF5 identifiers that describe a path
 in an HDF5 file towards a field structure.
 Each or all may be empty (null or negative) as well.
*/
typedef struct
{
        /** Chart domain ID's as they reside in memory */
        ChartDomain_IDs *myChart,
        /** Chart domain ID's as they are committed in the file */
                        *FileIDs;
 
        char    *field_info;            /**< A textual description from F5contents.h */
 
        /**
           The field enum type for this file.
           If none is defined here, then F5Ttransient_F5field_enum() is
           to be used, but on first write access to a file then
           F5Tsave_F5field_enum() is to be called.
           This field type may also refer to a type loaded from a disc,
           and may then contain versioning information about the field
           descriptions within this file.
         */
        hid_t   field_enum_type_hid;
 
        hid_t   File_hid,               /**< Reference to file ID */
                ContentsGroup_hid,      /**< The TableOfContents group ID */
                Slice_hid,              /**< HDF5 Slice Group (uppermost group) */
                Grid_hid,               /**< Grid ID    */
                GlobalChart_hid,        /**< Global chart group */
                Charts_hid,             /**< Group of all charts per grid       */
                Chart_hid,              /**< ID of currently used chart that is valid for the field     */
                Topology_hid,           /**< ID of the grid's topological space (e.g. refinement level) */
                Representation_hid,     /**< Representation group ID (the group containing all datasets)        */
                Field_hid;              /**< ID of the field (can be group or dataset ID)       */
 
}
        F5Path;
 
 
F5_API  F5Path* newF5Path(hid_t File_id);
F5_API  void    deleteF5Path(F5Path*f);
 
/** \ingroup F5L
    Low-level creation function for F5Path objects.
    @param time Pointer to the time instance of the current parameter space slices, or NULL
                if the data reside in a zero-dimensional parameter space, i.e. they are static.
                In a future extension, this may be a point to a multidimensional structure
                specifying the location in multidimensional parameter space.
 
   @param SkeletonDimensionality The dimensionality of the k-cells that is described by this
                Skeleton of a Grid.
 
   @param DataspaceDimensionality The dimensionality of the data that is used for the data
                on this Skeleton. This is best to be identical to the SkeletonDimensionality,
                but may differ, for instance one can store data in one-dimensional arrays
                over a 2D grid, or have some kind of irregular point distribution.
 */
F5_API F5Path*  F5LTcreate(hid_t File_id, const double*time,
                           const char*gridname,
                           ChartDomain_IDs*ChartDomain,
                           new_global_chart_f coord_creator,
                           const char*coordinate_system,
                           const char*TopologyName,
                           int IndexDepth, int SkeletonDimensionality,
                           int DataspaceDimensionality,
                           const hsize_t*refinement);
 
 
/**
   Get the field enum type associated with this F5Path.
   May be used to check versioning information of field
   descriptions.
   \TODO Retrieve versioning from existing file, current
         implementation just writes.
 */
F5_API hid_t F5LTmake_enum_type(F5Path*fpath);
 
 
#ifdef  __cplusplus
} /* extern "C" */
#endif
 
 
#endif  /* __F5Path_H */