pyVHDLModel.PSLModel

This module contains an abstract document language model for PSL in VHDL.

Classes

PSLEntity: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
PSLPrimaryUnit: A base-class for all primary design units.
VerificationUnit: A base-class for all primary design units.
VerificationProperty: A base-class for all primary design units.
VerificationMode: A base-class for all primary design units.
DefaultClock: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple

Classes

class pyVHDLModel.PSLModel.PSLEntity(parent=None)[source]

Inheritance

Parameters:: parent (ModelEntity | None)

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

__init__(parent=None)

Initializes a VHDL model entity.

Parameters:: parent (Optional[ModelEntity]) – The parent model entity of this entity.
Return type:: None

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.PSLModel.PSLPrimaryUnit(identifier, contextItems=None, documentation=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
contextItems (Iterable[LibraryClause | UseClause | ContextReference] | None)
documentation (str | None)
parent (ModelEntity)

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 DependencyVertex: Vertex

Read-only property to access the corresponding dependency vertex (_dependencyVertex).

The dependency vertex references this design unit by its value field.

Returns:: The corresponding dependency vertex.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property HierarchyVertex: Vertex

Read-only property to access the corresponding hierarchy vertex (_hierarchyVertex).

The hierarchy vertex references this design unit by its value field.

Returns:: The corresponding hierarchy vertex.

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

__init__(identifier, contextItems=None, documentation=None, parent=None)

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.
parent (ModelEntity) – Reference to the logical parent in the model hierarchy.

Return type:

None

_contextItems: List['ContextUnion']: List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']: List of context clauses.

_dependencyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

_document: Document: The VHDL library, the design unit was analyzed into.

_documentation: Nullable[str]: The associated documentation of a model entity.

_hierarchyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: The vertex in the hierarchy graph

_identifier: str: The identifier of a model entity.

_libraryReferences: List['LibraryClause']: List of library clauses.

_normalizedIdentifier: str: The normalized (lower case) identifier of a model entity.

_packageReferences: List['UseClause']: List of use clauses.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

_referencedContexts: Dict[str, 'Context']: Referenced contexts based on explicit context references or implicit inheritance

_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

class pyVHDLModel.PSLModel.VerificationUnit(identifier)[source]

Inheritance

Parameters:: identifier (str)

__init__(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.
parent – Reference to the logical parent in the model hierarchy.

Return type:

None

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 DependencyVertex: Vertex

Read-only property to access the corresponding dependency vertex (_dependencyVertex).

The dependency vertex references this design unit by its value field.

Returns:: The corresponding dependency vertex.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property HierarchyVertex: Vertex

Read-only property to access the corresponding hierarchy vertex (_hierarchyVertex).

The hierarchy vertex references this design unit by its value field.

Returns:: The corresponding hierarchy vertex.

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

_contextItems: List['ContextUnion']: List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']: List of context clauses.

_dependencyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

_document: Document: The VHDL library, the design unit was analyzed into.

_documentation: Nullable[str]: The associated documentation of a model entity.

_hierarchyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: The vertex in the hierarchy graph

_identifier: str: The identifier of a model entity.

_libraryReferences: List['LibraryClause']: List of library clauses.

_normalizedIdentifier: str: The normalized (lower case) identifier of a model entity.

_packageReferences: List['UseClause']: List of use clauses.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

_referencedContexts: Dict[str, 'Context']: Referenced contexts based on explicit context references or implicit inheritance

_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

class pyVHDLModel.PSLModel.VerificationProperty(identifier)[source]

Inheritance

Parameters:: identifier (str)

__init__(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.
parent – Reference to the logical parent in the model hierarchy.

Return type:

None

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 DependencyVertex: Vertex

Read-only property to access the corresponding dependency vertex (_dependencyVertex).

The dependency vertex references this design unit by its value field.

Returns:: The corresponding dependency vertex.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property HierarchyVertex: Vertex

Read-only property to access the corresponding hierarchy vertex (_hierarchyVertex).

The hierarchy vertex references this design unit by its value field.

Returns:: The corresponding hierarchy vertex.

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

_contextItems: List['ContextUnion']: List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']: List of context clauses.

_dependencyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

_document: Document: The VHDL library, the design unit was analyzed into.

_documentation: Nullable[str]: The associated documentation of a model entity.

_hierarchyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: The vertex in the hierarchy graph

_identifier: str: The identifier of a model entity.

_libraryReferences: List['LibraryClause']: List of library clauses.

_normalizedIdentifier: str: The normalized (lower case) identifier of a model entity.

_packageReferences: List['UseClause']: List of use clauses.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

_referencedContexts: Dict[str, 'Context']: Referenced contexts based on explicit context references or implicit inheritance

_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

class pyVHDLModel.PSLModel.VerificationMode(identifier)[source]

Inheritance

Parameters:: identifier (str)

__init__(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.
parent – Reference to the logical parent in the model hierarchy.

Return type:

None

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 DependencyVertex: Vertex

Read-only property to access the corresponding dependency vertex (_dependencyVertex).

The dependency vertex references this design unit by its value field.

Returns:: The corresponding dependency vertex.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property HierarchyVertex: Vertex

Read-only property to access the corresponding hierarchy vertex (_hierarchyVertex).

The hierarchy vertex references this design unit by its value field.

Returns:: The corresponding hierarchy vertex.

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

_contextItems: List['ContextUnion']: List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']: List of context clauses.

_dependencyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

_document: Document: The VHDL library, the design unit was analyzed into.

_documentation: Nullable[str]: The associated documentation of a model entity.

_hierarchyVertex: Vertex[None, None, str, 'DesignUnit', None, None, None, None, None, None, None, None, None, None, None, None, None]: The vertex in the hierarchy graph

_identifier: str: The identifier of a model entity.

_libraryReferences: List['LibraryClause']: List of library clauses.

_normalizedIdentifier: str: The normalized (lower case) identifier of a model entity.

_packageReferences: List['UseClause']: List of use clauses.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

_referencedContexts: Dict[str, 'Context']: Referenced contexts based on explicit context references or implicit inheritance

_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

class pyVHDLModel.PSLModel.DefaultClock(identifier)[source]

Inheritance

Parameters:: identifier (str)

__init__(identifier)[source]

Initializes a VHDL model entity.

Parameters:

parent – The parent model entity of this entity.
identifier (str)

Return type:

None

_identifier: str: The identifier of a model entity.

_normalizedIdentifier: str: The normalized (lower case) identifier 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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.