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.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

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.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.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

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.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.

  • documentation – Associated documentation of the design unit.

  • node (Iir) –

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.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) –

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.