Reading and Writing Attributes

Functions
h5part_int64_t	H5Block3dGetFieldOrigin (H5PartFile *f, const char *field_name, h5part_float64_t *x_origin, h5part_float64_t *y_origin, h5part_float64_t *z_origin)
h5part_int64_t	H5Block3dGetFieldSpacing (H5PartFile *f, const char *field_name, h5part_float64_t *x_spacing, h5part_float64_t *y_spacing, h5part_float64_t *z_spacing)
h5part_int64_t	H5Block3dSetFieldOrigin (H5PartFile *f, const char *field_name, const h5part_float64_t x_origin, const h5part_float64_t y_origin, const h5part_float64_t z_origin)
h5part_int64_t	H5Block3dSetFieldSpacing (H5PartFile *f, const char *field_name, const h5part_float64_t x_spacing, const h5part_float64_t y_spacing, const h5part_float64_t z_spacing)
h5part_int64_t	H5BlockGetFieldAttribInfo (H5PartFile *f, const char *field_name, const h5part_int64_t attrib_idx, char *attrib_name, const h5part_int64_t len_of_attrib_name, h5part_int64_t *attrib_type, h5part_int64_t *attrib_nelem)
h5part_int64_t	H5BlockGetNumFieldAttribs (H5PartFile *f, const char *field_name)
h5part_int64_t	H5BlockReadFieldAttrib (H5PartFile *f, const char *field_name, const char *attrib_name, void *attrib_value)
h5part_int64_t	H5BlockWriteFieldAttrib (H5PartFile *f, const char *field_name, const char *attrib_name, const h5part_int64_t attrib_type, const void *attrib_value, const h5part_int64_t attrib_nelem)
h5part_int64_t	H5BlockWriteFieldAttribFloat32 (H5PartFile *f, const char *field_name, const char *attrib_name, const h5part_float32_t *attrib_value, const h5part_int64_t attrib_nelem)
h5part_int64_t	H5BlockWriteFieldAttribFloat64 (H5PartFile *f, const char *field_name, const char *attrib_name, const h5part_float64_t *attrib_value, const h5part_int64_t attrib_nelem)
h5part_int64_t	H5BlockWriteFieldAttribInt32 (H5PartFile *f, const char *field_name, const char *attrib_name, const h5part_int32_t *attrib_value, const h5part_int64_t attrib_nelem)
h5part_int64_t	H5BlockWriteFieldAttribInt64 (H5PartFile *f, const char *field_name, const char *attrib_name, const h5part_int64_t *attrib_value, const h5part_int64_t attrib_nelem)
h5part_int64_t	H5BlockWriteFieldAttribString (H5PartFile *f, const char *field_name, const char *attrib_name, const char *attrib_value)

Detailed Description

Function Documentation

H5Block3dGetFieldOrigin()

h5part_int64_t H5Block3dGetFieldOrigin	(	H5PartFile *	f,
		const char *	field_name,
		h5part_float64_t *	x_origin,
		h5part_float64_t *	y_origin,
		h5part_float64_t *	z_origin
	)

Get field origin.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
x_origin	OUT: X origin
y_origin	OUT: Y origin
z_origin	OUT: Z origin

H5Block3dGetFieldSpacing()

h5part_int64_t H5Block3dGetFieldSpacing	(	H5PartFile *	f,
		const char *	field_name,
		h5part_float64_t *	x_spacing,
		h5part_float64_t *	y_spacing,
		h5part_float64_t *	z_spacing
	)

Get field spacing for field field_name in the current time step.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
x_spacing	OUT: X spacing
y_spacing	OUT: Y spacing
z_spacing	OUT: Z spacing

H5Block3dSetFieldOrigin()

h5part_int64_t H5Block3dSetFieldOrigin	(	H5PartFile *	f,
		const char *	field_name,
		const h5part_float64_t	x_origin,
		const h5part_float64_t	y_origin,
		const h5part_float64_t	z_origin
	)

Set field origin.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
x_origin	IN: X origin
y_origin	IN: Y origin
z_origin	IN: Z origin

H5Block3dSetFieldSpacing()

h5part_int64_t H5Block3dSetFieldSpacing	(	H5PartFile *	f,
		const char *	field_name,
		const h5part_float64_t	x_spacing,
		const h5part_float64_t	y_spacing,
		const h5part_float64_t	z_spacing
	)

Set field spacing for field field_name in the current time step.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
x_spacing	IN: X spacing
y_spacing	IN: Y spacing
z_spacing	IN: Z spacing

H5BlockGetFieldAttribInfo()

h5part_int64_t H5BlockGetFieldAttribInfo	(	H5PartFile *	f,
		const char *	field_name,
		const h5part_int64_t	attrib_idx,
		char *	attrib_name,
		const h5part_int64_t	len_of_attrib_name,
		h5part_int64_t *	attrib_type,
		h5part_int64_t *	attrib_nelem
	)

Query information about a attribute given by index attrib_idx and field name field_name. The function returns the name of the attribute, the type of the attribute and the number of elements of this type.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_idx	IN: attribute index
attrib_name	OUT: attribute name
len_of_attrib_name	IN: buffer size
attrib_type	OUT: attribute type
attrib_nelem	OUT: number of elements

H5BlockGetNumFieldAttribs()

h5part_int64_t H5BlockGetNumFieldAttribs	(	H5PartFile *	f,
		const char *	field_name
	)

Query the number of attributes of field field_name.

Returns

number of attributes or error code

H5BlockReadFieldAttrib()

h5part_int64_t H5BlockReadFieldAttrib	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		void *	attrib_value
	)

Read attribute attrib_name of field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	OUT: value

H5BlockWriteFieldAttrib()

h5part_int64_t H5BlockWriteFieldAttrib	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const h5part_int64_t	attrib_type,
		const void *	attrib_value,
		const h5part_int64_t	attrib_nelem
	)

Write attrib_value with type attrib_type as attribute attrib_name to field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_type	IN: attribute type
attrib_value	IN: attribute value
attrib_nelem	IN: number of elements

H5BlockWriteFieldAttribFloat32()

h5part_int64_t H5BlockWriteFieldAttribFloat32	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const h5part_float32_t *	attrib_value,
		const h5part_int64_t	attrib_nelem
	)

Write attrib_value with type floating points (32-bit) as attribute attrib_name to field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	IN: attribute value
attrib_nelem	IN: number of elements

H5BlockWriteFieldAttribFloat64()

h5part_int64_t H5BlockWriteFieldAttribFloat64	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const h5part_float64_t *	attrib_value,
		const h5part_int64_t	attrib_nelem
	)

Write attrib_value with type floating points (64-bit) as attribute attrib_name to field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	IN: attribute value
attrib_nelem	IN: number of elements

H5BlockWriteFieldAttribInt32()

h5part_int64_t H5BlockWriteFieldAttribInt32	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const h5part_int32_t *	attrib_value,
		const h5part_int64_t	attrib_nelem
	)

Write attrib_value with type integers (32-bit) as attribute attrib_name to field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	IN: attribute value
attrib_nelem	IN: number of elements

H5BlockWriteFieldAttribInt64()

h5part_int64_t H5BlockWriteFieldAttribInt64	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const h5part_int64_t *	attrib_value,
		const h5part_int64_t	attrib_nelem
	)

Write attrib_value with type integers (64-bit) as attribute attrib_name to field field_name.

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	IN: attribute value
attrib_nelem	IN: number of elements

H5BlockWriteFieldAttribString()

h5part_int64_t H5BlockWriteFieldAttribString	(	H5PartFile *	f,
		const char *	field_name,
		const char *	attrib_name,
		const char *	attrib_value
	)

Write string attrib_value as attribute attrib_name to field field_name..

Returns

H5PART_SUCCESS or error code

Parameters

f	IN: file handle
field_name	IN: field name
attrib_name	IN: attribute name
attrib_value	IN: attribute value