pyGHDL.dom.NonStandard

Todo

Add a module documentation.

Classes

• Design: A Design represents all loaded files (see Document)

• Library: A Library represents a VHDL library. It contains all primary design units.

• Document: A Document represents a sourcefile. It contains primary and secondary design units.

---

Classes

class pyGHDL.dom.NonStandard.Design

Inheritance

__init__()

Initializes a VHDL model entity.

__ghdl_init()

Initialization: set options and then load libraries.

property Documents: List[Document]

Returns a list of all documents (files) loaded for this design.

Return type:

List[Document]

property Libraries: Dict[str, Library]

Returns a list of all libraries specified for this design.

Return type:

Dict[str, Library]

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_libraries: Dict[str, Library]

List of all libraries defined for a design.

_documents: List[Document]

List of all documents loaded for a design.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyGHDL.dom.NonStandard.Library(identifier)

Inheritance

Parameters:

identifier (str) –

property Architectures: Dict[str, Dict[str, Architecture]]

Returns a list of all architectures declarations declared in this library.

Return type:

Dict[str, Dict[str, Architecture]]

property Configurations: Dict[str, Configuration]

Returns a list of all configuration declarations declared in this library.

Return type:

Dict[str, Configuration]

property Contexts: Dict[str, Context]

Returns a list of all context declarations declared in this library.

Return type:

Dict[str, Context]

property Entities: Dict[str, Entity]

Returns a list of all entity declarations declared in this library.

Return type:

Dict[str, Entity]

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property PackageBodies: Dict[str, PackageBody]

Returns a list of all package body declarations declared in this library.

Return type:

Dict[str, PackageBody]

property Packages: Dict[str, Package]

Returns a list of all package declarations declared in this library.

Return type:

Dict[str, Package]

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

__init__(identifier)

Initializes a VHDL model entity.

Parameters:

identifier (str) –

_contexts: Dict[str, Context]

Dictionary of all contexts defined in a library.

_configurations: Dict[str, Configuration]

Dictionary of all configurations defined in a library.

_entities: Dict[str, Entity]

Dictionary of all entities defined in a library.

_architectures: Dict[str, Dict[str, Architecture]]

Dictionary of all architectures defined in a library.

_packages: Dict[str, Package]

Dictionary of all packages defined in a library.

_packageBodies: Dict[str, PackageBody]

Dictionary of all package bodies defined in a library.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

class pyGHDL.dom.NonStandard.Document(path, sourceCode=None, vhdlVersion=VHDLVersion.VHDL2008, dontParse=False, dontTranslate=False)

Inheritance

Parameters:

• path (Path) –

• sourceCode (str) –

• vhdlVersion (VHDLVersion) –

• dontParse (bool) –

• dontTranslate (bool) –

__init__(path, sourceCode=None, vhdlVersion=VHDLVersion.VHDL2008, dontParse=False, dontTranslate=False)

Initializes a VHDL model entity.

Parameters:

• path (Path) –

• sourceCode (Optional[str]) –

• vhdlVersion (VHDLVersion) –

• dontParse (bool) –

• dontTranslate (bool) –

property Architectures: Dict[str, Dict[str, Architecture]]

Returns a list of all architecture declarations found in this document.

Return type:

Dict[str, Dict[str, Architecture]]

property Configurations: Dict[str, Configuration]

Returns a list of all configuration declarations found in this document.

Return type:

Dict[str, Configuration]

property Contexts: Dict[str, Context]

Returns a list of all context declarations found in this document.

Return type:

Dict[str, Context]

property DesignUnits: List[DesignUnit]

Returns a list of all design units declarations found in this document.

Return type:

List[DesignUnit]

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Entities: Dict[str, Entity]

Returns a list of all entity declarations found in this document.

Return type:

Dict[str, Entity]

property PackageBodies: Dict[str, PackageBody]

Returns a list of all package body declarations found in this document.

Return type:

Dict[str, PackageBody]

property Packages: Dict[str, Package]

Returns a list of all package declarations found in this document.

Return type:

Dict[str, Package]

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

property VerificationModes: Dict[str, VerificationMode]

Returns a list of all verification mode declarations found in this document.

Return type:

Dict[str, VerificationMode]

property VerificationProperties: Dict[str, VerificationProperty]

Returns a list of all verification property declarations found in this document.

Return type:

Dict[str, VerificationProperty]

property VerificationUnits: Dict[str, VerificationUnit]

Returns a list of all verification unit declarations found in this document.

Return type:

Dict[str, VerificationUnit]

_path: Path

path to the document. None if virtual document.

_designUnits: List['DesignUnit']

List of all design units defined in a document.

_contexts: Dict[str, 'Context']

Dictionary of all contexts defined in a document.

_configurations: Dict[str, 'Configuration']

Dictionary of all configurations defined in a document.

_entities: Dict[str, 'Entity']

Dictionary of all entities defined in a document.

_architectures: Dict[str, Dict[str, 'Architecture']]

Dictionary of all architectures defined in a document.

_packages: Dict[str, 'Package']

Dictionary of all packages defined in a document.

_packageBodies: Dict[str, 'PackageBody']

Dictionary of all package bodies defined in a document.

_verificationUnits: Dict[str, 'VerificationUnit']

Dictionary of all PSL verification units defined in a document.

_verificationProperties: Dict[str, 'VerificationProperty']

Dictionary of all PSL verification properties defined in a document.

_verificationModes: Dict[str, 'VerificationMode']

Dictionary of all PSL verification modes defined in a document.

_parent: ModelEntity

Reference to a parent entity in the model.

_documentation: Nullable[str]

The associated documentation of a model entity.