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(documentation=None)

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

Inheritance

Parameters:

documentation (str | None)

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (Optional[str]) – Documentation of a model entity.

Return type:

None

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

_documentation: Optional[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.InterfaceItemWithModeMixin(mode)

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

Inheritance

Parameters:

mode (Mode)

__init__(mode)

Parameters:

mode (Mode)

Return type:

None

class pyVHDLModel.Interface.GenericInterfaceItemMixin(documentation=None)

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

Inheritance

Parameters:

documentation (str | None)

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (Optional[str]) – Documentation of a model entity.

Return type:

None

_documentation: Optional[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.PortInterfaceItemMixin(mode)

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

Inheritance

Parameters:

mode (Mode)

__init__(mode)

Initializes a documented entity.

Parameters:

• documentation – Documentation of a model entity.

• mode (Mode)

Return type:

None

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

_documentation: Optional[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.ParameterInterfaceItemMixin(documentation=None)

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

Inheritance

Parameters:

documentation (str | None)

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (Optional[str]) – Documentation of a model entity.

Return type:

None

_documentation: Optional[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.GenericConstantInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_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 logical model hierarchy.

class pyVHDLModel.Interface.GenericTypeInterfaceItem(identifier, documentation=None, parent=None)

Inheritance

Parameters:

• identifier (str)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifier, documentation=None, parent=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• parent (ModelEntity) – Reference to the logical parent in the model hierarchy.

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the 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 logical model hierarchy.

class pyVHDLModel.Interface.GenericSubprogramInterfaceItem(documentation=None)

Inheritance

Parameters:

documentation (str | None)

_documentation: Optional[str]

The associated documentation of a model entity.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (Optional[str]) – Documentation of a model entity.

Return type:

None

class pyVHDLModel.Interface.GenericProcedureInterfaceItem(identifier, documentation=None, parent=None)

Inheritance

Parameters:

• identifier (str)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifier, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifier (str)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the 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 logical model hierarchy.

class pyVHDLModel.Interface.GenericFunctionInterfaceItem(identifier, documentation=None, parent=None)

Inheritance

Parameters:

• identifier (str)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifier, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifier (str)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the 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 logical model hierarchy.

class pyVHDLModel.Interface.GenericPackageInterfaceItem(identifier, documentation=None, parent=None)

Inheritance

Parameters:

• identifier (str)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifier, documentation=None, parent=None)

Initializes a documented entity.

Parameters:

• documentation (Optional[str]) – Documentation of a model entity.

• identifier (str)

• parent (ModelEntity)

Return type:

None

_documentation: Optional[str]

The associated documentation of a model entity.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class pyVHDLModel.Interface.PortSignalInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_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 logical model hierarchy.

class pyVHDLModel.Interface.ParameterConstantInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_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 logical model hierarchy.

class pyVHDLModel.Interface.ParameterVariableInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_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 logical model hierarchy.

class pyVHDLModel.Interface.ParameterSignalInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

• parent (ModelEntity)

__init__(identifiers, mode, subtype, defaultExpression=None, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• mode (Mode)

• subtype (Symbol)

• defaultExpression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal | None)

• documentation (str | None)

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

_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 logical model hierarchy.

class pyVHDLModel.Interface.ParameterFileInterfaceItem(identifiers, subtype, documentation=None, parent=None)

Inheritance

Parameters:

• identifiers (Iterable[str])

• subtype (Symbol)

• documentation (str | None)

• parent (ModelEntity)

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

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 ObjectVertex: Vertex | None

Read-only property to access the corresponding object vertex (_objectVertex).

The object vertex references this Object by its value field.

Returns:

The corresponding object vertex.

property Parent: ModelEntity

Read-only property to access the model entity’s parent element reference in a logical hierarchy (_parent).

Returns:

Reference to the parent entity.

__init__(identifiers, subtype, documentation=None, parent=None)

Initializes a VHDL model entity.

Parameters:

• parent (ModelEntity) – The parent model entity of this entity.

• identifiers (Iterable[str])

• subtype (Symbol)

• documentation (str | None)

Return type:

None

_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 logical model hierarchy.