.. _vhdlmodel-desuni:

Design Units
############

A VHDL design (see :ref:`vhdlmodel-design`) is assembled from *design units*. VHDL distinguishes
between *primary* and *secondary* design units.

.. contents:: Table of Content
   :local:

.. rubric:: Class Hierarchy

.. inheritance-diagram:: pyVHDLModel.SyntaxModel.Architecture pyVHDLModel.SyntaxModel.Context pyVHDLModel.SyntaxModel.Configuration pyVHDLModel.SyntaxModel.Entity pyVHDLModel.SyntaxModel.Package pyVHDLModel.SyntaxModel.PackageBody
   :parts: 1

.. _vhdlmodel-primary:

Primary Units
=============

.. _vhdlmodel-context:

Context
-------

.. todo::

   Write documentation.



.. _vhdlmodel-configuration:

Configuration
-------------

.. todo::

   Write documentation.



.. _vhdlmodel-entity:

Entity
------

An ``Entity`` represents a VHDL entity declaration. Libraries and package
references declared ahead an entity are consumed by that entity and made
available as lists. An entities also provides lists of generic and port items.
The list of declared items (e.g. objects) also contains defined items (e.g.
types). An entity's list of statements is called body items.

**Condensed definition of class** :class:`~pyVHDLModel.SyntaxModel.Entity`:

.. code-block:: Python

   @export
   class Entity(PrimaryUnit, MixinDesignUnitWithContext):
     # inherited from ModelEntity
     @property
     def Parent(self) -> ModelEntity:

     # inherited from NamedEntity
     @property
     def Name(self) -> str:

     # inherited from MixinDesignUnitWithContext
     @property
     def LibraryReferences(self) -> List[LibraryClause]:

     @property
     def PackageReferences(self) -> List[UseClause]:

     @property
     def ContextReferences(self) -> List[Context]:

     # from Entity
     @property
     def GenericItems(self) -> List[GenericInterfaceItem]:

     @property
     def PortItems(self) -> List[PortInterfaceItem]:

     @property
     def DeclaredItems(self) -> List:

     @property
     def BodyItems(self) -> List[ConcurrentStatement]:



.. _vhdlmodel-package:

Package
-------

.. todo::

   Write documentation.

**Condensed definition of class** :class:`~pyVHDLModel.SyntaxModel.Package`:

.. code-block:: Python

   @export
   class Package(PrimaryUnit, MixinDesignUnitWithContext):
     # inherited from ModelEntity
     @property
     def Parent(self) -> ModelEntity:

     # inherited from NamedEntity
     @property
     def Name(self) -> str:

     # inherited from MixinDesignUnitWithContext
     @property
     def LibraryReferences(self) -> List[LibraryClause]:

     @property
     def PackageReferences(self) -> List[UseClause]:

     @property
     def ContextReferences(self) -> List[Context]:

     # from Package
     @property
     def GenericItems(self) -> List[GenericInterfaceItem]:

     @property
     def DeclaredItems(self) -> List:



.. _vhdlmodel-secondary:

Secondary Units
===============

.. _vhdlmodel-architeture:

Architeture
-----------

.. todo::

   Write documentation.

**Condensed definition of class** :class:`~pyVHDLModel.SyntaxModel.Architecture`:

.. code-block:: Python

   @export
   class Architecture(SecondaryUnit, MixinDesignUnitWithContext):
     # inherited from ModelEntity
     @property
     def Parent(self) -> ModelEntity:

     # inherited from NamedEntity
     @property
     def Name(self) -> str:

     # inherited from MixinDesignUnitWithContext
     @property
     def LibraryReferences(self) -> List[LibraryClause]:

     @property
     def PackageReferences(self) -> List[UseClause]:

     @property
     def ContextReferences(self) -> List[Context]:

     # from Architecture
     @property
     def Entity(self) -> Entity:

     @property
     def DeclaredItems(self) -> List:

     @property
     def BodyItems(self) -> List[ConcurrentStatement]:



.. _vhdlmodel-packagebody:

Package Body
------------

.. todo::

   Write documentation.

**Condensed definition of class** :class:`~pyVHDLModel.SyntaxModel.PackageBody`:

.. code-block:: Python

   @export
   class PackageBody(SecondaryUnit, MixinDesignUnitWithContext):
     # inherited from ModelEntity
     @property
     def Parent(self) -> ModelEntity:

     # inherited from NamedEntity
     @property
     def Name(self) -> str:

     # inherited from MixinDesignUnitWithContext
     @property
     def LibraryReferences(self) -> List[LibraryClause]:

     @property
     def PackageReferences(self) -> List[UseClause]:

     @property
     def ContextReferences(self) -> List[Context]:

     # from Package Body
     @property
     def Package(self) -> Package:

     @property
     def DeclaredItems(self) -> List: