pyGHDL.dom.DesignUnit

This module contains all DOM classes for VHDL’s design units (context, architecture, package, package body, context and configuration.

Classes

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

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

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

• Entity: A PrimaryUnit is a base-class for all primary units.

• Architecture: A SecondaryUnit is a base-class for all secondary units.

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

• Package: A PrimaryUnit is a base-class for all primary units.

• PackageBody: A SecondaryUnit is a base-class for all secondary units.

• PackageInstantiation: A PrimaryUnit is a base-class for all primary units.

• Context: A PrimaryUnit is a base-class for all primary units.

• Configuration: A PrimaryUnit is a base-class for all primary units.

---

Classes

class pyGHDL.dom.DesignUnit.LibraryClause(libraryNode, symbols)

Inheritance

Parameters:

• libraryNode (Iir) –

• symbols (Iterable[Name]) –

__init__(libraryNode, symbols)

Initializes a VHDL model entity.

Parameters:

• libraryNode (Iir) –

• symbols (Iterable[Name]) –

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyGHDL.dom.DesignUnit.UseClause(useNode, symbols)

Inheritance

Parameters:

• useNode (Iir) –

• symbols (Iterable[Name]) –

__init__(useNode, symbols)

Initializes a VHDL model entity.

Parameters:

• useNode (Iir) –

• symbols (Iterable[Name]) –

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyGHDL.dom.DesignUnit.ContextReference(contextNode, symbols)

Inheritance

Parameters:

• contextNode (Iir) –

• symbols (Iterable[Name]) –

__init__(contextNode, symbols)

Initializes a VHDL model entity.

Parameters:

• contextNode (Iir) –

• symbols (Iterable[Name]) –

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyGHDL.dom.DesignUnit.Entity(node, identifier, contextItems=None, genericItems=None, portItems=None, declaredItems=None, statements=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• contextItems (Iterable[Union[LibraryClause, UseClause, ContextReference]]) –

• genericItems (Iterable[GenericInterfaceItem]) –

• portItems (Iterable[PortInterfaceItem]) –

• declaredItems (Iterable) –

• statements (Iterable[ConcurrentStatement]) –

• documentation (str) –

__init__(node, identifier, contextItems=None, genericItems=None, portItems=None, declaredItems=None, statements=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• contextItems (Optional[Iterable[Union[LibraryClause, UseClause, ContextReference]]]) –

• genericItems (Optional[Iterable[GenericInterfaceItem]]) –

• portItems (Optional[Iterable[PortInterfaceItem]]) –

• declaredItems (Optional[Iterable]) –

• statements (Optional[Iterable[ConcurrentStatement]]) –

property ContextItems: List[Union[LibraryClause, UseClause, ContextReference]]

Read-only property to access the sequence of all context items comprising library, use and context clauses (_contextItems).

Return type:

List[Union[LibraryClause, UseClause, ContextReference]]

Returns:

Sequence of context items.

property ContextReferences: List[ContextReference]

Read-only property to access the sequence of context clauses (_contextReferences).

Return type:

List[ContextReference]

Returns:

Sequence of context clauses.

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Return type:

List[LibraryClause]

Returns:

Sequence of library clauses.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Return type:

List[UseClause]

Returns:

Sequence of use clauses.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_libraryReferences: List['LibraryClause']

List of library clauses.

_packageReferences: List['UseClause']

List of use clauses.

_contextReferences: List['ContextReference']

List of context clauses.

class pyGHDL.dom.DesignUnit.Architecture(node, identifier, entity, contextItems=None, declaredItems=None, statements=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• entity (Union[Entity, EntitySymbol]) –

• contextItems (Iterable[Union[LibraryClause, UseClause, ContextReference]]) –

• declaredItems (Iterable) –

• statements (Iterable[ConcurrentStatement]) –

• documentation (str) –

__init__(node, identifier, entity, contextItems=None, declaredItems=None, statements=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• entity (Union[Entity, EntitySymbol]) –

• contextItems (Optional[Iterable[Union[LibraryClause, UseClause, ContextReference]]]) –

• declaredItems (Optional[Iterable]) –

• statements (Optional[Iterable[ConcurrentStatement]]) –

property ContextItems: List[Union[LibraryClause, UseClause, ContextReference]]

Read-only property to access the sequence of all context items comprising library, use and context clauses (_contextItems).

Return type:

List[Union[LibraryClause, UseClause, ContextReference]]

Returns:

Sequence of context items.

property ContextReferences: List[ContextReference]

Read-only property to access the sequence of context clauses (_contextReferences).

Return type:

List[ContextReference]

Returns:

Sequence of context clauses.

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Return type:

List[LibraryClause]

Returns:

Sequence of library clauses.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Return type:

List[UseClause]

Returns:

Sequence of use clauses.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_libraryReferences: List['LibraryClause']

List of library clauses.

_packageReferences: List['UseClause']

List of use clauses.

_contextReferences: List['ContextReference']

List of context clauses.

class pyGHDL.dom.DesignUnit.Component(node, identifier, genericItems=None, portItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• genericItems (Iterable[GenericInterfaceItem]) –

• portItems (Iterable[PortInterfaceItem]) –

• documentation (str) –

__init__(node, identifier, genericItems=None, portItems=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifier (str) –

• genericItems (Optional[Iterable[GenericInterfaceItem]]) –

• portItems (Optional[Iterable[PortInterfaceItem]]) –

• documentation (Optional[str]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.DesignUnit.Package(node, identifier, contextItems=None, genericItems=None, declaredItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• contextItems (Iterable[Union[LibraryClause, UseClause, ContextReference]]) –

• genericItems (Iterable[GenericInterfaceItem]) –

• declaredItems (Iterable) –

• documentation (str) –

__init__(node, identifier, contextItems=None, genericItems=None, declaredItems=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• contextItems (Optional[Iterable[Union[LibraryClause, UseClause, ContextReference]]]) –

• genericItems (Optional[Iterable[GenericInterfaceItem]]) –

• declaredItems (Optional[Iterable]) –

property ContextItems: List[Union[LibraryClause, UseClause, ContextReference]]

Read-only property to access the sequence of all context items comprising library, use and context clauses (_contextItems).

Return type:

List[Union[LibraryClause, UseClause, ContextReference]]

Returns:

Sequence of context items.

property ContextReferences: List[ContextReference]

Read-only property to access the sequence of context clauses (_contextReferences).

Return type:

List[ContextReference]

Returns:

Sequence of context clauses.

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Return type:

List[LibraryClause]

Returns:

Sequence of library clauses.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Return type:

List[UseClause]

Returns:

Sequence of use clauses.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_libraryReferences: List['LibraryClause']

List of library clauses.

_packageReferences: List['UseClause']

List of use clauses.

_contextReferences: List['ContextReference']

List of context clauses.

class pyGHDL.dom.DesignUnit.PackageBody(node, identifier, contextItems=None, declaredItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• contextItems (Iterable[Union[LibraryClause, UseClause, ContextReference]]) –

• declaredItems (Iterable) –

• documentation (str) –

__init__(node, identifier, contextItems=None, declaredItems=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• contextItems (Optional[Iterable[Union[LibraryClause, UseClause, ContextReference]]]) –

• declaredItems (Optional[Iterable]) –

property ContextItems: List[Union[LibraryClause, UseClause, ContextReference]]

Read-only property to access the sequence of all context items comprising library, use and context clauses (_contextItems).

Return type:

List[Union[LibraryClause, UseClause, ContextReference]]

Returns:

Sequence of context items.

property ContextReferences: List[ContextReference]

Read-only property to access the sequence of context clauses (_contextReferences).

Return type:

List[ContextReference]

Returns:

Sequence of context clauses.

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Return type:

List[LibraryClause]

Returns:

Sequence of library clauses.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Return type:

List[UseClause]

Returns:

Sequence of use clauses.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_libraryReferences: List['LibraryClause']

List of library clauses.

_packageReferences: List['UseClause']

List of use clauses.

_contextReferences: List['ContextReference']

List of context clauses.

class pyGHDL.dom.DesignUnit.PackageInstantiation(node, identifier, uninstantiatedPackageName, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• uninstantiatedPackageName (Name) –

• documentation (str) –

__init__(node, identifier, uninstantiatedPackageName, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• uninstantiatedPackageName (Name) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.DesignUnit.Context(node, identifier, libraryReferences=None, packageReferences=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• libraryReferences (Iterable[LibraryClause]) –

• packageReferences (Iterable[UseClause]) –

• documentation (str) –

__init__(node, identifier, libraryReferences=None, packageReferences=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• libraryReferences (Optional[Iterable[LibraryClause]]) –

• packageReferences (Optional[Iterable[UseClause]]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.DesignUnit.Configuration(node, identifier, contextItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• contextItems (Iterable[Context]) –

• documentation (str) –

__init__(node, identifier, contextItems=None, documentation=None)

Initializes a design unit.

Parameters:

• identifier (str) – Identifier (name) of the design unit.

• documentation (Optional[str]) – Associated documentation of the design unit.

• node (Iir) –

• contextItems (Optional[Iterable[Context]]) –

property ContextItems: List[Union[LibraryClause, UseClause, ContextReference]]

Read-only property to access the sequence of all context items comprising library, use and context clauses (_contextItems).

Return type:

List[Union[LibraryClause, UseClause, ContextReference]]

Returns:

Sequence of context items.

property ContextReferences: List[ContextReference]

Read-only property to access the sequence of context clauses (_contextReferences).

Return type:

List[ContextReference]

Returns:

Sequence of context clauses.

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Return type:

List[LibraryClause]

Returns:

Sequence of library clauses.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Return type:

List[UseClause]

Returns:

Sequence of use clauses.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_libraryReferences: List['LibraryClause']

List of library clauses.

_packageReferences: List['UseClause']

List of use clauses.

_contextReferences: List['ContextReference']

List of context clauses.