pyGHDL.dom.Subprogram

Classes

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

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

---

Classes

class pyGHDL.dom.Subprogram.Function(node, functionName, returnType, genericItems=None, parameterItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• functionName (str) –

• returnType (Union[Subtype, SubtypeSymbol]) –

• genericItems (List[GenericInterfaceItem]) –

• parameterItems (List[ParameterInterfaceItem]) –

• documentation (str) –

__init__(node, functionName, returnType, genericItems=None, parameterItems=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• functionName (str) –

• returnType (Union[Subtype, SubtypeSymbol]) –

• genericItems (List[GenericInterfaceItem]) –

• parameterItems (List[ParameterInterfaceItem]) –

• 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.Subprogram.Procedure(node, procedureName, genericItems=None, parameterItems=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• procedureName (str) –

• genericItems (List[GenericInterfaceItem]) –

• parameterItems (List[ParameterInterfaceItem]) –

• documentation (str) –

__init__(node, procedureName, genericItems=None, parameterItems=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• procedureName (str) –

• genericItems (Optional[List[GenericInterfaceItem]]) –

• parameterItems (Optional[List[ParameterInterfaceItem]]) –

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