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: A ScalarType is a base-class for all scalar types.

• RangedScalarType: A RangedScalarType is a base-class for all scalar types with a range.

• NumericTypeMixin: A NumericType is a mixin class for all numeric types.

• DiscreteTypeMixin: A DiscreteType is a mixin class for all discrete types.

• EnumeratedType: A ScalarType is a base-class for all scalar types.

• IntegerType: A RangedScalarType is a base-class for all scalar types with a range.

• RealType: A RangedScalarType is a base-class for all scalar types with a range.

• PhysicalType: A RangedScalarType is a base-class for all scalar types with a range.

• CompositeType: A CompositeType is a base-class for all composite types.

• ArrayType: A CompositeType 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 multiple

• RecordType: A CompositeType 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

BaseType is the base-class of all type entities in this model.

Inheritance

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

_parent: ModelEntity

Reference to a parent entity in the model.

class pyVHDLModel.Type.Type

Inheritance

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.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

class pyVHDLModel.Type.AnonymousType

Inheritance

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.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

class pyVHDLModel.Type.FullType

Inheritance

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.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

class pyVHDLModel.Type.Subtype

Inheritance

__init__(identifier, symbol)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• symbol (Symbol) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.ScalarType

A ScalarType is a base-class for all scalar types.

Inheritance

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.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

class pyVHDLModel.Type.RangedScalarType

A RangedScalarType is a base-class for all scalar types with a range.

Inheritance

__init__(identifier, rng)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• rng (Union[Range, Name]) –

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.

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

class pyVHDLModel.Type.NumericTypeMixin

A NumericType is a mixin class for all numeric types.

Inheritance

__init__()

class pyVHDLModel.Type.DiscreteTypeMixin

A DiscreteType is a mixin class for all discrete types.

Inheritance

__init__()

class pyVHDLModel.Type.EnumeratedType

Inheritance

__init__(identifier, literals)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• literals (Iterable[EnumerationLiteral]) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.IntegerType

Inheritance

__init__(identifier, rng)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• rng (Union[Range, Name]) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.RealType

Inheritance

__init__(identifier, rng)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• rng (Union[Range, Name]) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.PhysicalType

Inheritance

__init__(identifier, rng, primaryUnit, units)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• rng (Union[Range, Name]) –

• primaryUnit (str) –

• units (Iterable[Tuple[str, PhysicalIntegerLiteral]]) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.CompositeType

A CompositeType is a base-class for all composite types.

Inheritance

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.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str) –

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

class pyVHDLModel.Type.ArrayType

Inheritance

__init__(identifier, indices, elementSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• indices (Iterable) –

• elementSubtype (Symbol) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.RecordTypeElement

Inheritance

__init__(identifiers, subtype)

Initializes a VHDL model entity.

Parameters:

• identifiers (Iterable[str]) –

• subtype (Symbol) –

__str__()

Return str(self).

Return type:

str

_identifiers: Tuple[str]

A list of identifiers.

_normalizedIdentifiers: Tuple[str]

A list of normalized (lower case) identifiers.

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.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyVHDLModel.Type.RecordType

Inheritance

__init__(identifier, elements=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• elements (Iterable[RecordTypeElement]) –

__str__()

Return str(self).

Return type:

str

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.

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

class pyVHDLModel.Type.ProtectedType

Inheritance

__init__(identifier, methods=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• methods (Union[List, Iterator]) –

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.

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

class pyVHDLModel.Type.ProtectedTypeBody

Inheritance

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.

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

__init__(identifier, declaredItems=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• declaredItems (Union[List, Iterator]) –

class pyVHDLModel.Type.AccessType

Inheritance

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.

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

__init__(identifier, designatedSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• designatedSubtype (Symbol) –

__str__()

Return str(self).

Return type:

str

class pyVHDLModel.Type.FileType

Inheritance

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.

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

__init__(identifier, designatedSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• designatedSubtype (Symbol) –

__str__()

Return str(self).

Return type:

str