Attributes

attrs(object::Union{File,Group,Dataset,Datatype})

The attributes dictionary of object. Returns an AttributeDict, a Dict-like object for accessing the attributes of object.

attrs(object)["name"] = value  # create/overwrite an attribute
attr = attrs(object)["name"]   # read an attribute
delete!(attrs(object), "name") # delete an attribute
keys(attrs(object))            # list the attribute names

attributes(object::Union{File,Object})

The attributes of a file or object: this returns an Attributes object, which is Dict-like object for accessing the attributes of object: getindex will return an Attribute object, and setindex! will call write_attribute.

HDF5.Attribute

A HDF5 attribute: this is a piece of metadata attached to an HDF5 Group or Dataset. It acts like a Dataset, in that it has a defined datatype and dataspace, and can read and write data to it.

See also

• open_attribute
• create_attribute
• read_attribute
• write_attribute
• delete_attribute

open_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)

Open the Attribute named name on the object parent.

create_attribute(parent::Union{File,Object}, name::AbstractString, dtype::Datatype, space::Dataspace)
create_attribute(parent::Union{File,Object}, name::AbstractString, data)

Create a new Attribute object named name on the object parent, either by specifying the Datatype and Dataspace of the attribute, or by providing the data. Note that no data will be written: use write_attribute to write the data.

read_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)

Read the value of the named attribute on the parent object.

Example

julia> HDF5.read_attribute(g, "time")
2.45

write_attribute(parent::Union{File,Object}, name::AbstractString, data)

Write data as an Attribute named name on the object parent.

delete_attribute(parent::Union{File,Object}, name::AbstractString)

Delete the Attribute named name on the object parent.

rename_attribute(parent::Union{File,Object}, oldname::AbstractString, newname::AbstractString)

Rename the Attribute of the object parent named oldname to newname.

h5readattr(filename, name::AbstractString)

Read the attributes of the object at name in the HDF5 file filename, returning a Dict.

h5writeattr(filename, name::AbstractString, data::Dict)

Write data as attributes to the object at name in the HDF5 file filename.

num_attrs()

Retrieve the number of attributes from an object.

See API.h5o_get_info.