pyVHDLModel.Type
This module contains parts of an abstract document language model for VHDL.
Types.
Classes
BaseType
:BaseType
is the base-class of all type entities in this model.Type
:BaseType
is the base-class of all type entities in this model.AnonymousType
:BaseType
is the base-class of all type entities in this model.FullType
:BaseType
is the base-class of all type entities in this model.Subtype
:BaseType
is the base-class of all type entities in this model.ScalarType
: AScalarType
is a base-class for all scalar types.RangedScalarType
: ARangedScalarType
is a base-class for all scalar types with a range.NumericTypeMixin
: ANumericType
is a mixin class for all numeric types.DiscreteTypeMixin
: ADiscreteType
is a mixin class for all discrete types.EnumeratedType
: AScalarType
is a base-class for all scalar types.IntegerType
: ARangedScalarType
is a base-class for all scalar types with a range.RealType
: ARangedScalarType
is a base-class for all scalar types with a range.PhysicalType
: ARangedScalarType
is a base-class for all scalar types with a range.CompositeType
: ACompositeType
is a base-class for all composite types.ArrayType
: ACompositeType
is a base-class for all composite types.RecordTypeElement
:ModelEntity
is the base-class for all classes in the VHDL language model, except for mixin classes (see multipleRecordType
: ACompositeType
is a base-class for all composite types.ProtectedType
:BaseType
is the base-class of all type entities in this model.ProtectedTypeBody
:BaseType
is the base-class of all type entities in this model.AccessType
:BaseType
is the base-class of all type entities in this model.FileType
:BaseType
is the base-class of all type entities in this model.
Classes
- class pyVHDLModel.Type.BaseType(identifier, documentation=None, parent=None)[source]
BaseType
is the base-class of all type entities in this model.Inheritance
- Parameters:
identifier (str)
documentation (str | None)
parent (ModelEntity)
- __init__(identifier, documentation=None, parent=None)[source]
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
- 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.Type.Type(identifier, documentation=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
documentation (str | 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.
- __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
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.AnonymousType(identifier, documentation=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
documentation (str | 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.
- __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
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.FullType(identifier, documentation=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
documentation (str | 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.
- __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
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.Subtype(identifier, symbol, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
symbol (Symbol)
parent (ModelEntity)
- __init__(identifier, symbol, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.symbol (Symbol)
- 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.Type.ScalarType(identifier, documentation=None, parent=None)[source]
A
ScalarType
is a base-class for all scalar types.Inheritance
- Parameters:
identifier (str)
documentation (str | 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.
- __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
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.RangedScalarType(identifier, rng, parent=None)[source]
A
RangedScalarType
is a base-class for all scalar types with a range.Inheritance
- Parameters:
identifier (str)
parent (ModelEntity)
- __init__(identifier, rng, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.
- 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.Type.NumericTypeMixin[source]
A
NumericType
is a mixin class for all numeric types.Inheritance
- class pyVHDLModel.Type.DiscreteTypeMixin[source]
A
DiscreteType
is a mixin class for all discrete types.Inheritance
- class pyVHDLModel.Type.EnumeratedType(identifier, literals, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
literals (Iterable[EnumerationLiteral])
parent (ModelEntity)
- __init__(identifier, literals, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.literals (Iterable[EnumerationLiteral])
- 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.
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.IntegerType(identifier, rng, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
parent (ModelEntity)
- __init__(identifier, rng, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.
- 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.Type.RealType(identifier, rng, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
parent (ModelEntity)
- __init__(identifier, rng, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.
- 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.Type.PhysicalType(identifier, rng, primaryUnit, units, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
primaryUnit (str)
units (Iterable[Tuple[str, PhysicalIntegerLiteral]])
parent (ModelEntity)
- __init__(identifier, rng, primaryUnit, units, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.primaryUnit (str)
units (Iterable[Tuple[str, PhysicalIntegerLiteral]])
- 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.Type.CompositeType(identifier, documentation=None, parent=None)[source]
A
CompositeType
is a base-class for all composite types.Inheritance
- Parameters:
identifier (str)
documentation (str | 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.
- __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
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.ArrayType(identifier, indices, elementSubtype, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
indices (Iterable)
elementSubtype (Symbol)
parent (ModelEntity)
- __init__(identifier, indices, elementSubtype, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.indices (Iterable)
elementSubtype (Symbol)
- 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.
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.RecordTypeElement(identifiers, subtype, parent=None)[source]
Inheritance
- Parameters:
subtype (Symbol)
parent (ModelEntity)
- __init__(identifiers, subtype, parent=None)[source]
Initializes a VHDL model entity.
- Parameters:
parent (
ModelEntity
) – The parent model entity of this entity.subtype (Symbol)
- Return type:
None
- 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
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.Type.RecordType(identifier, elements=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
elements (Iterable[RecordTypeElement] | None)
parent (ModelEntity)
- __init__(identifier, elements=None, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.elements (Iterable[RecordTypeElement] | 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.
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- class pyVHDLModel.Type.ProtectedType(identifier, methods=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
parent (ModelEntity)
- __init__(identifier, methods=None, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.
- 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.Type.ProtectedTypeBody(identifier, declaredItems=None, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
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.
- class pyVHDLModel.Type.AccessType(identifier, designatedSubtype, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
designatedSubtype (Symbol)
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.
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- __init__(identifier, designatedSubtype, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.designatedSubtype (Symbol)
- Return type:
None
- class pyVHDLModel.Type.FileType(identifier, designatedSubtype, parent=None)[source]
Inheritance
- Parameters:
identifier (str)
designatedSubtype (Symbol)
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.
-
_parent:
ModelEntity
Reference to a parent entity in the logical model hierarchy.
- __init__(identifier, designatedSubtype, parent=None)[source]
Initializes underlying
BaseType
.- Parameters:
identifier (
str
) – Name of the type.parent (
ModelEntity
) – Reference to the logical parent in the model hierarchy.designatedSubtype (Symbol)
- Return type:
None