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


Classes

class pyVHDLModel.Interface.InterfaceItemMixin(documentation=None)[source]

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

Inheritance

Inheritance diagram of InterfaceItemMixin

Parameters:

documentation (str)

__init__(documentation=None)[source]

Initializes a documented entity.

Parameters:

documentation (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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.InterfaceItemWithModeMixin(mode)[source]

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

Inheritance

Inheritance diagram of InterfaceItemWithModeMixin

Parameters:

mode (Mode)

__init__(mode)[source]
Parameters:

mode (Mode)

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

class pyVHDLModel.Interface.GenericInterfaceItemMixin(documentation=None)[source]

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

Inheritance

Inheritance diagram of GenericInterfaceItemMixin

Parameters:

documentation (str)

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (str) – Documentation of a model entity.

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.PortInterfaceItemMixin(mode)[source]

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

Inheritance

Inheritance diagram of PortInterfaceItemMixin

Parameters:

mode (Mode)

__init__(mode)[source]

Initializes a documented entity.

Parameters:
  • documentation – Documentation of a model entity.

  • mode (Mode)

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.ParameterInterfaceItemMixin(documentation=None)[source]

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

Inheritance

Inheritance diagram of ParameterInterfaceItemMixin

Parameters:

documentation (str)

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (str) – Documentation of a model entity.

Return type:

None

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyVHDLModel.Interface.GenericConstantInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]

Inheritance

Inheritance diagram of GenericConstantInterfaceItem

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

Initializes a VHDL model entity.

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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

Inheritance

Inheritance diagram of GenericTypeInterfaceItem

Parameters:
  • identifier (str)

  • documentation (str)

__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: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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

Inheritance

Inheritance diagram of GenericSubprogramInterfaceItem

Parameters:

documentation (str)

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

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

__init__(documentation=None)

Initializes a documented entity.

Parameters:

documentation (str) – Documentation of a model entity.

Return type:

None

class pyVHDLModel.Interface.GenericProcedureInterfaceItem(identifier, documentation=None)[source]

Inheritance

Inheritance diagram of GenericProcedureInterfaceItem

Parameters:
  • identifier (str)

  • documentation (str)

__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: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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

Inheritance

Inheritance diagram of GenericFunctionInterfaceItem

Parameters:
  • identifier (str)

  • documentation (str)

__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: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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

Inheritance

Inheritance diagram of GenericPackageInterfaceItem

Parameters:
  • identifier (str)

  • documentation (str)

__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: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

class pyVHDLModel.Interface.PortSignalInterfaceItem(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]

Inheritance

Inheritance diagram of PortSignalInterfaceItem

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

Initializes a VHDL model entity.

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]

Inheritance

Inheritance diagram of ParameterConstantInterfaceItem

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

Initializes a VHDL model entity.

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]

Inheritance

Inheritance diagram of ParameterVariableInterfaceItem

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

Initializes a VHDL model entity.

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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(identifiers, mode, subtype, defaultExpression=None, documentation=None)[source]

Inheritance

Inheritance diagram of ParameterSignalInterfaceItem

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

Initializes a VHDL model entity.

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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(identifiers, subtype, documentation=None)[source]

Inheritance

Inheritance diagram of ParameterFileInterfaceItem

Parameters:
_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.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

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