pyGHDL.dom.Object#

Classes

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

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

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

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

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

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


Classes

class pyGHDL.dom.Object.Constant(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Inheritance

Inheritance diagram of Constant

Parameters:
__init__(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Initializes a VHDL model entity.

Parameters:
_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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.

class pyGHDL.dom.Object.DeferredConstant(node, identifiers, subtype, documentation=None)[source]#

Inheritance

Inheritance diagram of DeferredConstant

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • documentation (str) –

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

Initializes a VHDL model entity.

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • 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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.

class pyGHDL.dom.Object.Variable(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Inheritance

Inheritance diagram of Variable

Parameters:
__init__(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Initializes a VHDL model entity.

Parameters:
_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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.

class pyGHDL.dom.Object.SharedVariable(node, identifiers, subtype, documentation=None)[source]#

Inheritance

Inheritance diagram of SharedVariable

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • documentation (str) –

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

Initializes a VHDL model entity.

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • 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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.

class pyGHDL.dom.Object.Signal(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Inheritance

Inheritance diagram of Signal

Parameters:
__init__(node, identifiers, subtype, defaultExpression, documentation=None)[source]#

Initializes a VHDL model entity.

Parameters:
_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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.

class pyGHDL.dom.Object.File(node, identifiers, subtype, documentation=None)[source]#

Inheritance

Inheritance diagram of File

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • documentation (str) –

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

Initializes a VHDL model entity.

Parameters:
  • node (Iir) –

  • identifiers (List[str]) –

  • subtype (Symbol) –

  • 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 Identifiers: Tuple[str]#

Returns a model entity’s tuple of identifiers (names).

Returns:

Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]#

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:

Tuple of normalized identifiers.

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:

Parent entity.

_identifiers: Tuple[str]#

A list of identifiers.

_normalizedIdentifiers: Tuple[str]#

A list of normalized (lower case) identifiers.

_documentation: Nullable[str]#

The associated documentation of a model entity.