HorizontalWavePortProperty#

class pyedb.grpc.database.inner.layout_obj.HorizontalWavePortProperty#

Represents the properties of a horizontal wave port.

This class encapsulates configuration settings for horizontal wave ports used in electromagnetic simulations. It stores port characteristics such as type, geometry (arms), and associated port names (padstack instances).

Attributes:
port_typestr

The type of port. Default is “Pad Port”.

armsint

The number of arms for the port structure. Default is 2.

hfss_last_typeint

The last HFSS type identifier. Default is 8.

port_namestuple[str, …]

Tuple of port/via names (padstack instance names) associated with this property. Can contain multiple via names (e.g., positive and negative vias). Default is an empty tuple.

horizontal_wave_primarybool

Whether this is a primary horizontal wave port. Default is False.

is_gap_sourcebool

Whether the port is a gap source. Default is True.

Overview#

to_property_string

Convert HorizontalWavePortProperty instance into an interpretable property string.

port_type

arms

hfss_last_type

port_names

horizontal_wave_primary

is_gap_source

Import detail#

from pyedb.grpc.database.inner.layout_obj import HorizontalWavePortProperty

Attribute detail#

HorizontalWavePortProperty.port_type: str = 'Pad Port'#
HorizontalWavePortProperty.arms: int = 2#
HorizontalWavePortProperty.hfss_last_type: int = 8#
HorizontalWavePortProperty.port_names: tuple[str, Ellipsis] = ()#
HorizontalWavePortProperty.horizontal_wave_primary: bool = False#
HorizontalWavePortProperty.is_gap_source: bool = True#

Method detail#

HorizontalWavePortProperty.to_property_string() → str#

Convert HorizontalWavePortProperty instance into an interpretable property string.

Generates a formatted string representation of the horizontal wave port properties, including all port names (padstack instances) as a comma-separated list within the HorizWavePort(…) section.

Returns:
str

A formatted property string with all attributes encoded, suitable for storage or transmission.