pyGHDL.dom.Object

Classes

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

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

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

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

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

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

---

Classes

class pyGHDL.dom.Object.Constant(node, identifiers, subtype, defaultExpression, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

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

• documentation (str) –

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

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• 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.Object.DeferredConstant(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.

class pyGHDL.dom.Object.Variable(node, identifiers, subtype, defaultExpression, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

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

• documentation (str) –

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

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• 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.Object.SharedVariable(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.

class pyGHDL.dom.Object.Signal(node, identifiers, subtype, defaultExpression, documentation=None)

Inheritance

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• subtype (Union[Subtype, SubtypeSymbol]) –

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

• documentation (str) –

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

Initializes a VHDL model entity.

Parameters:

• node (Iir) –

• identifiers (List[str]) –

• 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.Object.File(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.