pyGHDL.dom.DesignUnit#
This module contains all DOM classes for VHDL’s design units (context,
architecture, package,
package body, context and
configuration.
Classes
LibraryClause:ModelEntityis the base-class for all classes in the VHDL language model, except for mixin classes (see multipleUseClause:ModelEntityis the base-class for all classes in the VHDL language model, except for mixin classes (see multipleContextReference:ModelEntityis the base-class for all classes in the VHDL language model, except for mixin classes (see multipleEntity: APrimaryUnitis a base-class for all primary units.Architecture: ASecondaryUnitis a base-class for all secondary units.Component:ModelEntityis the base-class for all classes in the VHDL language model, except for mixin classes (see multiplePackage: APrimaryUnitis a base-class for all primary units.PackageBody: ASecondaryUnitis a base-class for all secondary units.PackageInstantiation: APrimaryUnitis a base-class for all primary units.Context: APrimaryUnitis a base-class for all primary units.Configuration: APrimaryUnitis a base-class for all primary units.
Classes
- class pyGHDL.dom.DesignUnit.LibraryClause(libraryNode, symbols)[source]#
 Inheritance
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- class pyGHDL.dom.DesignUnit.UseClause(useNode, symbols)[source]#
 Inheritance
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- class pyGHDL.dom.DesignUnit.ContextReference(contextNode, symbols)[source]#
 Inheritance
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- class pyGHDL.dom.DesignUnit.Entity(node, identifier, contextItems=None, genericItems=None, portItems=None, declaredItems=None, statements=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
identifier (str) –
contextItems (Iterable[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)[source]#
 Initializes a design unit.
- Parameters:
 identifier (
str) – Identifier (name) of the design unit.contextItems (
Optional[Iterable[Union[LibraryClause,UseClause,ContextReference]]]) – A sequence of library, use or context clauses.documentation (
Optional[str]) – Associated documentation of the design unit.node (Iir) –
genericItems (Iterable[GenericInterfaceItem] | None) –
portItems (Iterable[PortInterfaceItem] | None) –
declaredItems (Iterable | None) –
statements (Iterable[ConcurrentStatement] | None) –
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- _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.
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.Architecture(node, identifier, entity, contextItems=None, declaredItems=None, statements=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
identifier (str) –
entity (EntitySymbol) –
contextItems (Iterable[LibraryClause | UseClause | ContextReference]) –
declaredItems (Iterable) –
statements (Iterable[ConcurrentStatement]) –
documentation (str) –
- __init__(node, identifier, entity, contextItems=None, declaredItems=None, statements=None, documentation=None)[source]#
 Initializes a design unit.
- Parameters:
 identifier (
str) – Identifier (name) of the design unit.contextItems (
Optional[Iterable[Union[LibraryClause,UseClause,ContextReference]]]) – A sequence of library, use or context clauses.documentation (
Optional[str]) – Associated documentation of the design unit.node (Iir) –
entity (EntitySymbol) –
declaredItems (Iterable | None) –
statements (Iterable[ConcurrentStatement] | None) –
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library = None#
 The VHDL library, the design unit was analyzed into.
- _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.
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.Component(node, identifier, genericItems=None, portItems=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
identifier (str) –
genericItems (Iterable[GenericInterfaceItem]) –
portItems (Iterable[PortInterfaceItem]) –
documentation (str) –
- __init__(node, identifier, genericItems=None, portItems=None, documentation=None)[source]#
 Initializes a VHDL model entity.
- Parameters:
 node (Iir) –
identifier (str) –
genericItems (Iterable[GenericInterfaceItem] | None) –
portItems (Iterable[PortInterfaceItem] | None) –
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.
- class pyGHDL.dom.DesignUnit.Package(node, identifier, contextItems=None, genericItems=None, declaredItems=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
identifier (str) –
contextItems (Iterable[LibraryClause | UseClause | ContextReference]) –
genericItems (Iterable[GenericInterfaceItem]) –
declaredItems (Iterable) –
documentation (str) –
- __init__(node, identifier, contextItems=None, genericItems=None, declaredItems=None, documentation=None)[source]#
 Initializes a design unit.
- Parameters:
 identifier (
str) – Identifier (name) of the design unit.contextItems (
Optional[Iterable[Union[LibraryClause,UseClause,ContextReference]]]) – A sequence of library, use or context clauses.documentation (
Optional[str]) – Associated documentation of the design unit.node (Iir) –
genericItems (Iterable[GenericInterfaceItem] | None) –
declaredItems (Iterable | None) –
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- _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.
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.PackageBody(node, packageSymbol, contextItems=None, declaredItems=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
packageSymbol (PackageSymbol) –
contextItems (Iterable[LibraryClause | UseClause | ContextReference]) –
declaredItems (Iterable) –
documentation (str) –
- __init__(node, packageSymbol, contextItems=None, declaredItems=None, documentation=None)[source]#
 Initializes a design unit.
- Parameters:
 identifier – Identifier (name) of the design unit.
contextItems (
Optional[Iterable[Union[LibraryClause,UseClause,ContextReference]]]) – A sequence of library, use or context clauses.documentation (
Optional[str]) – Associated documentation of the design unit.node (Iir) –
packageSymbol (PackageSymbol) –
declaredItems (Iterable | None) –
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- _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.
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.PackageInstantiation(node, identifier, uninstantiatedPackageName, documentation=None)[source]#
 Inheritance
- Parameters:
 
- __init__(node, identifier, uninstantiatedPackageName, documentation=None)[source]#
 Initializes a design unit.
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- _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.
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.Context(node, identifier, references=None, documentation=None)[source]#
 Inheritance
- Parameters:
 node (Iir) –
identifier (str) –
references (Iterable[LibraryClause | UseClause | ContextReference]) –
documentation (str) –
- __init__(node, identifier, references=None, documentation=None)[source]#
 Initializes a design unit.
- Parameters:
 identifier (
str) – Identifier (name) of the design unit.contextItems – A sequence of library, use or context clauses.
documentation (
Optional[str]) – Associated documentation of the design unit.node (Iir) –
references (Iterable[LibraryClause | UseClause | ContextReference] | None) –
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- 
_libraryReferences: 
List[LibraryClause]# List of library clauses.
- 
_contextReferences: 
List[ContextReference]# List of context clauses.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- _contextItems: List['ContextUnion']#
 List of all context items (library, use and context clauses).
- _referencedLibraries: Dict[str, 'Library']#
 Referenced libraries based on explicit library clauses or implicit inheritance
- _referencedPackages: Dict[str, Dict[str, 'Package']]#
 Referenced packages based on explicit use clauses or implicit inheritance
- _referencedContexts: Dict[str, 'Context']#
 Referenced contexts based on explicit context references or implicit inheritance
- _dependencyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the dependency graph
- _hierarchyVertex: Vertex[str, 'DesignUnit', None, None]#
 The vertex in the hierarchy graph
- _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.
- class pyGHDL.dom.DesignUnit.Configuration(node, identifier, contextItems=None, documentation=None)[source]#
 Inheritance
- Parameters:
 
- __init__(node, identifier, contextItems=None, documentation=None)[source]#
 Initializes a design unit.
- _parent: ModelEntity#
 Reference to a parent entity in the model.
- property ContextItems: List[LibraryClause | UseClause | ContextReference]#
 Read-only property to access the sequence of all context items comprising library, use and context clauses (
_contextItems).- Returns:
 Sequence of context items.
- property ContextReferences: List[ContextReference]#
 Read-only property to access the sequence of context clauses (
_contextReferences).- Returns:
 Sequence of context clauses.
- 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 LibraryReferences: List[LibraryClause]#
 Read-only property to access the sequence of library clauses (
_libraryReferences).- Returns:
 Sequence of library clauses.
- property NormalizedIdentifier: str#
 Returns a model entity’s normalized identifier (lower case name).
- Returns:
 Normalized name of a model entity.
- property PackageReferences: List[UseClause]#
 Read-only property to access the sequence of use clauses (
_packageReferences).- Returns:
 Sequence of use clauses.
- property Parent: ModelEntity#
 Returns a reference to the parent entity.
- Returns:
 Parent entity.
- _library: Library#
 The VHDL library, the design unit was analyzed into.
- 
_referencedLibraries: 
Dict[str, Library]# Referenced libraries based on explicit library clauses or implicit inheritance
- 
_referencedPackages: 
Dict[str,Dict[str, Package]]# Referenced packages based on explicit use clauses or implicit inheritance
- 
_referencedContexts: 
Dict[str, Context]# Referenced contexts based on explicit context references or implicit inheritance
- _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.