luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify layer parameters in doc.

This commit is contained in:
Matthias Koefferlein 2026-08-06 21:26:18 +02:00
parent 87060b4364
commit d7a41b860d
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/doc/doc/programming/ruby_pcells.xml
View File

@ -288,12 +288,21 @@ end</pre>
</p>
<ul>
<li><tt>l, set_l, l_layer</tt>: getter and setter for the current value of "l". l_layer is the layer index in the context
<li><tt>l, set_l, l_layer</tt>: getter and setter for the current value of "l". "l_layer" is the layer index in the context
of the PCell production method. The layer index can be used to access the layer in the layout or cell.</li>
<li><tt>s, set_s</tt>: getter and setter for the current value of "s".</li>
<li><tt>r, set_r, n, set_n, ru, set_ru</tt>: same for "r", "n" and "ru".</li>
</ul>
<p>
Layer parameters are "optional" is a sense that the value can always be set to "empty" by the user.
"Empty" layers have a <class_doc href="LayerInfo"/> value that is "anonymous". In general it
is a good idea to check production code for an anonymous layer info and skip shape generation
in that case. Empty layers can be present if a PCell is freshly initialized or the layer is
not yet given by the user. A PCell should behave nicely in that case and not empty any polygons
to a non-existing layer.
</p>
<p>
After the PCell initialization is finished, we can start with the production code. These are the methods
that KLayout will call on certain opportunities. The first method that a PCell must implement is the