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.
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.
Std_Logic_Arith_MentorGraphics: Predefined Mentor Graphics package ieee.std_logic_arith.
Std_Logic_Arith_Body_MentorGraphics: Predefined package body of Mentor Graphics package ieee.std_logic_arith.
VITAL_Timing: Predefined package ieee.VITAL_Timing.
VITAL_Timing_Body: Predefined package body of package ieee.VITAL_Timing.
VITAL_Primitives: Predefined package ieee.VITAL_Primitives.
VITAL_Primitives_Body: Predefined package body of package ieee.VITAL_Primitives.
VITAL_Memory: Predefined package ieee.VITAL_Memory.
VITAL_Memory_Body: Predefined package body of package ieee.VITAL_Memory.
Std_Logic_Arith_Synopsys: Predefined Synopsys package ieee.std_logic_arith.
Std_Logic_Misc: Predefined Synopsys package ieee.std_logic_misc.
Std_Logic_Misc_Body: Predefined package body of Synopsys package ieee.std_logic_misc.
Std_Logic_Signed: Predefined Synopsys package ieee.std_logic_signed.
Std_Logic_TextIO_Synopsys: Predefined Synopsys package ieee.std_logic_textio.
Std_Logic_Unsigned: Predefined Synopsys package ieee.std_logic_unsigned.

Classes

class pyVHDLModel.IEEE.Ieee(flavor=None)[source]

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
Numeric
Fixed/floating point
Synopsys packages
- Std_Logic_Arith
- Std_Logic_Misc
- Std_Logic_Signed
- Std_Logic_TextIO
- Std_Logic_Unsigned
Mentor Graphics packages
- Std_Logic_Arith
VITAL packages

See also

Other predefined libraries:

Library Std

Inheritance

Parameters:: flavor (IEEEFlavor | None)

__init__(flavor=None)[source]

Initializes the ieee library.

Parameters:: flavor (IEEEFlavor | None) – The flavor of the ieee library this instance provides.
Raises:: VHDLModelException – If the given IEEE library flavor is unknown.
Return type:: None

_flavor: IEEEFlavor: The flavor of the ieee library this instance provides.

property Flavor: IEEEFlavor

Read-only property to access the flavor (_flavor).

Returns:: The flavor.

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

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

Read-only property to access the dictionary of all architecture declarations in this library (_architectures).

Returns:: Dictionary of all architectures, indexed by normalized entity identifier, then by normalized architecture identifier.

property Configurations: Dict[str, Configuration]

Read-only property to access the dictionary of all configuration declarations in this library (_configurations).

Returns:: Dictionary of all configurations, indexed by normalized identifier.

property Contexts: Dict[str, Context]

Read-only property to access the dictionary of all context declarations in this library (_contexts).

Returns:: Dictionary of all contexts, indexed by normalized identifier.

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 Documentation: str | None

Property to access the library’s documentation (_documentation).

Hint

Unlike every other documented entity, a library’s documentation cannot come from VHDL source: the language has no library declaration to attach a comment to. It is therefore settable, so a caller can supply one from elsewhere - a compile-order file, a project description, …

Returns:: Associated documentation of this VHDL library.

property Entities: Dict[str, Entity]

Read-only property to access the dictionary of all entity declarations in this library (_entities).

Returns:: Dictionary of all entities, indexed by normalized identifier.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

property Identifier: str

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexArchitectures()

Index declared items in all architectures.

Return type:: None

Algorithm

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

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

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

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

Iterate all contexts in that library.
Iterate all packages in that library.
Iterate all package bodies in that library.
Iterate all entities in that library.
Iterate all architectures in that library.
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

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.
LinkPackageInstances(): Link all package instances to corresponding generic packages.

LinkPackageBodies()

Link all package bodies to corresponding packages.

Return type:: None

Algorithm

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.
LinkPackageInstances(): Link all package instances to corresponding generic packages.

LinkPackageInstances()

Link all package instances to corresponding generic packages.

Return type:: None

Algorithm

Iterate all package instances.
Todo
- 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 generic package name doesn’t exist.
Return type:: None

See also

LinkArchitectures(): Link all architectures to corresponding entities.
LinkPackageBodies(): Link all package bodies to corresponding packages.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBodies: Dict[str, PackageBody]

Read-only property to access the dictionary of all package body declarations in this library (_packageBodies).

Returns:: Dictionary of all package bodies, indexed by normalized identifier.

property Packages: Dict[str, Package]

Read-only property to access the dictionary of all package declarations in this library (_packages).

Returns:: Dictionary of all packages, indexed by normalized identifier.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

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

_allowBlackbox: bool | None: Allow blackboxes for components in this 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, 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().

_documentation: str | None: The associated documentation of a model entity.

_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(identifier=None)[source]

Predefined package ieee.math_real.

Inheritance

Parameters:: identifier (str | None)

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(identifier=None)

Initializes a predefined package.

By default the VHDL package name is the Python class name. Pass identifier when the two must differ - e.g. when two vendor flavors of the same VHDL package need distinct Python classes.

Parameters:: identifier (str | None) – The VHDL package name, or None to use the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Real_Body(packageIdentifier=None)[source]

Predefined package body of package ieee.math_real.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Complex[source]

Predefined package ieee.math_complex.

Inheritance

__init__()[source]

Initializes the math_complex package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Math_Complex_Body[source]

Predefined package body of package ieee.math_complex.

Inheritance

__init__()[source]

Initializes the math_complex package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_1164[source]

Predefined package ieee.std_logic_1164.

Predefined types:

std_ulogic, std_ulogic_vector
std_logic, std_logic_vector

Inheritance

__init__()[source]

Initializes the std_logic_1164 package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_1164_Body(packageIdentifier=None)[source]

Predefined package body of package ieee.std_logic_1164.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_TextIO[source]

Predefined package ieee.std_logic_textio.

Inheritance

__init__()[source]

Initializes the std_logic_textio package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit[source]

Predefined package ieee.numeric_bit.

Inheritance

__init__()[source]

Initializes the numeric_bit package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Body(packageIdentifier=None)[source]

Predefined package body of package ieee.numeric_bit.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Unsigned(identifier=None)[source]

Predefined package ieee.numeric_bit_unsigned.

Inheritance

Parameters:: identifier (str | None)

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(identifier=None)

Initializes a predefined package.

By default the VHDL package name is the Python class name. Pass identifier when the two must differ - e.g. when two vendor flavors of the same VHDL package need distinct Python classes.

Parameters:: identifier (str | None) – The VHDL package name, or None to use the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Bit_Unsigned_Body[source]

Predefined package body of package ieee.numeric_bit_unsigned.

Inheritance

__init__()[source]

Initializes the numeric_bit_unsigned package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std[source]

Predefined package ieee.numeric_std.

Predefined types:

unresolved_unsigned, unsigned
unresolved_signed, signed

Inheritance

__init__()[source]

Initializes the numeric_std package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Body(packageIdentifier=None)[source]

Predefined package body of package ieee.numeric_std.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Unsigned[source]

Predefined package ieee.numeric_std_unsigned.

Inheritance

__init__()[source]

Initializes the numeric_std_unsigned package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Numeric_Std_Unsigned_Body[source]

Predefined package body of package ieee.numeric_std_unsigned.

Inheritance

__init__()[source]

Initializes the numeric_std_unsigned package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Float_Types(identifier=None)[source]

Predefined package ieee.fixed_float_types.

Inheritance

Parameters:: identifier (str | None)

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(identifier=None)

Initializes a predefined package.

By default the VHDL package name is the Python class name. Pass identifier when the two must differ - e.g. when two vendor flavors of the same VHDL package need distinct Python classes.

Parameters:: identifier (str | None) – The VHDL package name, or None to use the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Generic_Pkg[source]

Predefined package ieee.fixed_generic_pkg.

Inheritance

__init__()[source]

Initializes the fixed_generic_pkg package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Generic_Pkg_Body[source]

Predefined package body of package ieee.fixed_generic_pkg.

Inheritance

__init__()[source]

Initializes the fixed_generic_pkg package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Fixed_Pkg[source]

Predefined package ieee.fixed_pkg.

Inheritance

__init__()[source]

Initializes the fixed_pkg package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Generic_Pkg[source]

Predefined package ieee.float_generic_pkg.

Inheritance

__init__()[source]

Initializes the float_generic_pkg package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Generic_Pkg_Body(packageIdentifier=None)[source]

Predefined package body of package ieee.float_generic_pkg.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Float_Pkg[source]

Predefined package ieee.float_pkg.

Inheritance

__init__()[source]

Initializes the float_pkg package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Arith_MentorGraphics[source]

Predefined Mentor Graphics package ieee.std_logic_arith.

Inheritance

__init__()[source]

Initializes the std_logic_arith package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Arith_Body_MentorGraphics[source]

Predefined package body of Mentor Graphics package ieee.std_logic_arith.

Inheritance

__init__()[source]

Initializes the std_logic_arith package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Timing[source]

Predefined package ieee.VITAL_Timing.

Inheritance

__init__()[source]

Initializes the VITAL_Timing package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Timing_Body[source]

Predefined package body of package ieee.VITAL_Timing.

Inheritance

__init__()[source]

Initializes the VITAL_Timing package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Primitives[source]

Predefined package ieee.VITAL_Primitives.

Inheritance

__init__()[source]

Initializes the VITAL_Primitives package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Primitives_Body[source]

Predefined package body of package ieee.VITAL_Primitives.

Inheritance

__init__()[source]

Initializes the VITAL_Primitives package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Memory[source]

Predefined package ieee.VITAL_Memory.

Inheritance

__init__()[source]

Initializes the VITAL_Memory package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.VITAL_Memory_Body[source]

Predefined package body of package ieee.VITAL_Memory.

Inheritance

__init__()[source]

Initializes the VITAL_Memory package body.

Return type:: None

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Arith_Synopsys[source]

Predefined Synopsys package ieee.std_logic_arith.

Inheritance

__init__()[source]

Initializes the std_logic_arith package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Misc[source]

Predefined Synopsys package ieee.std_logic_misc.

Inheritance

__init__()[source]

Initializes the std_logic_misc package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Misc_Body(packageIdentifier=None)[source]

Predefined package body of Synopsys package ieee.std_logic_misc.

Inheritance

Parameters:: packageIdentifier (str | None)

property Components: Dict[str, Any]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

Index declared items listed in the concurrent declaration region.

Return type:: None

Algorithm

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 Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property Package: PackageSymbol

Read-only property to access the package (_package).

Returns:: The package.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__init__(packageIdentifier=None)

Initializes a predefined package body.

By default the VHDL package name is the Python class name with the trailing _Body removed. Pass packageIdentifier when the two must differ.

Parameters:: packageIdentifier (str | None) – The VHDL name of the package this body implements, or None to derive it from the class name.
Return type:: None

__new__(**kwargs)

__repr__()

Formats a representation of the package body declaration.

Format: mylib.myPackage(body)

Return type:: str
Returns:: String representation of the package body declaration.

__str__()

Formats the package body declaration.

Format: Package Body: mylib.myPackage(body)

Return type:: str
Returns:: Formatted package body declaration.

_components: Dictionary of all components declared in this concurrent declaration region.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = True: A package body continues its package’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_package: Reference to the package this body implements.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Signed[source]

Predefined Synopsys package ieee.std_logic_signed.

Inheritance

__init__()[source]

Initializes the std_logic_signed package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_TextIO_Synopsys[source]

Predefined Synopsys package ieee.std_logic_textio.

Inheritance

__init__()[source]

Initializes the std_logic_textio package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.

class pyVHDLModel.IEEE.Std_Logic_Unsigned[source]

Predefined Synopsys package ieee.std_logic_unsigned.

Inheritance

__init__()[source]

Initializes the std_logic_unsigned package.

Return type:: None

property AllowBlackbox: bool

Property to return whether a design supports blackboxes, inherited from the parent if not set locally (_allowBlackbox).

Algorithm

If allow blackbox property is locally set, return the local value,
Otherwise, return allow blackbox value from parent object.

Returns:: True, if blackboxes are allowed.
Raises:: VHDLModelException – If neither a local value is set nor a parent object is available to inherit the value from.

property Components: Dict[str, Component]

Read-only property to access the components (_components).

Returns:: Dictionary of components, indexed by normalized identifier.

property Constants: Dict[str, Constant]

Read-only property to access the constants (_constants).

Returns:: Dictionary of constants, indexed by normalized identifier.

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 DeclaredItems: List

Read-only property to access the declared items (_declaredItems).

Returns:: List of declared items.

property DeferredConstants: Dict[str, DeferredConstant]

Read-only property to access the deferred constants (_deferredConstants).

Returns:: Dictionary of deferred constants, indexed by normalized identifier.

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 Document: Document

Property to access the document (_document).

Returns:: The document.

property Documentation: str | None

Read-only property to access the model entity’s documentation (_documentation).

Returns:: Associated documentation of a model entity.

property Files: Dict[str, File]

Read-only property to access the files (_files).

Returns:: Dictionary of files, indexed by normalized identifier.

property Functions: Dict[str, List[Function]]

Read-only property to access the functions (_functions).

Returns:: Dictionary of functions, indexed by normalized identifier; each entry is a list of overloads.

property GenericCount: int

Read-only property to return the number of generics in _genericItems.

Returns:: The generic count.

property GenericItems: List[GenericInterfaceItemMixin]

Read-only property to access the generic items (_genericItems).

Returns:: List of generic items.

GetAncestor(type)

Return the closest ancestor of the given type found by walking the parent chain upwards.

Iterates the parent chain - starting at this model entity - upwards (toward the root of the model) until an ancestor of the requested type is found.

Parameters:: type (Type) – Class (type) of the ancestor to find.
Return type:: ModelEntity
Returns:: The closest ancestor of the requested type.
Raises:: VHDLModelException – If the root of the model is reached without finding an ancestor of the requested type.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None) – An attribute class, an iterable of attribute classes, or None to accept every attribute.

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Dictionary of methods and the matching attributes attached to them.

Raises:

ValueError – If an element of parameter ‘predicate’ is not a sub-class of Attribute.
ValueError – If parameter ‘predicate’ is neither an attribute class nor an iterable of those.

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

Read-only property to access the model entity’s identifier (_identifier).

Returns:: Name of a model entity.

IndexDeclaredItems()

A generic package’s generics share the declarative region of its declarative part.

Return type:: None

property Library: Library

Property to access the library (_parent).

Returns:: The library.

property LibraryReferences: List[LibraryClause]

Read-only property to access the sequence of library clauses (_libraryReferences).

Returns:: Sequence of library clauses.

property NormalizedIdentifier: str

Read-only property to access the model entity’s normalized identifier (_normalizedIdentifier).

Returns:: Normalized name of a model entity.

property PackageBody: PackageBody | None

Read-only property to access the package body (_packageBody).

Returns:: The package body, or None if not set.

property PackageReferences: List[UseClause]

Read-only property to access the sequence of use clauses (_packageReferences).

Returns:: Sequence of use clauses.

property Parent: ModelEntity

Property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:: Reference to the parent entity.

property Procedures: Dict[str, List[Procedure]]

Read-only property to access the procedures (_procedures).

Returns:: Dictionary of procedures, indexed by normalized identifier; each entry is a list of overloads.

property ReferencedContexts: Dict[str, Context]

Read-only property to access the referenced contexts (_referencedContexts).

Returns:: Dictionary of referenced contexts, indexed by normalized identifier.

property ReferencedLibraries: Dict[str, Library]

Read-only property to access the referenced libraries (_referencedLibraries).

Returns:: Dictionary of referenced libraries, indexed by normalized identifier.

property ReferencedPackages: Dict[str, Package]

Read-only property to access the referenced packages (_referencedPackages).

Returns:: Dictionary of referenced packages, indexed by normalized identifier.

property SharedVariables: Dict[str, SharedVariable]

Read-only property to access the shared variables (_sharedVariables).

Returns:: Dictionary of shared variables, indexed by normalized identifier.

property Signals: Dict[str, Signal]

Read-only property to access the signals (_signals).

Returns:: Dictionary of signals, indexed by normalized identifier.

property Subtypes: Dict[str, Subtype]

Read-only property to access the subtypes (_subtypes).

Returns:: Dictionary of subtypes, indexed by normalized identifier.

property Types: Dict[str, FullType]

Read-only property to access the types (_types).

Returns:: Dictionary of types, indexed by normalized identifier.

_IndexGenericItems()

Add this region’s generics to its namespace.

Return type:: None

_IndexOtherDeclaredItem(item)

Hook for declared items the region doesn’t handle itself. Derived classes may override it.

Return type:: None

_IndexParameterItems()

Add this region’s parameters to its namespace.

Return type:: None

_IndexPortItems()

Add this region’s ports to its namespace.

Return type:: None

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:: Dict[str, Any]

__new__(**kwargs)

__repr__()

Formats a representation of the package declaration.

Format: mylib.myPackage

Return type:: str
Returns:: String representation of the package declaration.

__str__()

Formats the package declaration.

Format: Package: 'mylib.myPackage'

Return type:: str
Returns:: Formatted package declaration.

_allowBlackbox: Allow blackboxes for components in language entity.

_components: Components, indexed by name.

_constants: Dictionary of all constants declared in this concurrent declaration region.

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

_contextReferences: List of context clauses.

_continuesParentRegion = False: True if it continues its parent’s declarative region.

_declaredItems: List of all declared items in this concurrent declaration region.

_deferredConstants: Deferred constants, indexed by name.

_dependencyVertex: Reference to the vertex in the dependency graph representing the design unit.
This reference is set by CreateDependencyGraph().

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

_documentation: The associated documentation of a model entity.

_files: Dictionary of all files declared in this concurrent declaration region.

_functions: Dictionary of all functions declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_genericItems: List of all generics, in declaration order.

_hierarchyVertex: The vertex in the hierarchy graph

_identifier: The identifier of a model entity.

_libraryReferences: List of library clauses.

_namespace: The namespace of this design unit’s declarative region.

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

_packageBody: The corresponding package body, or None if none was analyzed.

_packageReferences: List of use clauses.

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

_procedures: Dictionary of all procedures declared in this concurrent declaration region, indexed by name; each entry is a list of overloads.

_referencedContexts: Referenced contexts based on explicit context references or implicit inheritance

_referencedLibraries: Referenced libraries based on explicit library clauses or implicit inheritance

_referencedPackages: Referenced packages based on explicit use clauses or implicit inheritance

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

_signals: Dictionary of all signals declared in this concurrent declaration region.

_subtypes: Dictionary of all subtypes declared in this concurrent declaration region.

_types: Dictionary of all types declared in this concurrent declaration region.