F5Path Struct Reference

#include <F5Path.h>

Data Fields
ChartDomain_IDs *	myChart
ChartDomain_IDs *	FileIDs
char *	field_info
hid_t	field_enum_type_hid
hid_t	File_hid
hid_t	ContentsGroup_hid
hid_t	Slice_hid
hid_t	Grid_hid
hid_t	GlobalChart_hid
hid_t	Charts_hid
hid_t	Chart_hid
hid_t	Topology_hid
hid_t	Representation_hid
hid_t	Field_hid

Detailed Description

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.

Examples

ADCIRCtoF5.cpp, FragmentedField.c, ObjtoF5.c, RegularReader.c, ScalarSimple.c, SchwarzschildF5.c, and mm5-nc2F5.c.

Field Documentation

Chart_hid

hid_t F5Path::Chart_hid

ID of currently used chart that is valid for the field

Referenced by F5iterate_topologies(), F5iterate_topology_fields(), and F5LTcreateV().

Charts_hid

hid_t F5Path::Charts_hid

Group of all charts per grid

Referenced by F5iterate_topologies(), F5iterate_topology_fields(), and F5LTcreateV().

ContentsGroup_hid

hid_t F5Path::ContentsGroup_hid

The TableOfContents group ID

Referenced by F5LTcreateV().

field_enum_type_hid

hid_t F5Path::field_enum_type_hid

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.

Referenced by F5close(), and F5LTcreateV().

Field_hid

hid_t F5Path::Field_hid

ID of the field (can be group or dataset ID)

Referenced by F5Fclose(), F5Fcreate(), F5Fget_type2(), F5Fgrab(), F5Fopen(), F5Fread_linear(), F5FSwrite_fraction(), F5Fwrite_fraction(), F5Fwrite_fractionS(), F5Fwrite_linear(), F5Fwrite_linear_fraction(), F5FwriteIMAGE(), F5FwriteX(), F5Rcreate_rectilinear(), F5Tget_space(), F5write_particle_cartesian3Dv(), and F5write_particle_cartesian3DvU().

field_info

char* F5Path::field_info

A textual description from F5contents.h

File_hid

hid_t F5Path::File_hid

Reference to file ID

Referenced by F5Flink_triangular_surface().

FileIDs

ChartDomain_IDs * F5Path::FileIDs

Chart domain ID's as they are committed in the file

Referenced by F5close(), F5Cwrite_regular_surface(), F5Cwrite_triangular_surface(), F5Flink_triangular_surface(), and F5write_particle_cartesian3DvU().

GlobalChart_hid

hid_t F5Path::GlobalChart_hid

Global chart group

Referenced by F5FwriteX().

Grid_hid

hid_t F5Path::Grid_hid

Grid ID

Referenced by F5Flink_triangular_surface(), F5has_standard_vertex_fields(), F5iterate_topology_fields(), F5iterate_vertex_fields(), F5LTcreateV(), F5P_has_vertices(), F5P_is_curvilinear(), F5P_is_Zstacked(), F5Rget_timestep(), F5Rlink_default_vertex_topology(), and F5Rset_timestep().

myChart

ChartDomain_IDs* F5Path::myChart

Chart domain ID's as they reside in memory

Referenced by F5close(), F5Fcreate(), and F5Rcreate_rectilinear().

Representation_hid

hid_t F5Path::Representation_hid

Representation group ID (the group containing all datasets)

Referenced by F5close(), F5Cwrite_regular_surface(), F5Fcreate(), F5Fis_linear(), F5Flink_triangular_surface(), F5Fopen(), F5FSwrite_fraction(), F5Fwrite_fraction(), F5Fwrite_fractionS(), F5Fwrite_linear(), F5Fwrite_linear_fraction(), F5FwriteIMAGE(), F5FwriteX(), F5iterate_fields(), F5iterate_representations(), F5iterate_topologies(), F5iterate_topology_fields(), F5Rcreate_relative_vertex_Irefinement3D(), F5Rcreate_relative_vertex_Qrefinement3D(), F5write_particle_cartesian3Dv(), and F5write_particle_cartesian3DvU().

Slice_hid

hid_t F5Path::Slice_hid

HDF5 Slice Group (uppermost group)

Referenced by F5iterate_grids(), and F5LTcreateV().

Topology_hid

hid_t F5Path::Topology_hid

ID of the grid's topological space (e.g. refinement level)

Referenced by F5iterate_representations(), F5iterate_topologies(), F5iterate_topology_fields(), F5iterate_vertex_fields(), F5LTcreateV(), F5P_has_vertices(), and F5Tget_space().

---

The documentation for this struct was generated from the following file:

• F5Path.h