msl.io.vertex module

A vertex in a tree.

class msl.io.vertex.Vertex(name, parent, read_only, **metadata)[source]

Bases: Dictionary

A vertex in a tree.

Parameters:

  • name (str) – The name of this vertex.

  • parent (Group) – The parent of this vertex.

  • read_only (bool) – Whether this vertex is in read-only mode.

  • **metadata – Key-value pairs that are used to create the Metadata for this Vertex.

add_metadata(**metadata)[source]

Add key-value pairs to the Metadata for this Vertex.

property metadata

The metadata associated with this Vertex.

Type:

Metadata

property name

The name of this Vertex.

Type:

str

property parent

The parent of this Vertex.

Type:

Group

property read_only

Whether this Vertex is in read-only mode.

Setting this value will also update all sub-Groups and sub-Datasets to be in the same mode.

Type:

bool