pyVHDLModel.Subprogram

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

Subprograms are procedures, functions and methods.

Classes

Subprogram: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
Procedure: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
Function: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
MethodMixin: A Method is a mixin class for all subprograms in a protected type.
ProcedureMethod: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple
FunctionMethod: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple

Classes

class pyVHDLModel.Subprogram.Subprogram(identifier, isPure, documentation=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
isPure (bool)
documentation (str | None)
parent (ModelEntity)

__init__(identifier, isPure, documentation=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
identifier (str)
isPure (bool)
documentation (str | None)

Return type:

None

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

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

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

_parent: ModelEntity: Reference to a parent entity in the logical model hierarchy.

class pyVHDLModel.Subprogram.Procedure(identifier, documentation=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
documentation (str | None)
parent (ModelEntity)

__init__(identifier, documentation=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
identifier (str)
documentation (str | None)

Return type:

None

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.

_documentation: Nullable[str]: The associated documentation of a model 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.Subprogram.Function(identifier, isPure=True, documentation=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
isPure (bool)
documentation (str | None)
parent (ModelEntity)

__init__(identifier, isPure=True, documentation=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
identifier (str)
isPure (bool)
documentation (str | None)

Return type:

None

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.

_documentation: Nullable[str]: The associated documentation of a model 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.Subprogram.MethodMixin(protectedType)[source]

A Method is a mixin class for all subprograms in a protected type.

Inheritance

Parameters:: protectedType (ProtectedType)

__init__(protectedType)[source]

Parameters:: protectedType (ProtectedType)
Return type:: None

class pyVHDLModel.Subprogram.ProcedureMethod(identifier, documentation=None, protectedType=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
documentation (str | None)
protectedType (ProtectedType | None)
parent (ModelEntity)

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.

_documentation: Nullable[str]: The associated documentation of a model 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.

__init__(identifier, documentation=None, protectedType=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
identifier (str)
documentation (str | None)
protectedType (ProtectedType | None)

Return type:

None

class pyVHDLModel.Subprogram.FunctionMethod(identifier, isPure=True, documentation=None, protectedType=None, parent=None)[source]

Inheritance

Parameters:

identifier (str)
isPure (bool)
documentation (str | None)
protectedType (ProtectedType | None)
parent (ModelEntity)

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.

_documentation: Nullable[str]: The associated documentation of a model 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.

__init__(identifier, isPure=True, documentation=None, protectedType=None, parent=None)[source]

Initializes a VHDL model entity.

Parameters:

parent (ModelEntity) – The parent model entity of this entity.
identifier (str)
isPure (bool)
documentation (str | None)
protectedType (ProtectedType | None)

Return type:

None