`pyGHDL.dom.Symbol`#

Classes

LibraryReferenceSymbol: A library reference in a library clause.
PackageReferenceSymbol: A package reference in a use clause.
PackageMembersReferenceSymbol: A package member reference in a use clause.
AllPackageMembersReferenceSymbol: A package reference in a use clause.
ContextReferenceSymbol: A context reference in a context clause.
EntityInstantiationSymbol: An entity reference in a direct entity instantiation.
ComponentInstantiationSymbol: A component reference in a component instantiation.
ConfigurationInstantiationSymbol: A configuration reference in a configuration instantiation.
EntitySymbol: An entity reference in an architecture declaration.
ArchitectureSymbol: An entity reference in an entity instantiation with architecture name.
PackageSymbol: A package reference in a package body declaration.
SimpleSubtypeSymbol: A configuration reference in a configuration instantiation.
ConstrainedScalarSubtypeSymbol: A configuration reference in a configuration instantiation.
ConstrainedCompositeSubtypeSymbol: A configuration reference in a configuration instantiation.
SimpleObjectOrFunctionCallSymbol: A configuration reference in a configuration instantiation.
IndexedObjectOrFunctionCallSymbol: A configuration reference in a configuration instantiation.

Classes

class pyGHDL.dom.Symbol.LibraryReferenceSymbol(identifierNode, identifier)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –

__init__(identifierNode, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.PackageReferenceSymbol(identifierNode, identifier, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

__init__(identifierNode, identifier, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: LibraryReferenceSymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.PackageMembersReferenceSymbol(identifierNode, identifier, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (PackageReferenceSymbol) –

__init__(identifierNode, identifier, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (PackageReferenceSymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: PackageReferenceSymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.AllPackageMembersReferenceSymbol(identifierNode, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
prefix (PackageReferenceSymbol) –

__init__(identifierNode, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
prefix (PackageReferenceSymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: PackageReferenceSymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ContextReferenceSymbol(identifierNode, identifier, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

__init__(identifierNode, identifier, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: LibraryReferenceSymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.EntityInstantiationSymbol(identifierNode, identifier, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

__init__(identifierNode, identifier, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (LibraryReferenceSymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: LibraryReferenceSymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ComponentInstantiationSymbol(identifierNode, identifier)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –

__init__(identifierNode, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ConfigurationInstantiationSymbol(identifierNode, identifier)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –

__init__(identifierNode, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.EntitySymbol(identifierNode, identifier)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –

__init__(identifierNode, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ArchitectureSymbol(identifierNode, identifier, prefix)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (EntitySymbol) –

__init__(identifierNode, identifier, prefix)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –
prefix (EntitySymbol) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: EntitySymbol#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#

Return str(self).

Return type:: str

class pyGHDL.dom.Symbol.PackageSymbol(identifierNode, identifier)[source]#

Inheritance

Parameters:

identifierNode (Iir) –
identifier (str) –

__init__(identifierNode, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

identifierNode (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.SimpleSubtypeSymbol(node, subtypeName)[source]#

Inheritance

Parameters:

node (Iir) –
subtypeName (str) –

__init__(node, subtypeName)[source]#

Initializes a VHDL model entity.

Parameters:

node (Iir) –
subtypeName (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ConstrainedScalarSubtypeSymbol(node, subtypeName, rng=None)[source]#

Inheritance

Parameters:

node (Iir) –
subtypeName (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
rng (Range) –

__init__(node, subtypeName, rng=None)[source]#

Initializes a VHDL model entity.

Parameters:

node (Iir) –
subtypeName (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
rng (Range | None) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.ConstrainedCompositeSubtypeSymbol(node, subtypeName, constraints=None)[source]#

Inheritance

Parameters:

node (Iir) –
subtypeName (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
constraints (List) –

__init__(node, subtypeName, constraints=None)[source]#

Initializes a VHDL model entity.

Parameters:

node (Iir) –
subtypeName (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
constraints (List | None) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.SimpleObjectOrFunctionCallSymbol(node, identifier)[source]#

Inheritance

Parameters:

node (Iir) –
identifier (str) –

__init__(node, identifier)[source]#

Initializes a VHDL model entity.

Parameters:

node (Iir) –
identifier (str) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#: Return str(self).

class pyGHDL.dom.Symbol.IndexedObjectOrFunctionCallSymbol(node, prefix, indices)[source]#

Inheritance

Parameters:

node (Iir) –
prefix (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
indices (Iterable[BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal]) –

__init__(node, prefix, indices)[source]#

Initializes a VHDL model entity.

Parameters:

node (Iir) –
prefix (<module 'pyVHDLModel.Name' from '/usr/local/lib/python3.9/dist-packages/pyVHDLModel/Name.py'>) –
indices (Iterable[BaseExpression | QualifiedExpression | FunctionCall | TypeConversion | Literal]) –

_parent: ModelEntity#: Reference to a parent entity in the model.

property HasPrefix: bool#

Returns true, if the name has a prefix.

This is true for all names except simple names.

Returns:: True, if the name as a prefix.

property Identifier: str#

The identifier the name is referencing.

Returns:: The referenced identifier.

property NormalizedIdentifier: str#

The normalized identifier the name is referencing.

Returns:: The referenced identifier (normalized).

property Parent: ModelEntity#

Returns a reference to the parent entity.

Returns:: Parent entity.

property Prefix: Name | None#

The name’s prefix in a chain of names.

Returns:: The name left from current name, if not a simple name, otherwise None.

property Root: Name#

The root (left-most) element in a chain of names.

In case the name is a simple name, the root points to the name itself.

Returns:: The name’s root element.

__str__()#

Return str(self).

Return type:: str

pyGHDL.dom.Symbol#

`pyGHDL.dom.Symbol`#