getAllSelectedObjects

MODE.getAllSelectedObjects()

Returns a list of all currently selected simulation objects.

Parameters:

None

Returns:

list [ansys.lumerical.core.SimObject]

A list consisting of ansys.lumerical.core.SimObject objects.

See also

getObjectById()

Returns a simulation object by ID.

getObjectBySelection()

Returns the currently selected simulation object.

Examples

>>> fdtd = lumapi.FDTD()
>>> z_placements = [0, 1e-6, 2e-6, 3e-6]
>>> for i,position in enumerate(z_placements):
>>>     fdtd.addrect(name = f"Rect{i}", z=position)
>>> fdtd.selectpartial("Rect") #Selects all objects with “Rect” as a part of its name
>>> objList = fdtd.getAllSelectedObjects() #A list of object is returned here
>>> for obj in objList:
>>>     print(f"Rectangle name: {obj['name']}, z position: {obj['z']} \n")

Returns

>>> Rectangle name: Rect0, z position: 0.0 
>>> Rectangle name: Rect1, z position: 1e-06
>>> Rectangle name: Rect2, z position: 2e-06
>>> Rectangle name: Rect3, z position: 3e-06