create_edge_port#

Hfss3dLayout.create_edge_port(primivitivename: str | Line3dLayout, edgenumber: int, iscircuit: bool = False, iswave: bool = False, wave_horizontal_extension: float = 5, wave_vertical_extension: float = 3, wave_launcher: str = '1mm', ref_primitive_name: str = None, ref_edge_number: str | int = 0) → BoundaryObject3dLayout | bool[source]#

Create an edge port.

Parameters:
primivitivenamestr or pyaedt.modeler.pcb.object3dlayout.Line3dLayout

Name of the primitive to create the edge port on.

edgenumber

Edge number to create the edge port on.

iscircuitbool, optional

Whether the edge port is a circuit port. The default is False.

iswavebool, optional

Whether the edge port is a wave port. The default is False.

wave_horizontal_extensionfloat, optional

Horizontal port extension factor. The default is 5.

wave_vertical_extensionfloat, optional

Vertical port extension factor. The default is 5.

wave_launcherstr, optional

PEC (perfect electrical conductor) launcher size with units. The default is “1mm”.

ref_primitive_namestr, optional

Name of the reference primitive to place negative edge port terminal. The default is None.

ref_edge_numberstr, int

Edge number of reference primitive. The default is 0.

Returns:
pyaedt.modules.Boundary.BoundaryObject3dLayout

Port objcet port when successful, False when failed.

References

>>> oEditor.CreateEdgePort