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

Polishing doc.

This commit is contained in:
Matthias Koefferlein 2026-05-02 00:29:07 +02:00
parent 0728feba33
commit d8016a9446
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/db/db/gsiDeclDbCell.cc
View File

@ -3272,20 +3272,20 @@ Class<db::Cell> decl_Cell ("db", "Cell",
) +
gsi::method_ext ("is_cold_proxy?", &is_cold_proxy,
"@brief Returns true, if the cell is a 'cold proxy'\n"
"Cold proxies are cells that refer to a library but can temporarily not be resolved -\n"
"Cold proxies are cells that refer to a library cell or PCell variant, but can temporarily not be resolved -\n"
"for example, because the library is not installed. Such cells are basically placeholders\n"
"for library references and also carry PCell parameter information needed to establish\n"
"the link to the library cell again, once the library is available again.\n"
"the link to the library PCell, once the library is available again.\n"
"\n"
"You can use \\library_name to obtain the library name the proxy points to, "
"You can use \\library_name to obtain the name of the library the proxy points to, "
"\\library_cell_name to obtain the cell name in that library, "
"\\pcell_name to obtain the PCell name if it is a PCell proxy, "
"and \\pcell_parameters_by_name to obtain the PCell parameters.\n"
"and \\pcell_parameter or \\pcell_parameters_by_name to obtain the PCell parameters.\n"
"\n"
"Cold proxies cannot be created or modified. Cold proxies are basically error indicators "
"and should be fixed by installing the respective library. Their layout state\n"
"reflects the last version of the layout when the cell was functional and properly\n"
"linked to a library. Correspondingly, they can be used in read-only applications.\n"
"linked to a library. Still, they can be used in read-only applications.\n"
"\n"
"This method has been introduced in version 0.30.9.\n"
) +
@ -3323,6 +3323,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"If the cell is not imported from a library, the return value is an empty string.\n"
"This method is basically a convenience function, equivalent to taking the name\n"
"from \\library and \\library_cell_index.\n"
"Note that for PCells, 'library_cell_name' is the name of the PCell proxy cell inside "
"the library, not the name of the PCell.\n"
"\n"
"However, this method also works for 'cold proxies' (see \\is_cold_proxy?)\n"
"for which it delivers the name of cell inside the (missing) library.\n"