Please enable JavaScript to view this site.

Knowledge Base

Gets a property from objects with a given name.

 

If multiple objects are selected, and the values are different, the smallest value is returned. To be certain of the results, be sure that only one object is selected, or use the form of getnamed that allows a specific object to be selected.

 

Supported Product: FDTD, MODE, DEVICE, INTERCONNECT

 

Syntax

Description

?getnamed("name");

Returns a list of the properties of the objects called name.

out = getnamed("name", "property");

The same as get, but acts on objects with a specific name, instead of selected objects.

out=getnamed("name", "property", i);

Gets the property of the ith named object. Use this to act on a series of objects.

The objects are ordered by their location in the object tree. The uppermost selected object is given the index 1, and the index numbers increase as you go down the tree.

out = getnamed("groupname::name", "property");

The same as get, but acts on objects named "name" located in the group "groupname", instead of selected objects.

out = getnamed("groupname::name", "property");

Gets the property of the ith object named "name" located in the group "groupname". Use this to act on a series of objects.

The objects are ordered by their location in the object tree. The uppermost selected object is given the index 1, and the index numbers increase as you go down the tree.

 

Examples

This example uses the get command to get the x span of an object named substrate.

addrect;

set("name","substrate");

setnamed("substrate","x span",2e-6); 

x_span = getnamed("substrate","x span"); 

?x_span;

result: 

2e-006  

 

Add 2 microns to the radius of all selected objects named circle.

for (i=1:getnamednumber("circle")) {

 rad=getnamed("circle","radius",i);

 setnamed("circle","radius",rad+2e-6,i);

}

 

 

 

See Also

Manipulating objects, get, getnumber, getnamednumber, set, setnamed

Copyright Lumerical Inc. | Privacy | Site Map