pyVHDLModel.IEEE

This module contains library and package declarations for VHDL library IEEE.

Classes

• Ieee: Predefined VHDL library ieee.

• Math_Real: Predefined package ieee.math_real.

• Math_Real_Body: Predefined package body of package ieee.math_real.

• Math_Complex: Predefined package ieee.math_complex.

• Math_Complex_Body: Predefined package body of package ieee.math_complex.

• Std_logic_1164: Predefined package ieee.std_logic_1164.

• Std_logic_1164_Body: Predefined package body of package ieee.std_logic_1164.

• std_logic_textio: Predefined package ieee.std_logic_textio.

• Std_logic_misc: Predefined package ieee.std_logic_misc.

• Std_logic_misc_Body: Predefined package body of package ieee.std_logic_misc.

• Numeric_Bit: Predefined package ieee.numeric_bit.

• Numeric_Bit_Body: Predefined package body of package ieee.numeric_bit.

• Numeric_Bit_Unsigned: Predefined package ieee.numeric_bit_unsigned.

• Numeric_Bit_Unsigned_Body: Predefined package body of package ieee.numeric_bit_unsigned.

• Numeric_Std: Predefined package ieee.numeric_std.

• Numeric_Std_Body: Predefined package body of package ieee.numeric_std.

• Numeric_Std_Unsigned: Predefined package ieee.numeric_std_unsigned.

• Numeric_Std_Unsigned_Body: Predefined package body of package ieee.numeric_std_unsigned.

• Fixed_Float_Types: Predefined package ieee.fixed_float_types.

• Fixed_Generic_Pkg: Predefined package ieee.fixed_generic_pkg.

• Fixed_Generic_Pkg_Body: Predefined package body of package ieee.fixed_generic_pkg.

• Fixed_Pkg: Predefined package ieee.fixed_pkg.

• Float_Generic_Pkg: Predefined package ieee.float_generic_pkg.

• Float_Generic_Pkg_Body: Predefined package body of package ieee.float_generic_pkg.

• Float_Pkg: Predefined package ieee.float_pkg.

---

Classes

class pyVHDLModel.IEEE.Ieee

Predefined VHDL library ieee.

The following predefined packages are in this library:

• Math

  • Math_Real

  • Math_Complex

• Std_logic

  • Std_Logic_1164

  • Std_Logic_TextIO

  • Std_Logic_Misc

• Numeric

  • Numeric_Bit

  • Numeric_Bit_Unsigned

  • Numeric_Std

  • Numeric_Std_Unsigned

• Fixed/floating point

  • Fixed_Float_Types

  • Fixed_Generic_Pkg

  • Fixed_Pkg

  • Float_Generic_Pkg

  • Float_Pkg

See also

Other predefined libraries:

• Library Std

Inheritance

__init__()

Initializes a VHDL model entity.

Parameters:

parent – The parent model entity of this entity.

Return type:

None

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

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

property Configurations: Dict[str, Configuration]

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

property Contexts: Dict[str, Context]

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

property DependencyVertex: Vertex

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

The dependency vertex references this library by its value field.

Returns:

The corresponding dependency vertex.

property Entities: Dict[str, Entity]

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

property Identifier: str

Returns a model entity’s identifier (name).

Returns:

Name of a model entity.

IndexArchitectures()

Index declared items in all architectures.

Return type:

None

Algorithm

1. Iterate all architectures:

   • Index all declared items.
     → pyVHDLModel.DesignUnit.Architecture.IndexDeclaredItems()

See also

IndexPackages()

Index all declared items in a package.

IndexPackageBodies()

Index all declared items in a package body.

IndexEntities()

Index all declared items in an entity.

IndexEntities()

Index declared items in all entities.

Return type:

None

Algorithm

1. Iterate all entities:

   • Index all declared items.
     → pyVHDLModel.DesignUnit.Entity.IndexDeclaredItems()

See also

IndexPackages()

Index all declared items in a package.

IndexPackageBodies()

Index all declared items in a package body.

IndexArchitectures()

Index all declared items in an architecture.

IndexPackageBodies()

Index declared items in all package bodies.

Return type:

None

Algorithm

1. Iterate all package bodies:

   • Index all declared items.
     → pyVHDLModel.DesignUnit.PackageBody.IndexDeclaredItems()

See also

IndexPackages()

Index all declared items in a package.

IndexEntities()

Index all declared items in an entity.

IndexArchitectures()

Index all declared items in an architecture.

IndexPackages()

Index declared items in all packages.

Return type:

None

Algorithm

1. Iterate all packages:

   • Index all declared items.
     → pyVHDLModel.DesignUnit.Package.IndexDeclaredItems()

See also

IndexPackageBodies()

Index all declared items in a package body.

IndexEntities()

Index all declared items in an entity.

IndexArchitectures()

Index all declared items in an architecture.

IterateDesignUnits(filter=<DesignUnitKind.All: 63>)

Iterate all design units in the library.

A union of DesignUnitKind values can be given to filter the returned result for suitable design units.

Algorithm

1. Iterate all contexts in that library.

2. Iterate all packages in that library.

3. Iterate all package bodies in that library.

4. Iterate all entites in that library.

5. Iterate all architectures in that library.

6. Iterate all configurations in that library.

Parameters:

filter (DesignUnitKind) – An enumeration with possibly multiple flags to filter the returned design units.

Return type:

Generator[DesignUnit, None, None]

Returns:

A generator to iterate all matched design units in the library.

See also

pyVHDLModel.Design.IterateDesignUnits()

Iterate all design units in the design.

pyVHDLModel.Document.IterateDesignUnits()

Iterate all design units in the document.

LinkArchitectures()

Link all architectures to corresponding entities.

Return type:

None

Algorithm

1. Iterate all architecture groups (grouped per entity symbol’s name).

   • Check if entity symbol’s name exists as an entity in this library.

   1. For each architecture in the same architecture group:

      • Add architecture to entities architecture dictionary pyVHDLModel.DesignUnit.Entity._architectures.

      • Assign found entity to architecture’s entity symbol pyVHDLModel.DesignUnit.Architecture._entity

      • Set parent namespace of architecture’s namespace to the entitie’s namespace.

      • Add an edge in the dependency graph from the architecture’s corresponding dependency vertex to the entity’s corresponding dependency vertex.

Raises:

• VHDLModelException – If entity name doesn’t exist.

• VHDLModelException – If architecture name already exists for entity.

Return type:

None

See also

LinkPackageBodies()

Link all package bodies to corresponding packages.

LinkPackageBodies()

Link all package bodies to corresponding packages.

Return type:

None

Algorithm

1. Iterate all package bodies.

   • Check if package body symbol’s name exists as a package in this library.

   • Add package body to package pyVHDLModel.DesignUnit.Package._packageBody.

   • Assign found package to package body’s package symbol pyVHDLModel.DesignUnit.PackageBody._package

   • Set parent namespace of package body’s namespace to the package’s namespace.

   • Add an edge in the dependency graph from the package body’s corresponding dependency vertex to the package’s corresponding dependency vertex.

Raises:

VHDLModelException – If package name doesn’t exist.

Return type:

None

See also

LinkArchitectures()

Link all architectures to corresponding entities.

property NormalizedIdentifier: str

Returns a model entity’s normalized identifier (lower case name).

Returns:

Normalized name of a model entity.

property PackageBodies: Dict[str, PackageBody]

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

property Packages: Dict[str, Package]

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

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.

__repr__()

Formats a representation of the library.

Format: Library: 'my_library'

Return type:

str

Returns:

String representation of the library.

__str__()

Formats a representation of the library.

Format: Library: 'my_library'

Return type:

str

Returns:

String representation of the library.

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

Dictionary of all architectures defined in a library.

_configurations: Dict[str, Configuration]

Dictionary of all configurations defined in a library.

_contexts: Dict[str, Context]

Dictionary of all contexts defined in a library.

_dependencyVertex: Vertex[None, None, str, Union['Library', DesignUnit], None, None, None, None, None, None, None, None, None, None, None, None, None]

Reference to the vertex in the dependency graph representing the library.
This reference is set by CreateDependencyGraph().

_entities: Dict[str, Entity]

Dictionary of all entities defined in a library.

_identifier: str

The identifier of a model entity.

_normalizedIdentifier: str

The normalized (lower case) identifier of a model entity.

_packageBodies: Dict[str, PackageBody]

Dictionary of all package bodies defined in a library.

_packages: Dict[str, Package]

Dictionary of all packages defined in a library.

_parent: ModelEntity

Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.IEEE.Math_Real

Predefined package ieee.math_real.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Real_Body

Predefined package body of package ieee.math_real.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Complex

Predefined package ieee.math_complex.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Complex_Body

Predefined package body of package ieee.math_complex.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_logic_1164

Predefined package ieee.std_logic_1164.

Predefined types:

• std_ulogic, std_ulogic_vector

• std_logic, std_logic_vector

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_logic_1164_Body

Predefined package body of package ieee.std_logic_1164.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.std_logic_textio

Predefined package ieee.std_logic_textio.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_logic_misc

Predefined package ieee.std_logic_misc.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_logic_misc_Body

Predefined package body of package ieee.std_logic_misc.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit

Predefined package ieee.numeric_bit.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Body

Predefined package body of package ieee.numeric_bit.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Unsigned

Predefined package ieee.numeric_bit_unsigned.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Unsigned_Body

Predefined package body of package ieee.numeric_bit_unsigned.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std

Predefined package ieee.numeric_std.

Predefined types:

• unresolved_unsigned, unsigned

• unresolved_signed, signed

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Body

Predefined package body of package ieee.numeric_std.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Unsigned

Predefined package ieee.numeric_std_unsigned.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Unsigned_Body

Predefined package body of package ieee.numeric_std_unsigned.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Float_Types

Predefined package ieee.fixed_float_types.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Generic_Pkg

Predefined package ieee.fixed_generic_pkg.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Generic_Pkg_Body

Predefined package body of package ieee.fixed_generic_pkg.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Pkg

Predefined package ieee.fixed_pkg.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Generic_Pkg

Predefined package ieee.float_generic_pkg.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Generic_Pkg_Body

Predefined package body of package ieee.float_generic_pkg.

Inheritance

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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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__()

Initializes a design unit.

Parameters:

• identifier – 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

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Pkg

Predefined package ieee.float_pkg.

Inheritance

__init__()

Initializes a design unit.

Parameters:

• identifier – 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.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:

None

Algorithm

1. Iterate all declared items:

   • Every declared item is added to _namespace.

   • If the declared item is a FullType, then add an entry to _types.

   • If the declared item is a SubType, then add an entry to _subtypes.

   • If the declared item is a Function, then add an entry to _functions.

   • If the declared item is a Procedure, then add an entry to _procedures.

   • If the declared item is a Constant, then add an entry to _constants.

   • If the declared item is a Signal, then add an entry to _signals.

   • If the declared item is a Variable, TODO.

   • If the declared item is a SharedVariable, then add an entry to _sharedVariables.

   • If the declared item is a File, then add an entry to _files.

   • If the declared item is neither of these types, call _IndexOtherDeclaredItem().
     Derived classes may override this virtual function.

See also

pyVHDLModel.Design.IndexPackages()

Iterate all packages in the design and index declared items.

pyVHDLModel.Library.IndexPackages()

Iterate all packages in the library and index declared items.

pyVHDLModel.Library._IndexOtherDeclaredItem()

Iterate all packages in the library and index declared items.

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.

__repr__()

Return repr(self).

Return type:

str

__str__()

Return str(self).

Return type:

str

_constants: Dict[str, Constant]

Dictionary of all constants declared in this concurrent declaration region.

_contextItems: List['ContextUnion']

List of all context items (library, use and context clauses).

_contextReferences: List['ContextReference']

List of context clauses.

_declaredItems: List

List of all declared items in this concurrent declaration region.

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

_files: Dict[str, File]

Dictionary of all files declared in this concurrent declaration region.

_functions: Dict[str, Dict[str, Function]]

Dictionary of all functions declared in this concurrent declaration region.

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

_procedures: Dict[str, Dict[str, Procedure]]

Dictionary of all procedures declared in this concurrent declaration region.

_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

_sharedVariables: Dict[str, SharedVariable]

Dictionary of all shared variables declared in this concurrent declaration region.

_signals: Dict[str, Signal]

Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dict[str, Subtype]

Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dict[str, FullType]

Dictionary of all types declared in this concurrent declaration region.