diff --git a/src/lay/lay/doc/manual/lvs_device_extractors.xml b/src/lay/lay/doc/manual/lvs_device_extractors.xml index b6fdbe30a..2c43ca6d3 100644 --- a/src/lay/lay/doc/manual/lvs_device_extractors.xml +++ b/src/lay/lay/doc/manual/lvs_device_extractors.xml @@ -3,9 +3,9 @@ - LVS Devices Extractors + LVS Device Extractors - + @@ -345,5 +345,32 @@ extract_devices(bjt3(model_name), { "C" => collector, "B" => base, "E" => emitte

+

Device extractors and device classes

+ +

+ "extract_devices" will return the DeviceClass object of the devices generated. + This object can be useful to apply some basic modifications. + The most important of them is enabling or disabling certain parameters. +

+ +

+ Most device extractors extract more parameters than they give you by default. + For example, the resitor extractor will not just extract the resistance, but also the length (L) + and width (W) of the resistor stripe and its area (A) and perimeter (P). + By default these additional parameters are declared "secondary" - i.e. they will not + show up in the netlist browser, they will not participate in the device compare and + will not be netlisted. +

+ +

+ Parameters can be declared primary ones by using "enable_parameter" on the device class. + Hence it is possible to enable "W" and "L" on a resistor type using the following code: +

+ +
dc = extract_devices(resistor("RES", 1), ...)
+dc.enable_parameter("W", true)
+dc.enable_parameter("L", true)
+
+