pyVHDLModel.Interface¶

This module contains parts of an abstract document language model for VHDL.

Interface items are used in generic, port and parameter declarations.

Classes

InterfaceItemMixin: An InterfaceItem is a base-class for all mixin-classes for all interface items.
InterfaceItemWithModeMixin: An InterfaceItemWithMode is a mixin-class to provide a Mode to interface items.
GenericInterfaceItemMixin: A GenericInterfaceItem is a mixin class for all generic interface items.
PortInterfaceItemMixin: A PortInterfaceItem is a mixin class for all port interface items.
ParameterInterfaceItemMixin: A ParameterInterfaceItem is a mixin class for all parameter interface items.
GenericConstantInterfaceItem: Represents a constant.
GenericTypeInterfaceItem: BaseType is the base-class of all type entities in this model.
GenericSubprogramInterfaceItem: A GenericInterfaceItem is a mixin class for all generic interface items.
GenericProcedureInterfaceItem: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
GenericFunctionInterfaceItem: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
GenericPackageInterfaceItem: A GenericInterfaceItem is a mixin class for all generic interface items.
PortSignalInterfaceItem: Represents a signal.
ParameterConstantInterfaceItem: Represents a constant.
ParameterVariableInterfaceItem: Represents a variable.
ParameterSignalInterfaceItem: Represents a signal.
ParameterFileInterfaceItem: Represents a file.

Classes

class pyVHDLModel.Interface.InterfaceItemMixin[source]¶

An InterfaceItem is a base-class for all mixin-classes for all interface items.

Inheritance

__init__(documentation=None)[source]¶

Initializes a documented entity.

Parameters:: documentation (str) – Documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

_documentation: Nullable[str]¶: The associated documentation of a model entity.

class pyVHDLModel.Interface.InterfaceItemWithModeMixin[source]¶

An InterfaceItemWithMode is a mixin-class to provide a Mode to interface items.

Inheritance

__init__(mode)[source]¶

Parameters:: mode (Mode) –

class pyVHDLModel.Interface.GenericInterfaceItemMixin[source]¶

A GenericInterfaceItem is a mixin class for all generic interface items.

Inheritance

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

__init__(documentation=None)¶

Initializes a documented entity.

Parameters:: documentation (str) – Documentation of a model entity.

_documentation: Nullable[str]¶: The associated documentation of a model entity.

class pyVHDLModel.Interface.PortInterfaceItemMixin[source]¶

A PortInterfaceItem is a mixin class for all port interface items.

Inheritance

__init__(mode)[source]¶

Initializes a documented entity.

Parameters:

documentation – Documentation of a model entity.
mode (Mode) –

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

_documentation: Nullable[str]¶: The associated documentation of a model entity.

class pyVHDLModel.Interface.ParameterInterfaceItemMixin[source]¶

A ParameterInterfaceItem is a mixin class for all parameter interface items.

Inheritance

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

__init__(documentation=None)¶

Initializes a documented entity.

Parameters:: documentation (str) – Documentation of a model entity.

_documentation: Nullable[str]¶: The associated documentation of a model entity.

class pyVHDLModel.Interface.GenericConstantInterfaceItem[source]¶

Inheritance

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
mode (Mode) –
subtype (Symbol) –
defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Literal]) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.GenericTypeInterfaceItem[source]¶

Inheritance

__init__(identifier, documentation=None)[source]¶

Initializes underlying BaseType.

Parameters:

identifier (str) – Name of the type.
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifier: str¶

Returns a model entity’s identifier (name).

Returns:: Name of a model entity.

property NormalizedIdentifier: str¶

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

Returns:: Normalized name of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifier: str¶: The identifier of a model entity.

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

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.GenericSubprogramInterfaceItem[source]¶

Inheritance

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

__init__(documentation=None)¶

Initializes a documented entity.

Parameters:: documentation (str) – Documentation of a model entity.

class pyVHDLModel.Interface.GenericProcedureInterfaceItem[source]¶

Inheritance

__init__(identifier, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifier (str) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifier: str¶

Returns a model entity’s identifier (name).

Returns:: Name of a model entity.

property NormalizedIdentifier: str¶

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

Returns:: Normalized name of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifier: str¶: The identifier of a model entity.

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

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.GenericFunctionInterfaceItem[source]¶

Inheritance

__init__(identifier, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifier (str) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifier: str¶

Returns a model entity’s identifier (name).

Returns:: Name of a model entity.

property NormalizedIdentifier: str¶

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

Returns:: Normalized name of a model entity.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifier: str¶: The identifier of a model entity.

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

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.GenericPackageInterfaceItem[source]¶

Inheritance

__init__(identifier, documentation=None)[source]¶

Initializes a documented entity.

Parameters:

documentation (str) – Documentation of a model entity.
identifier (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

class pyVHDLModel.Interface.PortSignalInterfaceItem[source]¶

Inheritance

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
mode (Mode) –
subtype (Symbol) –
defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Literal]) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.ParameterConstantInterfaceItem[source]¶

Inheritance

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
mode (Mode) –
subtype (Symbol) –
defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Literal]) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.ParameterVariableInterfaceItem[source]¶

Inheritance

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
mode (Mode) –
subtype (Symbol) –
defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Literal]) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.ParameterSignalInterfaceItem[source]¶

Inheritance

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
mode (Mode) –
subtype (Symbol) –
defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Literal]) –
documentation (str) –

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.

class pyVHDLModel.Interface.ParameterFileInterfaceItem[source]¶

Inheritance

_documentation: Nullable[str]¶: The associated documentation of a model entity.

property Documentation: Optional[str]¶

Returns a model entity’s associated documentation.

Returns:: Associated documentation of a model entity.

property Identifiers: Tuple[str]¶

Returns a model entity’s tuple of identifiers (names).

Returns:: Tuple of identifiers.

property NormalizedIdentifiers: Tuple[str]¶

Returns a model entity’s tuple of normalized identifiers (lower case names).

Returns:: Tuple of normalized identifiers.

property Parent: ModelEntity¶

Returns a reference to the parent entity.

Returns:: Parent entity.

__init__(identifiers, subtype, documentation=None)[source]¶

Initializes a VHDL model entity.

Parameters:

identifiers (Iterable[str]) –
subtype (Symbol) –
documentation (str) –

_identifiers: Tuple[str]¶: A list of identifiers.

_normalizedIdentifiers: Tuple[str]¶: A list of normalized (lower case) identifiers.

_parent: ModelEntity¶: Reference to a parent entity in the model.