pyGHDL.dom.Attribute

Classes

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

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


Classes

class pyGHDL.dom.Attribute.Attribute(node, identifier, subtype, documentation=None)[source]

Inheritance

Inheritance diagram of Attribute

Parameters:
  • node (Iir) –

  • identifier (str) –

  • subtype (Union[Subtype, SubtypeSymbol]) –

  • documentation (str) –

__init__(node, identifier, subtype, documentation=None)[source]

Initializes a VHDL model entity.

Parameters:
  • node (Iir) –

  • identifier (str) –

  • subtype (Union[Subtype, SubtypeSymbol]) –

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

class pyGHDL.dom.Attribute.AttributeSpecification(node, identifiers, attribute, entityClass, expression, documentation=None)[source]

Inheritance

Inheritance diagram of AttributeSpecification

Parameters:
  • node (Iir) –

  • identifiers (List[Name]) –

  • attribute (Name) –

  • entityClass (EntityClass) –

  • expression (<module 'pyGHDL.dom.Expression' from '/src/pyGHDL/dom/Expression.py'>) –

  • documentation (str) –

__init__(node, identifiers, attribute, entityClass, expression, documentation=None)[source]

Initializes a VHDL model entity.

Parameters:
  • node (Iir) –

  • identifiers (List[Name]) –

  • attribute (Name) –

  • entityClass (EntityClass) –

  • expression (<module 'pyGHDL.dom.Expression' from '/src/pyGHDL/dom/Expression.py'>) –

  • documentation (Optional[str]) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation 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.

_documentation: Nullable[str]

The associated documentation of a model entity.