pyVHDLModel.Declaration

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

Classes

• EntityClass: An EntityClass is an enumeration. It represents a VHDL language entity class (entity, label, …).

• Attribute: Represents an attribute declaration.

• AttributeSpecification: Represents an attribute specification.

• Alias: ModelEntity is the base-class for all classes in the VHDL language model, except for mixin classes (see multiple

---

Classes

class pyVHDLModel.Declaration.EntityClass(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

An EntityClass is an enumeration. It represents a VHDL language entity class (entity, label, …).

Inheritance

Entity = 0

Entity

Architecture = 1

Architecture

Configuration = 2

Configuration

Procedure = 3

Procedure

Function = 4

Function

Package = 5

Package

Type = 6

Type

Subtype = 7

Subtype

Constant = 8

Constant

Signal = 9

Signal

Variable = 10

Variable

Component = 11

Component

Label = 12

Label

Literal = 13

Literal

Units = 14

Units

Group = 15

Group

File = 16

File

Property = 17

Property

Sequence = 18

Sequence

View = 19

View

Others = 20

Others

class pyVHDLModel.Declaration.Attribute(identifier, subtype, documentation=None)

Represents an attribute declaration.

Example

attribute TotalBits : natural;

Inheritance

Parameters:

• identifier (str)

• subtype (Symbol)

• documentation (str)

__init__(identifier, subtype, documentation=None)

Initializes a VHDL model entity.

Parameters:

• identifier (str)

• subtype (Symbol)

• 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: 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: ModelEntity

Reference to a parent entity in the model.

class pyVHDLModel.Declaration.AttributeSpecification(identifiers, attribute, entityClass, expression, documentation=None)

Represents an attribute specification.

Example

attribute TotalBits of BusType : subtype is 32;

Inheritance

Parameters:

• identifiers (Iterable[Name])

• attribute (Name)

• entityClass (EntityClass)

• expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)

• documentation (str)

__init__(identifiers, attribute, entityClass, expression, documentation=None)

Initializes a VHDL model entity.

Parameters:

• identifiers (Iterable[Name])

• attribute (Name)

• entityClass (EntityClass)

• expression (BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal)

• documentation (str)

_documentation: Nullable[str]

The associated documentation of a model entity.

property Documentation: str | None

Returns a model entity’s associated documentation.

Returns:

Associated documentation of a model entity.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:

True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:

True, if the class has any method with Attributes.

property Parent: ModelEntity

Returns a reference to the parent entity.

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

class pyVHDLModel.Declaration.Alias(identifier, documentation=None)

Inheritance

Parameters:

• identifier (str)

• 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: 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: ModelEntity

Reference to a parent entity in the model.

__init__(identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• documentation (str)