pyGHDL.dom.Type

Classes

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

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

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

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

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

---

Classes

class pyGHDL.dom.Type.IncompleteType(node, identifier)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

__init__(node, identifier)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.EnumeratedType(node, identifier, literals)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• literals (List[EnumerationLiteral]) –

__init__(node, identifier, literals)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• literals (List[EnumerationLiteral]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.IntegerType(node, typeName, rng)

Inheritance

Parameters:

• node (Iir) –

• typeName (str) –

• rng (Union[Range, Name]) –

__init__(node, typeName, rng)

Initializes underlying BaseType.

Parameters:

• identifier – Name of the type.

• node (Iir) –

• typeName (str) –

• rng (Union[Range, Name]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.PhysicalType(node, typeName, rng, primaryUnit, units)

Inheritance

Parameters:

• node (Iir) –

• typeName (str) –

• rng (Union[Range, Name]) –

• primaryUnit (str) –

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

__init__(node, typeName, rng, primaryUnit, units)

Initializes underlying BaseType.

Parameters:

• identifier – Name of the type.

• node (Iir) –

• typeName (str) –

• rng (Union[Range, Name]) –

• primaryUnit (str) –

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

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.ArrayType(node, identifier, indices, elementSubtype)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• indices (List) –

• elementSubtype (Union[Subtype, SubtypeSymbol]) –

__init__(node, identifier, indices, elementSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• indices (List) –

• elementSubtype (Union[Subtype, SubtypeSymbol]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.RecordTypeElement(node, identifiers, subtype)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

__init__(node, identifiers, subtype)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

property Identifiers: Tuple[str]

Returns a model entity’s tuple of identifiers (names).

Return type:

Tuple[str]

Returns:

Tuple of identifiers.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifiers: Tuple[str]

A list of identifiers.

class pyGHDL.dom.Type.RecordType(node, identifier, elements=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• elements (List[RecordTypeElement]) –

__init__(node, identifier, elements=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• elements (Optional[List[RecordTypeElement]]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.ProtectedType(node, identifier, methods=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• methods (Union[List, Iterator]) –

__init__(node, identifier, methods=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• methods (Optional[Union[List, Iterator]]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.ProtectedTypeBody(node, identifier, declaredItems=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• declaredItems (Union[List, Iterator]) –

__init__(node, identifier, declaredItems=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• declaredItems (Optional[Union[List, Iterator]]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.AccessType(node, identifier, designatedSubtype)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• designatedSubtype (Union[Subtype, SubtypeSymbol]) –

__init__(node, identifier, designatedSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• designatedSubtype (Union[Subtype, SubtypeSymbol]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.FileType(node, identifier, designatedSubtype)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• designatedSubtype (Union[Subtype, SubtypeSymbol]) –

__init__(node, identifier, designatedSubtype)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

• designatedSubtype (Union[Subtype, SubtypeSymbol]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.Type.Subtype(node, subtypeName)

Inheritance

Parameters:

• node (Iir) –

• subtypeName (str) –

__init__(node, subtypeName)

Initializes underlying BaseType.

Parameters:

• identifier – Name of the type.

• node (Iir) –

• subtypeName (str) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

property Identifier: str

Returns a model entity’s identifier (name).

Return type:

str

Returns:

Name of a model entity.

property Parent: ModelEntity

Returns a reference to the parent entity.

Return type:

ModelEntity

Returns:

Parent entity.

_parent: ModelEntity

Reference to a parent entity in the model.

_identifier: str

The identifier of a model entity.

_documentation: Nullable[str]

The associated documentation of a model entity.