pyGHDL.dom.Misc#

Todo

Add a module documentation.

Classes

  • Alias: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple


Classes

class pyGHDL.dom.Misc.Alias(node, aliasName, documentation=None)[source]#

Inheritance

Inheritance diagram of Alias

Parameters:
  • node (Iir) –

  • aliasName (str) –

  • documentation (str) –

__init__(node, aliasName, documentation=None)[source]#

Initializes underlying BaseType.

Parameters:
  • identifier – Name of the type.

  • node (Iir) –

  • aliasName (str) –

  • documentation (str | None) –

_parent: ModelEntity#

Reference to a parent entity in the model.

property Documentation: str | None#

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

property Identifier: str#

Returns a model entity’s identifier (name).

Returns:

Name of a model entity.

property NormalizedIdentifier: str#

Returns a model entity’s normalized identifier (lower case name).

Returns:

Normalized name of a model entity.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifier: str#

The identifier of a model entity.

_normalizedIdentifier: str#

The normalized (lower case) identifier of a model entity.

_documentation: Nullable[str]#

The associated documentation of a model entity.