.. # Template modified by Patrick Lehmann * removed automodule on top, because private members are activated for autodoc (no doubled documentation). * Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels. ===================== pyVHDLModel.Interface ===================== .. automodule:: pyVHDLModel.Interface .. currentmodule:: pyVHDLModel.Interface **Classes** - :py:class:`ModeViewElement`: Base-class for one element definition inside a mode view declaration (VHDL-2019). An element may name - :py:class:`SimpleModeViewElement`: A mode view element with a plain (simple) mode. - :py:class:`CompositeModeViewElement`: A mode view element that refers to another (named) mode view for an array or record sub-element. - :py:class:`ModeViewDeclaration`: Represents a mode view declaration (VHDL-2019). - :py:class:`InterfaceItemMixin`: A mixin-class marking a declaration as an interface item. - :py:class:`InterfaceItemWithModeMixin`: A mixin-class for interface items declared with a mode. - :py:class:`GenericInterfaceItemMixin`: A mixin-class for all items in a generic clause. - :py:class:`PortInterfaceItemMixin`: A mixin-class for all items in a port clause. - :py:class:`ParameterInterfaceItemMixin`: A mixin-class for all items in a subprogram's parameter list. - :py:class:`GenericConstantInterfaceItem`: Represents a constant in a generic clause. - :py:class:`GenericTypeInterfaceItem`: Represents a type in a generic clause. - :py:class:`GenericSubprogramInterfaceItem`: Represents the base-class of subprograms in a generic clause. - :py:class:`GenericProcedureInterfaceItem`: Represents a procedure in a generic clause. - :py:class:`GenericFunctionInterfaceItem`: Represents a function in a generic clause. - :py:class:`InterfacePackage`: Represents a package as a generic of a design unit. - :py:class:`GenericPackageInterfaceItem`: Represents a package in a generic clause. - :py:class:`PortSignalInterfaceItem`: Represents the base-class of all signals in a port clause. - :py:class:`PortSimpleSignalInterfaceItem`: Represents a port declared with a simple mode. - :py:class:`PortViewSignalInterfaceItem`: Represents a port declared with a mode view (VHDL-2019). - :py:class:`ParameterConstantInterfaceItem`: Represents a constant parameter of a subprogram. - :py:class:`ParameterVariableInterfaceItem`: Represents a variable parameter of a subprogram. - :py:class:`ParameterSignalInterfaceItem`: Represents a signal parameter of a subprogram. - :py:class:`ParameterSimpleSignalInterfaceItem`: Represents a signal parameter declared with a simple mode. - :py:class:`ParameterViewSignalInterfaceItem`: Represents a signal parameter declared with a mode view (VHDL-2019). - :py:class:`ParameterFileInterfaceItem`: Represents a file parameter of a subprogram. - :py:class:`WithGenericsMixin`: A mixin-class for language constructs with a generic clause. - :py:class:`WithPortsMixin`: A mixin-class for language constructs with a port clause. - :py:class:`WithParametersMixin`: A mixin-class for language constructs with a parameter list. - :py:class:`InterfaceGroup`: Represents a group of interface items sharing one clause. - :py:class:`GenericGroup`: Represents the generic clause of a design unit. - :py:class:`PortGroup`: Represents the port clause of a design unit. - :py:class:`ParameterGroup`: Represents the parameter list of a subprogram. --------------------- **Classes** .. autoclass:: ModeViewElement :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ModeViewElement :parts: 1 .. autoclass:: SimpleModeViewElement :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: SimpleModeViewElement :parts: 1 .. autoclass:: CompositeModeViewElement :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: CompositeModeViewElement :parts: 1 .. autoclass:: ModeViewDeclaration :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ModeViewDeclaration :parts: 1 .. autoclass:: InterfaceItemMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: InterfaceItemMixin :parts: 1 .. autoclass:: InterfaceItemWithModeMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: InterfaceItemWithModeMixin :parts: 1 .. autoclass:: GenericInterfaceItemMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericInterfaceItemMixin :parts: 1 .. autoclass:: PortInterfaceItemMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: PortInterfaceItemMixin :parts: 1 .. autoclass:: ParameterInterfaceItemMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterInterfaceItemMixin :parts: 1 .. autoclass:: GenericConstantInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericConstantInterfaceItem :parts: 1 .. autoclass:: GenericTypeInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericTypeInterfaceItem :parts: 1 .. autoclass:: GenericSubprogramInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericSubprogramInterfaceItem :parts: 1 .. autoclass:: GenericProcedureInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericProcedureInterfaceItem :parts: 1 .. autoclass:: GenericFunctionInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericFunctionInterfaceItem :parts: 1 .. autoclass:: InterfacePackage :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: InterfacePackage :parts: 1 .. autoclass:: GenericPackageInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericPackageInterfaceItem :parts: 1 .. autoclass:: PortSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: PortSignalInterfaceItem :parts: 1 .. autoclass:: PortSimpleSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: PortSimpleSignalInterfaceItem :parts: 1 .. autoclass:: PortViewSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: PortViewSignalInterfaceItem :parts: 1 .. autoclass:: ParameterConstantInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterConstantInterfaceItem :parts: 1 .. autoclass:: ParameterVariableInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterVariableInterfaceItem :parts: 1 .. autoclass:: ParameterSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterSignalInterfaceItem :parts: 1 .. autoclass:: ParameterSimpleSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterSimpleSignalInterfaceItem :parts: 1 .. autoclass:: ParameterViewSignalInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterViewSignalInterfaceItem :parts: 1 .. autoclass:: ParameterFileInterfaceItem :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterFileInterfaceItem :parts: 1 .. autoclass:: WithGenericsMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: WithGenericsMixin :parts: 1 .. autoclass:: WithPortsMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: WithPortsMixin :parts: 1 .. autoclass:: WithParametersMixin :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: WithParametersMixin :parts: 1 .. autoclass:: InterfaceGroup :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: InterfaceGroup :parts: 1 .. autoclass:: GenericGroup :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: GenericGroup :parts: 1 .. autoclass:: PortGroup :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: PortGroup :parts: 1 .. autoclass:: ParameterGroup :members: :private-members: :special-members: :inherited-members: :exclude-members: __weakref__ .. rubric:: Inheritance .. inheritance-diagram:: ParameterGroup :parts: 1