pyGHDL.dom.PSL#

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

Classes

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

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

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

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

Classes

class pyGHDL.dom.PSL.VerificationUnit(node, identifier)[source]#

Inheritance

Inheritance diagram of VerificationUnit

Parameters:

  • node (Iir) –

  • identifier (str) –

__init__(node, identifier)[source]#

Initializes a design unit.

Parameters:

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

  • contextItems – A sequence of library, use or context clauses.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

_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.PSL.VerificationProperty(node, identifier)[source]#

Inheritance

Inheritance diagram of VerificationProperty

Parameters:

  • node (Iir) –

  • identifier (str) –

__init__(node, identifier)[source]#

Initializes a design unit.

Parameters:

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

  • contextItems – A sequence of library, use or context clauses.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

_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.PSL.VerificationMode(node, identifier)[source]#

Inheritance

Inheritance diagram of VerificationMode

Parameters:

  • node (Iir) –

  • identifier (str) –

__init__(node, identifier)[source]#

Initializes a design unit.

Parameters:

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

  • contextItems – A sequence of library, use or context clauses.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

_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.PSL.DefaultClock(node, identifier)[source]#

Inheritance

Inheritance diagram of DefaultClock

Parameters:

  • node (Iir) –

  • identifier (str) –

__init__(node, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

  • node (Iir) –

  • identifier (str) –

_parent: ModelEntity#

Reference to a parent entity in the model.

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.