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

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

Inheritance

Inheritance diagram of BaseType

Parameters:
  • identifier (str) –

  • documentation (str) –

__init__(identifier, documentation=None)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

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.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

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

Inheritance

Inheritance diagram of Type

Parameters:
  • identifier (str) –

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

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 (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.AnonymousType(identifier, documentation=None)[source]

Inheritance

Inheritance diagram of AnonymousType

Parameters:
  • identifier (str) –

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

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 (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.FullType(identifier, documentation=None)[source]

Inheritance

Inheritance diagram of FullType

Parameters:
  • identifier (str) –

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

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 (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.Subtype(identifier, symbol)[source]

Inheritance

Inheritance diagram of Subtype

Parameters:
__init__(identifier, symbol)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • symbol (Symbol) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.ScalarType(identifier, documentation=None)[source]

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

Inheritance

Inheritance diagram of ScalarType

Parameters:
  • identifier (str) –

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

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 (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.RangedScalarType(identifier, rng)[source]

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

Inheritance

Inheritance diagram of RangedScalarType

Parameters:
__init__(identifier, rng)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • rng (Range | Name) –

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.

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.NumericTypeMixin[source]

A NumericType is a mixin class for all numeric types.

Inheritance

Inheritance diagram of NumericTypeMixin

__init__()[source]
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.Type.DiscreteTypeMixin[source]

A DiscreteType is a mixin class for all discrete types.

Inheritance

Inheritance diagram of DiscreteTypeMixin

__init__()[source]
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.Type.EnumeratedType(identifier, literals)[source]

Inheritance

Inheritance diagram of EnumeratedType

Parameters:
__init__(identifier, literals)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • literals (Iterable[EnumerationLiteral]) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.IntegerType(identifier, rng)[source]

Inheritance

Inheritance diagram of IntegerType

Parameters:
__init__(identifier, rng)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • rng (Range | Name) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.RealType(identifier, rng)[source]

Inheritance

Inheritance diagram of RealType

Parameters:
__init__(identifier, rng)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • rng (Range | Name) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.PhysicalType(identifier, rng, primaryUnit, units)[source]

Inheritance

Inheritance diagram of PhysicalType

Parameters:
__init__(identifier, rng, primaryUnit, units)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • rng (Range | Name) –

  • primaryUnit (str) –

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

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.CompositeType(identifier, documentation=None)[source]

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

Inheritance

Inheritance diagram of CompositeType

Parameters:
  • identifier (str) –

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

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 (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • documentation (str) –

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.ArrayType(identifier, indices, elementSubtype)[source]

Inheritance

Inheritance diagram of ArrayType

Parameters:
__init__(identifier, indices, elementSubtype)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • indices (Iterable) –

  • elementSubtype (Symbol) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.RecordTypeElement(identifiers, subtype)[source]

Inheritance

Inheritance diagram of RecordTypeElement

Parameters:
__init__(identifiers, subtype)[source]

Initializes a VHDL model entity.

Parameters:
__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

str

_identifiers: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

A list of identifiers.

_normalizedIdentifiers: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

A list of normalized (lower case) identifiers.

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.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.RecordType(identifier, elements=None)[source]

Inheritance

Inheritance diagram of RecordType

Parameters:
__init__(identifier, elements=None)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • elements (Iterable[RecordTypeElement]) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

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.

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: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.ProtectedType(identifier, methods=None)[source]

Inheritance

Inheritance diagram of ProtectedType

Parameters:
__init__(identifier, methods=None)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • methods (List | Iterator) –

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.

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

class pyVHDLModel.Type.ProtectedTypeBody(identifier, declaredItems=None)[source]

Inheritance

Inheritance diagram of ProtectedTypeBody

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

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

__init__(identifier, declaredItems=None)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • declaredItems (List | Iterator) –

class pyVHDLModel.Type.AccessType(identifier, designatedSubtype)[source]

Inheritance

Inheritance diagram of AccessType

Parameters:
  • identifier (str) –

  • designatedSubtype (Symbol) –

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.

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

__init__(identifier, designatedSubtype)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • designatedSubtype (Symbol) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

str

class pyVHDLModel.Type.FileType(identifier, designatedSubtype)[source]

Inheritance

Inheritance diagram of FileType

Parameters:
  • identifier (str) –

  • designatedSubtype (Symbol) –

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.

_documentation: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The associated documentation of a model entity.

_identifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The identifier of a model entity.

_normalizedIdentifier: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

The normalized (lower case) identifier of a model entity.

_parent: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Reference to a parent entity in the model.

__init__(identifier, designatedSubtype)[source]

Initializes underlying BaseType.

Parameters:
  • identifier (# Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include) – Name of the type.

  • designatedSubtype (Symbol) –

__str__()[source]

Return str(self). :rtype: # Load pre-defined aliases and graphical characters like © from docutils # <file> is used to denote the special path # <Python>\Lib\site-packages\docutils\parsers\rst\include

Return type:

str