pyGHDL.dom.Names

Classes

• SimpleName: A simple name is a name made from a single word.

• ParenthesisName: Name is the base-class for all names in the VHDL language model.

• IndexedName: Name is the base-class for all names in the VHDL language model.

• SlicedName: Name is the base-class for all names in the VHDL language model.

• SelectedName: A selected name is a name made from multiple words separated by a dot (.).

• AttributeName: Name is the base-class for all names in the VHDL language model.

• AllName: The all name represents the reserved word all used in names.

• OpenName: The open name represents the reserved word open.

---

Classes

class pyGHDL.dom.Names.SimpleName(node, identifier)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

__init__(node, identifier)

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.Names.ParenthesisName(node, prefix, associations)

Inheritance

Parameters:

• node (Iir) –

• prefix (Name) –

• associations (List) –

__init__(node, prefix, associations)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• prefix (Name) –

• associations (List) –

_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.Names.IndexedName(node, identifier)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

__init__(node, identifier)

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.

class pyGHDL.dom.Names.SlicedName(node, identifier)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

__init__(node, identifier)

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.

class pyGHDL.dom.Names.SelectedName(node, identifier, prefix)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• prefix (Name) –

__init__(node, identifier, prefix)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifier (str) –

• prefix (Name) –

_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.Names.AttributeName(node, identifier, prefix)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• prefix (Name) –

__init__(node, identifier, prefix)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifier (str) –

• prefix (Name) –

_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.Names.AllName(node, prefix)

Inheritance

Parameters:

• node (Iir) –

• prefix (Name) –

__init__(node, prefix)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• prefix (Name) –

_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.Names.OpenName(node)

Inheritance

Parameters:

node (Iir) –

__init__(node)

Initializes a VHDL model entity.

Parameters:

node (Iir) –

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