Meshset data.

Modules
	Set flag bits
Functions
hid_t	mhdf_createSetMeta (mhdf_FileHandle file_handle, long num_sets, long *first_set_id_out, mhdf_Status *status)
	Create table holding list of meshsets and their properties.
int	mhdf_haveSets (mhdf_FileHandle file, int *have_set_data_out, int *have_set_child_out, int *have_set_parents_out, mhdf_Status *status)
	Check if file contains any sets.
hid_t	mhdf_openSetMeta (mhdf_FileHandle file_handle, long *num_sets_out, long *first_set_id_out, mhdf_Status *status)
	Open table holding list of meshsets and their properties.
hid_t	mhdf_openSetMetaSimple (mhdf_FileHandle file_handle, mhdf_Status *status)
void	mhdf_readSetMeta (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_desc_data, mhdf_Status *status)
	Read list of sets and meta-information about sets.
void	mhdf_readSetMetaWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_desc_data, hid_t read_prop, mhdf_Status *status)
void	mhdf_readSetFlags (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_flag_data, mhdf_Status *status)
	Read only the flags portion of the set description table.
void	mhdf_readSetFlagsWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *set_flag_data, hid_t read_prop, mhdf_Status *status)
void	mhdf_readSetContentEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
	Read only the content end indices portion of the set description table.
void	mhdf_readSetContentEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void	mhdf_readSetChildEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
	Read only the child end indices portion of the set description table.
void	mhdf_readSetChildEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void	mhdf_readSetParentEndIndices (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, mhdf_Status *status)
	Read only the parent end indices portion of the set description table.
void	mhdf_readSetParentEndIndicesWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *end_indices_out, hid_t read_prop, mhdf_Status *status)
void	mhdf_writeSetMeta (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *set_desc_data, mhdf_Status *status)
	Write list of sets and meta-information about sets.
void	mhdf_writeSetMetaWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *set_desc_data, hid_t write_prop, mhdf_Status *status)
hid_t	mhdf_createSetData (mhdf_FileHandle file_handle, long data_list_size, mhdf_Status *status)
	Create file object to hold list of meshset contents.
hid_t	mhdf_openSetData (mhdf_FileHandle file_handle, long *data_list_size_out, mhdf_Status *status)
	Open the file object for the meshset contents.
void	mhdf_writeSetData (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, const void *set_data, mhdf_Status *status)
	Write set contents.
void	mhdf_writeSetDataWithOpt (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, const void *set_data, hid_t write_prop, mhdf_Status *status)
void	mhdf_readSetData (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, void *set_data, mhdf_Status *status)
	Read set contents.
void	mhdf_readSetDataWithOpt (hid_t set_handle, long offset, long count, hid_t hdf_integer_type, void *set_data, hid_t read_prop, mhdf_Status *status)
hid_t	mhdf_createSetChildren (mhdf_FileHandle file_handle, long child_list_size, mhdf_Status *status)
	Create file object for storing the set child list.
hid_t	mhdf_openSetChildren (mhdf_FileHandle file_handle, long *child_list_size, mhdf_Status *status)
	Open the file object containing the set child list.
hid_t	mhdf_createSetParents (mhdf_FileHandle file_handle, long parent_list_size, mhdf_Status *status)
	Create file object for storing the set parent list.
hid_t	mhdf_openSetParents (mhdf_FileHandle file_handle, long *parent_list_size, mhdf_Status *status)
	Open the file object containing the set parent list.
void	mhdf_writeSetParentsChildren (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, mhdf_Status *status)
	Write set parent/child list.
void	mhdf_writeSetParentsChildrenWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, const void *id_list, hid_t write_prop, mhdf_Status *status)
void	mhdf_readSetParentsChildren (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, mhdf_Status *status)
	Read set parent/child list.
void	mhdf_readSetParentsChildrenWithOpt (hid_t data_handle, long offset, long count, hid_t hdf_integer_type, void *id_list, hid_t read_prop, mhdf_Status *status)

---

Detailed Description

Meshset data is divided into three groups of data. The set-list/meta-information table, the set contents table and the set children table. Each is written and read independently.

The set list table contains one row for each set. Each row contains four values: {content list end index, child list end index, parent list end index, and flags}. The flags value is a collection of bits with values defined in Set flag bits . The all the flags except mhdf_SET_RANGE_BIT are saved properties of the mesh data and are not relevant to the actual file in any way. The mhdf_SET_RANGE_BIT flag is a toggle for how the meshset contents (not children) are saved. It is an internal property of the file format and should not be passed on to the mesh database. The content list end index and child list end index are the indices of the last entry for the set in the contents and children tables respectively. In the case where a set has either no children or no contents, the last index of should be the same as the last index of the previous set in the table, or -1 for the first set in the table. Thus the first index is always one greater than the last index of the previous set. If the first index, calculated as one greater that the last index of the previous set is greater than the last index of the current set, then there are no values in the corresponding contents or children table for that set.

The set contents table is a vector of integer global IDs that is the concatenation of the contents data for all of the mesh sets. The values are stored corresponding to the order of the sets in the set list table. Depending on the value of mhdf_SET_RANGE_BIT in the flags field of the set list table, the contents for a specific set may be stored in one of two formats. If the flag is set, the contents list is a list of pairs where each pair is a starting global Id and a count. For each pair, the set contains the range of global Ids beginning at the start value. If the mhdf_SET_RANGE_BIT flag is not set, the meshset contents are a simple list of global Ids.

The meshset child table is a vector of integer global IDs. It is a concatenation of the child lists for all the mesh sets, in the order the sets occur in the meshset list table. The values are always simple lists. The child table may never contain ranges of IDs.

---

Function Documentation

hid_t mhdf_createSetChildren	(	mhdf_FileHandle	file_handle,
		long	child_list_size,
		mhdf_Status *	status
	)

Create file object for storing the set child list.

Create a data group for the list of set children. The format of this data is the concatenation of the lists of global IDs of child sets for each set. The order of the sets and the number of children for each set is contained in the set meta table. (See mhdf_createSetMeta ).

Parameters:

file_handle	The file
child_list_size	The total length of the data (the sum of the number of children for each set.)
status	Passed back status of API call.

Returns:

A handle to the data object in the file.

hid_t mhdf_createSetData	(	mhdf_FileHandle	file_handle,
		long	data_list_size,
		mhdf_Status *	status
	)

Create file object to hold list of meshset contents.

Create set contents data object. The format of this data is a vector of integer values which is the concatenation of the contents list for all the meshsets. The length and format of the data for each set is stored in the set meta table. See mhdf_createSetMeta and mhdf_SET_RANGE_BIT for a description of that data.

Parameters:

file_handle	The file.
data_list_size	The total length (number of integer values) to be written for all the sets.
status	Passed back status of API call.

Returns:

A handle to the table.

hid_t mhdf_createSetMeta	(	mhdf_FileHandle	file_handle,
		long	num_sets,
		long *	first_set_id_out,
		mhdf_Status *	status
	)

Create table holding list of meshsets and their properties.

The set table contains description of sets, but not contents or children. The table is a n x 4 matrix of values. One row for each of n sets. Each row contains the end index for the set in the contents table, the end index for the set in the children table, the end index for the set in the parents table, and the set flags, respectively. The mhdf_SET_RANGE_BIT bit in the flags specifies the format of the contents list for each set. See a description of the mhdf_SET_RANGE_BIT flag for a description of the two possible data formats. The index values in the first two columns of the table are the index of the last value for the set in the corresponding contents and children lists. The first index is always one greater than the last index for the previous set in the table. The first index of the first set in the table is implicitly zero. A special value of -1 in the appropriate column should be used to indicate that the first set contains no contents or has no children. For any other set, if the last index for the set is the same as that of the previous set, it has no data in the corresponding list.

Parameters:

file_handle	The file.
num_sets	The number of sets in the table.
first_set_id_out	The global ID that will be assigned to the first set in the table. All subsequent sets in the table will be assigned sequential global IDs.
status	Passed back status of API call.

Returns:

The handle to the set meta-data table.

hid_t mhdf_createSetParents	(	mhdf_FileHandle	file_handle,
		long	parent_list_size,
		mhdf_Status *	status
	)

Create file object for storing the set parent list.

Create a data group for the list of set parents. The format of this data is the concatenation of the lists of global IDs of parent sets for each set. The order of the sets and the number of parents for each set is contained in the set meta table. (See mhdf_createSetMeta ).

Parameters:

file_handle	The file
parent_list_size	The total length of the data (the sum of the number of parents for each set.)
status	Passed back status of API call.

Returns:

A handle to the data object in the file.

int mhdf_haveSets	(	mhdf_FileHandle	file,
		int *	have_set_data_out,
		int *	have_set_child_out,
		int *	have_set_parents_out,
		mhdf_Status *	status
	)

Check if file contains any sets.

Parameters:

file	The file.
have_set_data_out	If non-null set to 1 if file contains table of set contents, zero otherwise.
have_set_child_out	If non-null set to 1 if file contains table of set children, zero otherwise.
have_set_parents_out	If non-null set to 1 if file contains table of set parents, zero otherwise.
status	Passed back status of API call.

Returns:

Zero if the file does not contain any sets, one if it does.

hid_t mhdf_openSetChildren	(	mhdf_FileHandle	file_handle,
		long *	child_list_size,
		mhdf_Status *	status
	)

Open the file object containing the set child list.

Open the data group containing the list of set children. See mhdf_createSetChildren and mhdf_createSetMeta for a description of this data.

Parameters:

file_handle	The file
child_list_size	The total length of the data (the sum of the number of children for each set.)
status	Passed back status of API call.

Returns:

A handle to the data object in the file.

hid_t mhdf_openSetData	(	mhdf_FileHandle	file_handle,
		long *	data_list_size_out,
		mhdf_Status *	status
	)

Open the file object for the meshset contents.

Open set contents data object. The format of this data is a vector of integer values which is the concatenation of the contents list for all the meshsets. The length and format of the data for each set is stored in the set meta table. See mhdf_createSetMeta and mhdf_SET_RANGE_BIT for a description of that data.

Parameters:

file_handle	The file.
data_list_size_out	The length of the table.
status	Passed back status of API call.

Returns:

A handle to the table.

hid_t mhdf_openSetMeta	(	mhdf_FileHandle	file_handle,
		long *	num_sets_out,
		long *	first_set_id_out,
		mhdf_Status *	status
	)

Open table holding list of meshsets and their properties.

Open set list. See mhdf_createSetMeta or Meshset data. for a description of this data.

Parameters:

file_handle	The file.
num_sets_out	The number of sets in the table.
first_set_id_out	The global ID that will of the first set in the table. All subsequent sets in the table have sequential global IDs.
status	Passed back status of API call.

Returns:

The handle to the set meta-data table.

hid_t mhdf_openSetMetaSimple	(	mhdf_FileHandle	file_handle,
		mhdf_Status *	status
	)

hid_t mhdf_openSetParents	(	mhdf_FileHandle	file_handle,
		long *	parent_list_size,
		mhdf_Status *	status
	)

Open the file object containing the set parent list.

Open the data group containing the list of set parents. See mhdf_createSetParents and mhdf_createSetMeta for a description of this data.

Parameters:

file_handle	The file
parent_list_size	The total length of the data (the sum of the number of parents for each set.)
status	Passed back status of API call.

Returns:

A handle to the data object in the file.

void mhdf_readSetChildEndIndices	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		mhdf_Status *	status
	)

Read only the child end indices portion of the set description table.

For each set, read the last index of that set's data in the set children table.

NOTE: This is a signed value. Any sets w/out contents that occur first in the list will have an end index of -1.

Parameters:

data_handle	The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
offset	The offset (set index) at which to begin reading.
count	The number of values (number of sets) to read.
hdf_integer_type	The integer type of the input array 'set_flag_data'.
end_indices_out	Array of indices.
status	Location at which to store status of API call.

void mhdf_readSetChildEndIndicesWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetContentEndIndices	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		mhdf_Status *	status
	)

Read only the content end indices portion of the set description table.

For each set, read the last index of that set's data in the set contents table.

NOTE: This is a signed value. Any sets w/out contents that occur first in the list will have an end index of -1.

Parameters:

data_handle	The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
offset	The offset (set index) at which to begin reading.
count	The number of values (number of sets) to read.
hdf_integer_type	The integer type of the input array 'set_flag_data'.
end_indices_out	Array of indices.
status	Location at which to store status of API call.

void mhdf_readSetContentEndIndicesWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetData	(	hid_t	set_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_data,
		mhdf_Status *	status
	)

Read set contents.

Read data specifying entities contained in sets. The format of this data is a vector of integer values which is the concatenation of the contents list for all the meshsets. The length and format of the data for each set is stored in the set meta table. See mhdf_createSetMeta and mhdf_SET_RANGE_BIT for a description of that data.

Parameters:

set_handle	The handle returned from mhdf_createSetData or mhdf_openSetData .
offset	The position at which to read from the integer vector.
count	The number of values to read from the data vector.
hdf_integer_type	The type of the integer data in set_data. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
set_data	A pointer to memory at which to store the read data.
status	Passed back status of API call.

void mhdf_readSetDataWithOpt	(	hid_t	set_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_data,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetFlags	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_flag_data,
		mhdf_Status *	status
	)

Read only the flags portion of the set description table.

Read flags for each set from the set description table. See mhdf_createSetMeta for a description of this data.

Parameters:

data_handle	The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
offset	The offset (set index) at which to begin reading.
count	The number of values (number of sets) to read.
hdf_integer_type	The integer type of the input array 'set_flag_data'.
set_flag_data	Array of integers.
status	Location at which to store status of API call.

void mhdf_readSetFlagsWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_flag_data,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetMeta	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_desc_data,
		mhdf_Status *	status
	)

Read list of sets and meta-information about sets.

Read set descriptions. See mhdf_createSetMeta or Meshset data. for a description of this data.

Parameters:

data_handle	The handle returned from mhdf_createSetMeta or mhdf_openSetMeta.
offset	The offset (set index) to begin reading at.
count	The number of rows (sets, integer triples) to read.
hdf_integer_type	The type of the integer data in set_desc_data. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
status	Passed back status of API call.
set_desc_data	The memory location at which to write the data.

void mhdf_readSetMetaWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	set_desc_data,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetParentEndIndices	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		mhdf_Status *	status
	)

Read only the parent end indices portion of the set description table.

For each set, read the last index of that set's data in the set parents table.

NOTE: This is a signed value. Any sets w/out contents that occur first in the list will have an end index of -1.

Parameters:

data_handle	The handle returned from mdhf_createSetMeta or mhdf_openSetMeta
offset	The offset (set index) at which to begin reading.
count	The number of values (number of sets) to read.
hdf_integer_type	The integer type of the input array 'set_flag_data'.
end_indices_out	Array of indices.
status	Location at which to store status of API call.

void mhdf_readSetParentEndIndicesWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	end_indices_out,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_readSetParentsChildren	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	id_list,
		mhdf_Status *	status
	)

Read set parent/child list.

Read from the list of parent or child IDs for sets. See mhdf_createSetChildren and mhdf_createSetMeta for a description of this data.

Parameters:

data_handle	The value returned from mhdf_createSetChildren or mhdf_openSetChildren.
offset	The offset into the list of global IDs.
count	The number of global IDs to read.
hdf_integer_type	The type of the integer data in child_id_list. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
id_list	Pointer to memory in which to the read data.
status	Passed back status of API call.

void mhdf_readSetParentsChildrenWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		void *	id_list,
		hid_t	read_prop,
		mhdf_Status *	status
	)

void mhdf_writeSetData	(	hid_t	set_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	set_data,
		mhdf_Status *	status
	)

Write set contents.

Write data specifying entities contained in sets. The format of this data is a vector of integer values which is the concatenation of the contents list for all the meshsets. The length and format of the data for each set is stored in the set meta table. See mhdf_createSetMeta and mhdf_SET_RANGE_BIT for a description of that data.

Parameters:

set_handle	The handle returned from mhdf_createSetData or mhdf_openSetData .
offset	The position at which to write into the integer vector.
count	The number of values to write into the data vector.
hdf_integer_type	The type of the integer data in set_data. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
set_data	The data to write.
status	Passed back status of API call.

void mhdf_writeSetDataWithOpt	(	hid_t	set_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	set_data,
		hid_t	write_prop,
		mhdf_Status *	status
	)

void mhdf_writeSetMeta	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	set_desc_data,
		mhdf_Status *	status
	)

Write list of sets and meta-information about sets.

Write set descriptions. See mhdf_createSetMeta or Meshset data. for a description of the data format.

Parameters:

data_handle	The handle returned from mhdf_createSetMeta or mhdf_openSetMeta.
offset	The offset (set index) to begin writing at.
count	The number of rows (sets, integer triples) to write.
hdf_integer_type	The type of the integer data in set_desc_data. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
set_desc_data	The data to write.
status	Passed back status of API call.

void mhdf_writeSetMetaWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	set_desc_data,
		hid_t	write_prop,
		mhdf_Status *	status
	)

void mhdf_writeSetParentsChildren	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	id_list,
		mhdf_Status *	status
	)

Write set parent/child list.

Write the list of parent or child IDs for sets. See mhdf_createSetChildren and mhdf_createSetMeta for a description of this data.

Parameters:

data_handle	The value returned from mhdf_createSetChildren or mhdf_openSetChildren.
offset	The offset into the list of global IDs.
count	The number of global IDs to write.
hdf_integer_type	The type of the integer data in child_id_list. Typically H5T_NATIVE_INT or N5T_NATIVE_LONG as defined in H5Tpublic.h. The HDF class of this type object must be H5T_INTEGER
id_list	The data to write.
status	Passed back status of API call.

void mhdf_writeSetParentsChildrenWithOpt	(	hid_t	data_handle,
		long	offset,
		long	count,
		hid_t	hdf_integer_type,
		const void *	id_list,
		hid_t	write_prop,
		mhdf_Status *	status
	)