Skip to main content

write_attribute

Method of HDF5Group.

Overloads​

NameDescription
write_attribute(const string path, const string name, const string value) -> HDF5GroupWrites an attribute on a dataset or subgroup relative to the group.
write_attribute(const string name, const bool value) -> HDF5GroupWrites a group attribute and returns the group for chaining.
write_attribute(const string name, const string value) -> HDF5GroupWrites a group attribute and returns the group for chaining.
write_attribute(const string name, const complex value) -> HDF5GroupWrites a group attribute and returns the group for chaining.
write_attribute(const string name, const List values, as_string type) -> HDF5GroupWrites a string list attribute on the group.
write_attribute(const string path, const string name, const List values) -> HDF5GroupWrites a list attribute on a relative object path.
write_attribute(const string path, const string name, const List values, as_bool type) -> HDF5GroupWrites a bool list attribute on a relative object path.
write_attribute(const string path, const string name, const List values, as_integer type) -> HDF5GroupWrites a integer list attribute on a relative object path.
write_attribute(const string path, const string name, const List values, as_real type) -> HDF5GroupWrites a real list attribute on a relative object path.
write_attribute(const string path, const string name, const List values, as_complex type) -> HDF5GroupWrites a complex list attribute on a relative object path.
write_attribute(const string path, const string name, const List values, as_string type) -> HDF5GroupWrites a string list attribute on a relative object path.
write_attribute(const string path, const string name, const complex value) -> HDF5GroupWrites an attribute on a dataset or subgroup relative to the group.
write_attribute(const string path, const string name, const bool value) -> HDF5GroupWrites an attribute on a dataset or subgroup relative to the group.
write_attribute(const string path, const string name, const real value) -> HDF5GroupWrites an attribute on a dataset or subgroup relative to the group.
write_attribute(const string path, const string name, const integer value) -> HDF5GroupWrites an attribute on a dataset or subgroup relative to the group.
write_attribute(const string name, const List values) -> HDF5GroupWrites a list attribute on the group.
write_attribute(const string name, const List values, as_bool type) -> HDF5GroupWrites a bool list attribute on the group.
write_attribute(const string name, const List values, as_integer type) -> HDF5GroupWrites a integer list attribute on the group.
write_attribute(const string name, const List values, as_real type) -> HDF5GroupWrites a real list attribute on the group.
write_attribute(const string name, const List values, as_complex type) -> HDF5GroupWrites a complex list attribute on the group.
write_attribute(const string name, const integer value) -> HDF5GroupWrites a group attribute and returns the group for chaining.
write_attribute(const string name, const real value) -> HDF5GroupWrites a group attribute and returns the group for chaining.

write_attribute(const string path, const string name, const string value) -> HDF5Group​

Writes an attribute on a dataset or subgroup relative to the group.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.create_group("run1")
g.write_attribute("run1", "status", "ok")

write_attribute(const string name, const bool value) -> HDF5Group​

Writes a group attribute and returns the group for chaining.

Parameters​

  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.write_attribute("units", "meV")

write_attribute(const string name, const string value) -> HDF5Group​

Writes a group attribute and returns the group for chaining.

Parameters​

  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.write_attribute("units", "meV")

write_attribute(const string name, const complex value) -> HDF5Group​

Writes a group attribute and returns the group for chaining.

Parameters​

  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.write_attribute("units", "meV")

write_attribute(const string name, const List values, as_string type) -> HDF5Group​

Writes a string list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_string).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values) -> HDF5Group​

Writes a list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values, as_bool type) -> HDF5Group​

Writes a bool list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_bool).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values, as_integer type) -> HDF5Group​

Writes a integer list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_integer).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values, as_real type) -> HDF5Group​

Writes a real list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_real).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values, as_complex type) -> HDF5Group​

Writes a complex list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_complex).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const List values, as_string type) -> HDF5Group​

Writes a string list attribute on a relative object path.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_string).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string path, const string name, const complex value) -> HDF5Group​

Writes an attribute on a dataset or subgroup relative to the group.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.create_group("run1")
g.write_attribute("run1", "status", "ok")

write_attribute(const string path, const string name, const bool value) -> HDF5Group​

Writes an attribute on a dataset or subgroup relative to the group.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.create_group("run1")
g.write_attribute("run1", "status", "ok")

write_attribute(const string path, const string name, const real value) -> HDF5Group​

Writes an attribute on a dataset or subgroup relative to the group.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.create_group("run1")
g.write_attribute("run1", "status", "ok")

write_attribute(const string path, const string name, const integer value) -> HDF5Group​

Writes an attribute on a dataset or subgroup relative to the group.

Parameters​

  • path: Relative object path.
  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.create_group("run1")
g.write_attribute("run1", "status", "ok")

write_attribute(const string name, const List values) -> HDF5Group​

Writes a list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string name, const List values, as_bool type) -> HDF5Group​

Writes a bool list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_bool).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string name, const List values, as_integer type) -> HDF5Group​

Writes a integer list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_integer).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string name, const List values, as_real type) -> HDF5Group​

Writes a real list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_real).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string name, const List values, as_complex type) -> HDF5Group​

Writes a complex list attribute on the group.

Parameters​

  • name: Attribute name.
  • values: List of primitive values.
  • type: Type tag (as_complex).

Returns​

Reference to the same HDF5Group instance.

write_attribute(const string name, const integer value) -> HDF5Group​

Writes a group attribute and returns the group for chaining.

Parameters​

  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.write_attribute("units", "meV")

write_attribute(const string name, const real value) -> HDF5Group​

Writes a group attribute and returns the group for chaining.

Parameters​

  • name: Attribute name.
  • value: Scalar value to write.

Returns​

Reference to the same HDF5Group instance.

Example​

var g = HDF5File("data.h5", "w").create_group("/runs")
g.write_attribute("units", "meV")