H5Part  1.6.6
Functions
Reading and Writing Attributes
H5Block C API

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)

Function Documentation

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:
fIN: file handle
field_nameIN: field name
x_originOUT: X origin
y_originOUT: Y origin
z_originOUT: 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 
)

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

Returns:
H5PART_SUCCESS or error code
Parameters:
fIN: file handle
field_nameIN: field name
x_spacingOUT: X spacing
y_spacingOUT: Y spacing
z_spacingOUT: 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 
)

Set field origin.

Returns:
H5PART_SUCCESS or error code
Parameters:
fIN: file handle
field_nameIN: field name
x_originIN: X origin
y_originIN: Y origin
z_originIN: 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 
)

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

Returns:
H5PART_SUCCESS or error code
Parameters:
fIN: file handle
field_nameIN: field name
x_spacingIN: X spacing
y_spacingIN: Y spacing
z_spacingIN: 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 
)

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:
fIN: file handle
field_nameIN: field name
attrib_idxIN: attribute index
attrib_nameOUT: attribute name
len_of_attrib_nameIN: buffer size
attrib_typeOUT: attribute type
attrib_nelemOUT: number of elements
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
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueOUT: 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 
)

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

Returns:
H5PART_SUCCESS or error code
Parameters:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_typeIN: attribute type
attrib_valueIN: attribute value
attrib_nelemIN: number of elements
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueIN: attribute value
attrib_nelemIN: number of elements
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueIN: attribute value
attrib_nelemIN: number of elements
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueIN: attribute value
attrib_nelemIN: number of elements
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueIN: attribute value
attrib_nelemIN: number of elements
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:
fIN: file handle
field_nameIN: field name
attrib_nameIN: attribute name
attrib_valueIN: attribute value