RegisterData

class RegisterData(root: Register)[source]

Class for a storing, managing and accessing data for a register file.

add_after(after: Register, new: Register) None[source]

Adds a new register to the data after another specified register.

Parameters:
  • after (Register) – The existing register which will be appended

  • new (Register) – The new register to add to the data

add_before(before: Register, new: Register) None[source]

Adds a new register to the data before another specified register.

Parameters:
  • before (Register) – The existing register which will be preppended

  • new (Register) – The new register to add to the data

append(r: Register) None[source]

Appends a register to the end of the data.

Parameters:

r (Register) – The new register to append to the data

get_registers_of_type(t: type[_T], **kwargs: object) _T | list[_T] | None[source]

A register or register list that only returns registers of type T that meet given filter requirements passed as kwargs.

Parameters:

t (Type[_T]) – The register type that is desired

Returns:

Registers filtered by type _T and optional properties

Return type:

_T | list[_T] | None

of_type(t: type[_T]) Generator[_T, None, None][source]

A register generator that only returns registers of type T.

Parameters:

t (Type[_T]) – The register type that is desired

Yield:

Registers filtered by type _T

Return type:

Generator[_T, None, None]

preppend(r: Register) None[source]

Appends a register to the beginning of the data.

Parameters:

r (Register) – The new register to preppended to the data.

remove(r: Register) None[source]

Removes an existing register in the chain.

Parameters:

r (Register) – The register to be removed

remove_registers_of_type(t: type[_T], **kwargs: object) None[source]

Removes a set of registers given a type and an optional group of filters, similar to get_registers_of_type()

Parameters:

t (Type[_T]) – The register type that is desired