H5list_vars

Synopsis

H5list_vars is a utility that is used in the user interface for Rd_HDF5_Field and Rd_HDF5_Time_Field.

module H5list_vars {
string+Iparam filename;
string+read+IPort2 h5root = "/";
// All of the following are outputs.
// Dimensional information to guide the
// selection of crop and downsize parameters.
int+Oparam ndim;
int+Oparam dims[ndim];
// Node Data components
string+Oparam nodeVars[];
// Cell Data components
string+Oparam cellVars[];
// Number of time steps
int+Oparam timeSteps;
// Output trigger to help the UI.
int+Oparam do;
omethod+notify_val+notify_inst update<status=1> =
"HDF5list_vars_update";
};

Description

H5list_vars is a utility that is used in the user interface for Rd_HDF5_Field and Rd_HDF5_Time_Field. It scans the input HDF5 file and then generates lists of node data variables, cell data variables, and dimensions that are used in the Rd_HDF5_XXX UI.

Input

filename

string. The name of the file to read in.

h5root

string. Allows reading of an Express field that is sested in some larger dataset.

Output

ndim

int. The number of dimentions

ndims[]

array. The array of dimentions in a structured field.

nodeVars[]

string. A list of node data names. The name of each componenet is taken from the component label if present. It not present a name in the form of "node_data_X" will be generated.

int cellVars[]

string. A list of cell data names. The name of each componenet is taken from the component label if present. It not present a name in the form of "cell_data_X" will be generated.

int timeStep

int. The number of time steps in the file

Example

Not available.

File

v/hdf5.v

See also

H5read_array

H5read_field, H5read_time_field

H5write_array

H5write_field, H5write_time_field