pyGHDL.dom.InterfaceItem

Classes

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

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

• GenericPackageInterfaceItem: A GenericInterfaceItem is a mixin class for all generic interface items.

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

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

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

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

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

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

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

---

Classes

class pyGHDL.dom.InterfaceItem.GenericConstantInterfaceItem(node, identifiers, mode, subtype, defaultExpression, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

• documentation (str) –

__init__(node, identifiers, mode, subtype, defaultExpression, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

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

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.GenericTypeInterfaceItem(node, identifier, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• documentation (str) –

__init__(node, identifier, documentation=None)

Initializes underlying BaseType.

Parameters:

• identifier (str) – Name of the type.

• node (Iir) –

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

class pyGHDL.dom.InterfaceItem.GenericPackageInterfaceItem(node, name, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• name (str) –

• documentation (str) –

__init__(node, name, documentation=None)

Initializes a documented entity.

Parameters:

• documentation (Optional[str]) – Documentation of a model entity.

• node (Iir) –

• name (str) –

property Documentation: Optional[str]

Returns a model entity’s associated documentation.

Return type:

Optional[str]

Returns:

Associated documentation of a model entity.

_documentation: Optional[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.GenericProcedureInterfaceItem(node, identifier, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• documentation (str) –

__init__(node, identifier, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifier (str) –

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

class pyGHDL.dom.InterfaceItem.GenericFunctionInterfaceItem(node, identifier, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifier (str) –

• documentation (str) –

__init__(node, identifier, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifier (str) –

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

class pyGHDL.dom.InterfaceItem.PortSignalInterfaceItem(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

• documentation (str) –

__init__(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

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

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.ParameterConstantInterfaceItem(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

• documentation (str) –

__init__(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

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

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.ParameterVariableInterfaceItem(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

• documentation (str) –

__init__(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

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

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.ParameterSignalInterfaceItem(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

• documentation (str) –

__init__(node, identifiers, mode, subtype, defaultExpression=None, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• mode (Mode) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• defaultExpression (Union[BaseExpression, QualifiedExpression, FunctionCall, TypeConversion, Constant, ConstantSymbol, Variable, VariableSymbol, Signal, SignalSymbol, Literal]) –

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

_documentation: Nullable[str]

The associated documentation of a model entity.

class pyGHDL.dom.InterfaceItem.ParameterFileInterfaceItem(node, identifiers, subtype, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

• documentation (str) –

__init__(node, identifiers, subtype, documentation=None)

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[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 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.

_documentation: Nullable[str]

The associated documentation of a model entity.