bool ok = ui::importLef ( const char * libName, const char * lefFileName, bool compressed=false, bool generateLabels=true, float64_t size=0.25. bool allShapes=false, bool metLayers=false)

Import a LEF file.

• libName The library name ot import to. It will be created if it does not already exist.
• lefFileName The name of the LEF file to import.
• compressed If True a gzip compressed format file is expected and will be uncompressed during LEF in.
• generateLabels is true, text labels will be generated on the Text layer for each pin in the LEF macro.
• size Sets the size of the generated labels.
• allShapes If True, then text labels are generated for all pin shapes.
• metLayers If True, the LEF pin tect is created on the pin layer, else it is created on the system TEXT layer.

bool ok = ui::exportLef ( const char * libName, const char * lefFileName, bool technology=true, bool allCells=true, const char *cellName=NULL, const char viewName="abstract", const char * powerNets="", const char * groundNets="", bool separatePorts=false, bool writeNonDefRules=true, int32_t namesCaseSense=1, const char *busBitChars="[]", const char *dividerChar="/")

Export a LEF file.

• libName The library name to export from.
• lefFileName The name of the LEF file.
• technology If True, the LEF technology section will be included in the LEF file.
• allCells is true, all library cells will be output.
• allCells If True, LEF for all cells is exported. If False, LEF for the cell defined by cellName and viewName is output.
• powerNets is a space delimited list of net names. Any pins with a name in this list will have their +USE attribute set to POWER.
• groundNets is a space delimited list of net names. Any pins with a name in this list will have their +USE attribute set to GROUND.
• seperatePorts If True, net shapes will be written as separate PORTs in the LEF.
• writeNonDefRules If True, any non default rules defined in the library will be written.
• namesCaseSense sets the NAMESCASESENSE value in LEF.
  • 0 = no NAMESCASESENSE keyword is written to the LEF.
  • 1 = (the default), NAMESCASESENSE keyword in the LEF has the value ON.
  • 2 = NAMESCASESENSE keyword in the LEF has the value OFF.
• busBitChars defines the bus bit start/end characters. The default is "[]".
• dividerChar defines the divider character; the default is "/".

bool ok = ui::importDef ( const char * libName, const char * viewName, const char * defFileName, bool ecoMode=false, bool compressed=false, bool reportMissingPins=true, bool importSpecial=true, bool importRegular=true, bool reportUnplacedComps=false, bool openTopCell=true, const char *viewList="autoLayout abstract layout", bool generateLabels=false, float64_t labelSize=1.0, bool metLayers=false, bool additionalPurpose=false, const char *purpose="boundary")

Import a DEF file.

• libName The name of a library to import to, which must exist.
• viewName The viewName to use.
• defFileName The name of the DEF file to import. The cellName is determined from the DEF DESIGN keyword
• ecoMode If True then the COMPONENTS and PINS sections only are read, and existing components and pins will have their origin and orientation updated from the DEF file.
• compressed If True a gzip compressed format file is expected and will be uncompressed during DEF in.
• reportMissingPins If True , missing net connections to pins will be reported.
• importSpecial If True then the SPECIALNETS section is imported.
• importRegular If True then the NETS section is imported.
• reportUnplacedComps If True then any components with a placement status of UNPLACED will be reported.
• openTopCell If True , the top cell (the DESIGN in DEF) will be opened.
• viewList is a space delimited string list of views that are used to resolve instance (DEF COMPONENT) masters. When an instance is encountered, a search is made for the a view that matches any of those in the viewList. The first cellView that matches is used.
• generateLabels If True , pin text labels are created for the DEF PINs.
• metLayers If True , the pin labels are created on the same layer as the pin, else the system layer TEXT is used.
• additionalPurpose If True , an additional pin shape is created on the same layer as the pin shape, but with purpose given by purpose.

bool ok = ui::exportDef ( const char * libName, const char * cellName, const char * viewName, const char * defFileName, bool comps=true, bool pins=true, bool regular=true, bool special=true, bool regularRouting=true, bool specialRouting=true)

Export a DEF file.

• libName The library name to export from.
• cellName The cell name to export from.
• viewName The view name to export from.
• comps If True, the COMPONENTS section will be output.
• pins If True, the PINS section will be output.
• regular If True, the NETS section will be output;
• special If True, the SPECIALNETS section will be output.
• regularRouting If True, then routing from the NETS section is output, else just the connectivity.
• specialRouting If True, then routing from the SPECIALNETS section is output, else just the connectivity.

bool ok = ui::importVerilog ( const char * libName, const char * verilogFileName, const char * powerNet, const char * groundNet, const char * flatViewName, bool flatten, const char * topCellName, int16_t hPinLayer, int16_t vPinLayer, double aspect, double utilisation)

Import a Verilog file.

• libName The library name to import into.
• verilogFileName The name of the Verilog file to import. Cells with names matching the verilog module names are created with a view type of netlist.
• powerNet Specifies the supply net used to resolve 1'b1 references.
• groundNet Specifies the ground net used to resolve 1'b0 references.
• flatten If True the Verilog netlist will be flattened into view flatViewName; topCellName is used as the top cell of the design to flatten.
• hPinLayer and vPinLayer are the layer numbers that are used for pins created in the flattened view.
• aspect Is the aspect ratio of the resulting boundary layer created in the flattened view.
• utilisation Sets the area out the boundary layer such that the total cell area divided by the boundary area equals the utilisation.

bool ok = ui::exportVerilog ( const char * libName, const char * cellName, const char * viewName, const char * verilogFileName, bool flatMode=true, const char * switchList="", const char * stopList="")

Export a Verilog file. Currently only a flat verilog netlist is output.

• libName is the library name to export from.
• verilogFileName The name of the verilog file to export.
• cellName The cell name to export.
• viewName The view name to export.

bool ok = ui::importECO (const char * ecoFileName)

Import an ECO file from file ecoFileName into the current open cellView. This function does nothing in non-graphics mode.

bool ok = ui::importOasis( const char * libName, const char * oasisFileName, bool dubiousData=true, bool allowNonPrintingChars=false, bool reportCells=false, bool openTopCell=false, double scale=1.0, double xoffset=0.0, double yoffset=0.0, int32_t csen=0, int32_t duplicates=0, char *viewName="layout", bool verbose=false, bool layer_names=false, bool annotate_nets=false, int32_t net_attr_num=23, bool annotate_devs=false, int32_t dev_attr_num=7, bool annotate_insts=false, int32_t inst_attr_num=102)

Import an OASIS file.

• libName The name of the library to import into. The library is created if it does not already exist.
• oasisFileName The name of the Oasis file to import.
• dubiousData If True, dubious constructs in the Oasis data are reported.
• allowNonPrintingChars If True, non-printing characters will be allowed to be read; normally Oasis only permits printable characters in a-string or n-string types.
• reportCells If True, cells are reported in the message window as they are read.
• openTopCell If True, all potential top cell candidates are opened in the gui. A top cell candidate is any cell that is not referenced by another cell, and is not empty.
• scale allows scaling of all input data by the factor specified.
• xoffset will add the specified offset to all x coordinate data,
• yoffset will add the specified offset to all y coordinate data.
• csen controls case sensitivity, 0 means preserve case, 1 converts to uppercase, 2 to lowercase.
• duplicates controls handling of duplicate cell definitions.
  
  • 0 = duplicate cells replace any existing cell definitions.
  • 1 = duplicate cells definitions are ignored.
  • 2 = duplicate cell data is merged into existing cells.
• viewName sets the view name of cellViews created during import.
• verbose If True, writes verbose messages.
• layer_names If True, writes layer names to the OASIS file if true.
• annotate_netsIf True, annotates net names to shapes if true.
• net_attr_num The net property number for net annotation.
• annotate_devs If True, annotate device names to shapes if true.
• dev_attr_num The device property number for device annotation.
• annotate_insts If True, annotate instance names to insts if true.
• inst_attr_num The instance property number for inst annotation.

bool ok = ui::exportOasis ( const char * libName, const char * viewNames, const char * oasisFileName, bool outputAllCells = true, bool outputChildCells = true, const char * topCellName = NULL, bool strict = false, bool cblock = false, bool cellOfsets = false, bool reportCells = false, double grid=0.005, bool layer_names=false, int32_t output_layer=-1, bool writeSegsAsPaths=true, bool writeViasAsCells=false, bool allowNonPrintingChars=true, int32_t compression=5, bool allowNonOrtho=false, bool writeImplicitRefs=false, bool write_S_BOUNDING_BOX=false)

Export an OASIS file.

• libName The name of the library to export from.
• viewNames All views specified in the space or comma delimited list are output.
• oasisFileName The name of the Oasis file to export.
• outputAllCells If True then all cells in the library are output to the GDS2 file and topCellName is ignored. If False then topCellName is a space or comma delimited list of cells to output.
• strict If True, the OASIS file is written in STRICT mode.
• cblock If True, CBLOCK compression is used which can substantially reduce the output file size.
• cellOfsets If True, in STRICT mode, the property S_CELL_OFFSET is written for each cell in the cellname table so that random access to cells are possible allowing e.g. multithreaded reading of the OASIS file.
• reportCells If True,, cells are reported in the message window as they are written.
• grid Is used when exporting ellipses and is the snap grid for vertices.
• layer_names If true, write layer names to OASIS file.
• output_layer The layer number to write, or -1 for all layers.
• writeSegsAsPaths If true, Write HSeg/VSeg objects as paths. Else will be paths for > 2 vertices, boxes for 2 vertex segs.
• writeViasAsCells If true, Write vias as cells, else flatten vias to shapes.
• allowNonPrintingChars If true, Allow non-printing chars in output OASIS.
• compression The level of shape compression. 0=no compression, 5=maximum compression (default).
• allowNonOrtho If true, Allow non-orthogonal arrays. If false, these arrays will be flattenned.
• writeImplicitRefs If true, Write implicit refs for TEXTSTRINGS, PROPSTRINGS, PROPVALUES, CELLNAMES.
• write_S_BOUNDING_BOX If true, Write cell bounding box info to the OASIS file.

bool ok = ui::importDxf( const char * libName, const char * cellName, const char * dxfFileName, int32_t dbu=1000)

Import a DXF file.

• libName The library to import DXF into. The library is created if it does not already exist.
• cellName The cellName to import into. The viewName is 'layout'
• dxfFileName The name of the DXF file.
• dbu The database units to use.

bool ok = ui::exportDxf( const char * libName, const char * cellName, const char * dxfFileName, bool outputText=true, bool allLayers=true, bool netText=false, float64_t netHeight=1.0)

Export a DXF file.

• libName The library to exort DXF from.
• cellName The cellName to export from. The view name is 'layout'.
• dxfFileName The name of the DXF file.
• outputText If True, then text labels are output.
• allLayers If True, then all layers are output to the DXF file, else only the currently visible layers are output.
• netText If True, net text is written.
• netHeight If specified, the neight of net text is used, else the default 1.0 is used.

bool ok = ui::importCDL( const char * libName, const char * cdlFileName)

Import a CDL file. Note that no attempt is made to create a schematic from this netlist, although the connectivity will be present.

• libName The library to import CDL into.
• cdlFileName The CDL filename.

bool ok = ui::exportCDL( const char * libName, const char *cellname, const char *viewName, const char * cdlFileName, const char *globals, const char *pinOrder="", bool annotateXY=0, bool microns=false, bool rmodel=false, char * rpropname="r", bool cmodel=false, char *cpropname="c", double filterCapLimit=-1.0, bool filterCaps= true, bool mergeCaps=false, bool trueSpice=false, const char *nlpPropName="", const char *busLeft="<", const char *busRight=">")

Export a flat CDL file.

• libName The library to expport from.
• cellName The cellName to export.
• viewName The view name to export.
• ccdlFileName The CDL file name.
• globals is a space delimited list of global net names e.g. "VDD VSS".
• pinOrder is a space delimited list of pin names; if present it will be used as the pin order for the subcircuit.
• annotateXY If True, XY coordinates of instances are written in the CDL file as $X= / $Y= values.
• microns if True, will set the CDL file units to microns, else metres is used.
• rmodel If True, then the resistor model name is reported, else the resistor value (R=...) is reported.
• rpropname is the property that is used to report the resistor value and should be a property of the resistor extraction pcell.
• cmodel and cpropname act similarly for capacitors (but not for parasitic capacitors which are always reported by value).
• filterCaps If True, and a positive filterCapLimit is specified, any parasitic capacitances below this limit (in Farads) will not be written in the CDL file.
• mergeCaps If True, then parasitic caps between net pairs are lumped all togther and reported only once per net pair.
• trueSpice If True, uses true Spice syntax, else an extended syntax is used.
• nlpPropName Is the name of the NLP property controlling instance netlisting.
• busLeft Is the left bus bit character.
• busRight Is the right bus bit character.

ui::schHNLOut( char *libName, char *cellName, char *viewName, char *cdlFileName, char *switchList, char *stopList, char *globals, bool addEnd=false, bool rmodel=false, char * rpropname="r", bool cmodel=false, char *cpropname="c", double filterCapLimit=-1.0, bool filterCaps= true, bool mergeCaps=false, const char *nlpPropName="", const char *busLeft="<", const char *busRight=">", bool writeAsSubckt=true )

Export a hierarchical CDL file.

• libName The name of the library to export from.
• cellName The cellName to export from.
• viewName The name of the view to export from.
• cdlFileName The name of the CDL file to export.
• switchList is a space delimited list of view names the netlister can switch into e.g. "schmatic symbol".
• stopList is a space delimited list of views the netlist can stop on e.g. "symbol", which should have a NLPDeviceFormat string property to describe the netlist format for that cellView.
• globals is a space delimited list of global net names e.g. "vdd vss".
• addEnd If True, a '.end' line is added to the end of the netlist (for Spice correct syntax of a complete netlist).
• rmodel If True, then the resistor model name is reported, else the resistor value (R=...) is reported.
• rpropname is the property that is used to report the resistor value and should be a property of the resistor extraction pcell.
• cmodel and cpropname act similarly for capacitors (but not for parasitic capacitors which are always reported by value).
• filterCaps If True, and a positive filterCapLimit is specified, any parasitic capacitances below this limit (in Farads) will not be written in the CDL file.
• mergeCaps If True,then parasitic caps between net pairs are lumped all togther and reported only once per net pair.
• nlpPropName is the name of the NLP property controlling instance netlisting.
• busLeft is the left bus bit character.
• busRight is the right bus bit character.
• writeAsSubckt If True, writes the CDL as a subckt definition rather than a top level netlist.

bool ok = ui::importDSPF( const char * libName, const char * dspfFileName, const char * netsToRead=NULL, bool saveC = true, bool saveR = true, bool saveI = false, bool overwrite = true, const char *purpose = "net")

Imports a DSPF file.

• libName The library name to import into.
• dspfFileName The name of the DSPF file.
• netsToRead An optional space delimited list of net names to read; if null then all nets are read.
• saveC If True, parasitic capacitors in the DSPF are saved to the db.
• saveR If True, parasitic resistors in the DSPF are saved to the db.
• saveI If True, instances in the DSPF are savved to the db.
• overwrite If True, existing net info is overwitten.
• purpose is the layer purpose that the net shapes in the DSPF are created on.

bool ok = ui::exportDSPF( const char * libName, const char * cellName, const char * viewName, const char * dspfFileName)

Exports a DSPF file.

• libName The library to export from.
• cellName The cell name to export from.
• viewName The view name to export from.
• dspfFileName The name of the DSPF file to export.

bool ok = ui::importEDIF( const char * edifFileName, bool useScale)

Imports a EDIF file.

• edifFileName The name of the EDIF file to import.
• useScale If True, the database units in the EDIF file are used, else the default database units (1000 for layout views, 160 for schematic/symbol views) are used.

bool ok = ui::exportEDIF( const char * libName, const char * cellName, const char * viewName, const char * edifFileName, const char * extLibs)

Exports a EDIF file.

• libName The library to export from.
• cellName The cell name to export from.
• viewName The view name to export from.
• edifFileName The name of the EDIF file to export.
• extLibs Is a space delimited list of external libs to be used as external in the EDIF. If a library referenced by the cellView is not in extLibs, it is written to the EDIF file.

bool ok = ui::importSkill( const char *libName, const char *displayName, const char *skillFileName, uint32_t dbu=1000, bool useMapFile=false, const char *mapFile=NULL)

Imports a Cadence Skill techfile using the new Skill parser.

• libName The name of the library to import the techfile into.
• displayName The display.drf file name.
• skillFileName The Skill techfile name.
• dbu The database units per micron.
• useMapFile If True, the map file mapFile is used to read layer name/purpose to GDS layer/datatype mappings.
• mapFile The name of the GDS map file.

bool ok = ui::importCds( const char * libName, const char * displayName, const char * techFileName, uint32_t dbu=1000, bool useMapFile=false, const char *mapFile=NULL)

Imports a Cadence Skill techfile. Deprecated.

• libName The name of the library to import the techfile into.
• displayName The display.drf file name.
• skillFileName The Skill techfile name.
• dbu The database units per micron.
• useMapFile If True, the map file mapFile is used to read layer name/purpose to GDS layer/datatype mappings.
• mapFile The name of the GDS map file.

bool ok = ui::importLaker( const char *libName, const char *displayName, const char *techName, uint32_t dbu=1000, bool useMapFile=false, const char *mapFile=NULL)

Imports a Laker techfile.

• libName The name of the library to import the techfile into.
• displayName The display.drf file name.
• techName The Laker techfile name.
• dbu The database units per micron.
• useMapFile If True, the map file mapFile is used to read layer name/purpose to GDS layer/datatype mappings.
• mapFile The name of the GDS map file.

bool ok = ui::importHercules( const char *fileName, const char *libName, const char *cellName, const char *viewName)

Imports a Hercules error file.

• fileName The Hercules error marker file.
• libName The library to import error markers into.
• cellName The cell name to import to.
• viewName The view name to import into.

bool ok = ui::importCalibre( const char *fileName, const char *libName, const char *cellName, const char *viewName)

Imports a Calibre error file.

• fileName The Calibre error marker file.
• libName The library to import error markers into.
• cellName The cell name to import to.
• viewName The view name to import into.

bool ok = ui::cdlFlatten( const char *inFile, const char *outFile, const char *topCellName, const char *delimiter="|")

Reads a hierarchical CDL file.

• inFile The hierarchical CDL input file.
• outFile The flattenned CDL output file.
• topCellName The name of the top level subcircuit.
• delimiter The hierarchy delimiter character to use.

ui::scaleCells( cellView *cv, db_Float64 scaleFactor, db_Int32 grid, bool allCells)

> Scale cell(s) hierarchically.

• cv The cellView object of the cell to scale.
• scaleFactor The scale factor to apply to the cell(s).
• grid The snap grid for scaled coordinates.
• allCells If True, all cells in the library will be scaled.

ui::scaleCell( cellView *cv, db_Float64 scaleFactor, db_Int32 grid)

> Scale a cell.

• cv The cellView object of the cell to scale.
• scaleFactor The scale factor to apply to the cell.
• grid The snap grid for scaled coordinates.

ui::biasCells( cellView *cv, int16_t layer, int32_t biasFactor, int32_t grid, int32_t allCells)

Bias cell(s).

• cv The cellView object of the cell(s) to bias.
• layer The techfile layer number of the layer to bias.
• biasFactor The bias factor to apply to the cell.
• grid The snap grid for scaled coordinates.
• allCells If True, all cells in the library will be biassed.

ui::biasCell( cellView *cv, int16_t layer, int32_t biasFactor, int32_t grid)

Bias a cell.

• cv The cellView object of the cell to bias.
• layer The techfile layer number of the layer to bias.
• biasFactor The bias factor to apply to the cell.
• grid The snap grid for scaled coordinates.

ui::zoomIn()

Zoom in according to the current zoomin factor.This function does nothing in non-graphics mode.

ui::zoomIn(int32_t x1, int32_t y1, int32_t x2, int32_t y2)

Zoom in to the area given by x1 y1 x2 y2. This function does nothing in non-graphics mode.

ui::zoomOut()

Zoom out according to the current zoomout factor. This function does nothing in non-graphics mode.

ui::zoomOut (int32_t x1, int32_t y1, int32_t x2, int32_t y2)

Zoom out by the area given by x1 y1 x2 y2. This function does nothing in non-graphics mode.

ui::zoomToNet(const char *netName)

Zoom in to the net netName. This function does nothing in non-graphics mode.

ui::selectArea (int32_t x1, int32_t y1, int32_t x2, int32_t y2, bool add = false)

Select objects in the area given by x1 y1 x2 y2. If add is true, then the objects are added to the selected set. This function does nothing in non-graphics mode.

ui::deselectArea (int32_t x1, int32_t y1, int32_t x2, int32_t y2)

Deselect objects in the area given by x1 y1 x2 y2. This function does nothing in non-graphics mode.

ui::selectAll()

Select all objects in the current canvas cellView. This function does nothing in non-graphics mode.

ui::deselectAll()

Deselect all objects in the current canvas cellView. This function does nothing in non-graphics mode.

ui::selectPoint (int32_t x1, int32_t y1, bool add = false)

Select an object at the coordinate x1 y1. If add is true, then the object is added to the selected set. This function does nothing in non-graphics mode.

ui::deselectPoint (int32_t x1, int32_t y1)

Deselect an object at the coordinate x1 y1. This function does nothing in non-graphics mode.

ui::selectObj(dbObj *obj)

Selects an object. The existing selection list is cleared. This function does nothing in non-graphics mode.

ui::selectObj(net *net)

Selects shapes for the net net. The existing selection list is cleared. This function does nothing in non-graphics mode.

ui::deselectObj(dbObj *obj)

Deselects an object. This function does nothing in non-graphics mode.

ui::deselectObj(net *net)

Deselects shapes for a net net. This function does nothing in non-graphics mode.

ui::addSelected(dbObj *obj)

Adds the object to the selected set. This function does nothing in non-graphics mode.

ui::addSelected(net *net)

Adds the net shapes to the selected set. This function does nothing in non-graphics mode.

dbObjList<dbObj * ui::getSelectedSet()

Returns a dbObjList of the selected set. There is also a top level python binding of the same name that returns a python list of selected objects. This function does nothing in non-graphics mode.

ui::moveSelected(Point delta, orient_t orient)

Moves the selected set by delta, optionally rotating it by orient. This function does nothing in non-graphics mode.

ui::copySelected(Point delta, orient_t orient)

Copies the selected set, moving the copy by delta, optionally rotating it by orient. This function does nothing in non-graphics mode.

ui::addMarker( int32_t x, int32_t y, int32_t size=20, int32_t lineWidth=0, color=Qt::yellow)

Adds a marker at the specified x and y values (given in database units). The size of the marker defaults to 20 dbu and the linewith to 0 (i.e. one pixel wide). This function does nothing in non-graphics mode.

ui::clearMarkers()

Clears all markers. This function does nothing in non-graphics mode.

ui::addHilite(dbHierObj obj, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the dbHierObj obj using the given rgba colour value.

ui::addHilite(dbObj * obj, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the dbObj obj using the given rgba colour value.

ui::addHilite(net obj, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the net obj using the given rgba colour value.

ui::addHilite(const char *name, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the name name using the given rgba colour value.

ui::addHiliteByLayer(const char *name, int16_t lyr, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the name name on layer lyrusing the given rgba colour value.

ui::addHilite(int32_t x1, int32_t y1, int32_t x2, int32_t y2,, uint32_t r, uint32_t g, uint32_t b, uint32_t a=255)

Add a hilite to the rectangle defined by x1,y1,x2,y2 the given rgba colour value.

ui::clearHilites()

Clear all hilites.

ui::hiliteSubNetsByCap(const char *netName, uint32_t a=128)

Hilite subnets of the net netName according to their capacitance.

ui::displayOnlyThisNet(const char *name)

Display only shapes of the named net. All other shapes with net info will be hiddent from the display.

ui::displayAddThisNet(const char *name)

Add shapes of the named net to the display to the show list.

ui::displayHideThisNet(const char *name)

Hide shapes of the named net from the display by removing the net from the show list. Adds the net to the hide list.

ui::displayAllNets()

Show all net shapes. Effectively the show list is cleared.

const char *ui::getDisplayNets()

Get a space delimited list of nets in the show list.

bool ui::isMemberOfDisplayNets(const char *name)

Returns true if net name is a member of the show list.

const char *ui::getHideNets()

Get a space delimited list of nets in the hide list.

bool ui::isMemberOfHideNets(const char *name)

Returns true if net name is a member of the hise list.

ui::updateLibBrowser()

Updates (refreshes) the library browser. This function does nothing in non-graphics mode.

ui::updateLSW()

Updates (refreshes) the LSW. This function does nothing in non-graphics mode.

ok = ui::setLayerVisible(const char *layerName, const char *purpose, bool val)

Returns true if the layer specified by layerName and purpose can be set visible in the current cellView or false if there is no current cellView. This function does nothing in non-graphics mode.

bool ok = ui:isLayerVisible(const char *layerName, const char *purpose)

Returns true if the layer specified by layerName and purpose is visible in the current cellView or false if it is invisible, or there is no current cellView. This function does nothing in non-graphics mode.

ok = ui::setAllVisible(bool val)

Sets all layers visible. This function does nothing in non-graphics mode.

bool ok = ui::setLayerSelectable(const char *layerName, const char *purpose, bool val)

Returns true if the layer specified by layerName and purpose can be set visible in the current cellView or false if there is no current cellView. This function does nothing in non-graphics mode.

bool ok = ui::isLayerSelectable(const char *layerName, const char *purpose)

Returns true if the layer specified by layerName and purpose is selectablein the current cellView or false if it is invisible, or there is no current cellView. This function does nothing in non-graphics mode.

ok = ui::setAllSelectable(bool val)

Sets all layers selectable. This function does nothing in non-graphics mode.

Extending Glade by creating menus / bindkeys etc.

cvar.uiptr

A global pointer to the ui class instanciation in Glade. Use this rather than creating your own ui variable using ui(). For example:

gui=cvar.uiptr gui.OpenCellView("default", "nand", "layout")

Although you can use e.g. ui().<functionName()>, this will not work for commands like createAction() which only work with the existing instanciated ui object.

menu = ui::createMenu(const char *name)

Creates a menu called name in the menu bar

menu = ui::createMenu(QMenu *menu, const char *name)

Creates a submenu called name in menu.

ui::addSeparator(QMenu *menu)

Adds a separator to the menu.

action = ui::createAction(const char *name, const char *cmd)

Creates an action called name with a command cmd. The command should be a valid Python command. An action defines a common command that can be invoked by any or all of a menu item, a bindkey or a toolbar button.

action = ui::createAction(const char *name, const char *cmd, QActionGroup *group)

Creates an action called name with a command cmd that is part of an actionGroup group. The command should be a valid Python command. An action defines a common command that can be invoked by any or all of a menu item, a bindkey or a toolbar button.

actionGroup = ui::createActionGroup()

Create an actionGroup.

ui::createMenuItem(menu, action)

Adds the action to the menu. The action name will be shown on the menu, along with any key binding defined for the action.

ui::setBindKey(action, const char *keysequence)

Sets the bindkey for action. keysequence can be a key e.g. "k" or a combination e.g. "Ctrl+p", "Shift+p", "Alt+p"

icon = ui::createIcon (char *fileName)

Creates an icon from an image file (.png format)

ui::setIcon (QAction *action, const char *fileName)

Sets the icon for an action from the image file (.png format)

ui::setIcon (QAction *action, QIcon *icon)

Sets the icon for an action

toolbar = ui::createToolBar (const char*name)

Creates a tool bar with name name.

ui::createToolBarItem (QToolBar *toolBar, QAction *action)

Adds an action to a toolbar.

ui::addSeparator (QToolBar *toolBar)

Adds a separator to a toolbar.

An example of a python script for setting up a user-defined menu is as follows:

        # define some user function
        def myFunction() :
          print "Hello World!"
  
        gui = cvar.uiptr
        menu = gui.createMenu("MyMenu")
        action=gui.createAction("MyAction", "myFunction()")
        gui.createMenuItem(menu, action)
        gui.setBindKey(action, "!")
        

int32_t ui::traceNet(cellView *cv, Point start, int32_t mode, bool addNetName=false, const char *netName=NULL, const char *libName=NULL, const char *cellName=NULL, const char *viewName=NULL)

Runs the net tracer using the current cellview.

• cv The current cellview object.
• start The start coord Point
• mode Can be one of the following:
• 1 = Trace the net and highlight the resulting traced shapes.
• 2 = Trace the net, and select shapes on the top level only (traced shapes in lower levels of the hierarchy cannot be selected).
• 3 = Trace the net, hightlight the traced shapes, and save the shapes to the cellView given by libName / cellName / viewName. Note the shapes are flattened.
• addNetName If True, and a netName is given, all traced shapes will be assigned that net name.
• netName The net name to assign.
• libName The library name for mode 3.
• cellName The cell name for mode 3.
• viewName The view name for mode 3.

int32_t ui::compareCells( const char *libName1, const char *cellName1, const char *viewName1, const char *libName2, const char *cellName2, const char *viewName2, int16_t compareLayer, bool hier, bool countShapes)

Compares two cellViews using an XOR operation using a simple non-tiled approach. This is good for cells of less than a few thousand transistors/shapes.

• libName1 The library name of the first cellView to compare.
• cellName1 The cell name of the first cellView to compare.
• viewName1 The view name of the first cellView to compare.
• libName2 The library name of the second cellView to compare.
• cellName2 The cell name of the second cellView to compare.
• viewName2 The view name of the second cellView to compare.
• compareLayer The techfile layer number to compare, or -1 for all layers.
• hier If True, compare hierarchically.
• countShapes If True, the number of shapes in both cellviews must match, if False, they can be different (but the XOR result must match).

int32_t val = ui::compareCells2( const char *libName1, const char *cellName1, const char *viewName1, const char *libName2, const char *cellName2, const char *viewName2, int16_T compareLayer, bool hier, bool multiThreaded=1, int32_t maxThreads=QThread::idealThreadCount(), bool tileAuto=1, int32_t tileWidth=1, int32_t tileHeight=1, int16_t outputLayer=TECH_MARKER_LAYER)

Compares two cellViews using a tiled XOR operation.

• libName1 The library name of the first cellView to compare.
• cellName1 The cell name of the first cellView to compare.
• viewName1 The view name of the first cellView to compare.
• libName2 The library name of the second cellView to compare.
• cellName2 The cell name of the second cellView to compare.
• viewName2 The view name of the second cellView to compare.
• compareLayer The techfile layer number to compare, or -1 for all layers.
• hier If True, compare hierarchically.
• multithreaded If True, run multithreaded mode.
• maxThreads The maximum nomber of threads to run concurrently.
• tileAuto If True, use an automatic tiling algorithm to determin the number of tiles.
• tileWidth Set the tile width in non-auto mode, in database units.
• tileHeight Set the tile height in non-auto mode, in database units.
• outputLayer Set the output layer for error shapes.

int32_t val = ui::compareCells3( const char *libName1, const char *cellName1, const char *viewName1, const char *libName2, const char *cellName2, const char *viewName2, const char *libName3, const char *cellName3, const char *viewName3, int16_T compareLayer, bool hier, bool multiThreaded=1, int32_t maxThreads=QThread::idealThreadCount(), bool tileAuto=1, int32_t tileWidth=1, int32_t tileHeight=1, int16_t outputLayer=TECH_MARKER_LAYER)

Compares two cellViews using a tiled XOR operation.

• libName1 The library name of the first cellView to compare.
• cellName1 The cell name of the first cellView to compare.
• viewName1 The view name of the first cellView to compare.
• libName2 The library name of the second cellView to compare.
• cellName2 The cell name of the second cellView to compare.
• viewName2 The view name of the second cellView to compare.
• libName3 The library name of the output cellView.
• cellName3 The cell name of the output cellView.
• viewName3 The view name of the output cellView.
• compareLayer The techfile layer number to compare, or -1 for all layers.
• hier If True, compare hierarchically.
• multithreaded If True, run multithreaded mode.
• maxThreads The maximum nomber of threads to run concurrently.
• tileAuto If True, use an automatic tiling algorithm to determin the number of tiles.
• tileWidth Set the tile width in non-auto mode, in database units.
• tileHeight Set the tile height in non-auto mode, in database units.
• outputLayer Set the output layer for error shapes.

bool ok = ui::booleanOp( const char* libName, const char *cellName, const char *viewName, int32_t opType, int16_t lyr1, int16_t lyr2, int16_t lyr3, bool hier=true, bool outputTraps=false, bool size=false, float64_t sizeBy=1.0)

Performs boolean operations on layer(s) in a cellView.

• libName The library name of the cellView to process.
• cellName The cell name of the cellView to process.
• viewName The view name of the cellView to process.
• opType The operation to perform:
• OP_AND - two layer and
• OP_OR2 - two layer or
• OP_OR1 - single layer or
• OP_NOT2 - two layer not
• OP_NOT1 - single layer not
• OP_XOR - two layer xor
• OP_SIZE
• OP_OVERUNDERSIZE
• OP_SELECTTOUCH
• OP_SELECTOVERLAP
• OP_SELECTABUT
• lyr1 The first layer
• lyr2 The second layer
• lyr3 The output layer
• hier If True, performs hierarchically; all input is flattenned before processing.
• outputTraps If True, outputs shapes as trapezoids, else outputs polygons potnetially with holes/cutlines.
• size If True, size output shapes using the sizeBy> value.
• sizeBy Size factor if size> is set, in microns.

bool ok = ui::booleanOp( const char* libName1, const char *cellName1, const char *viewName1, const char* libName2, const char *cellName2, const char *viewName2, const char* libName3, const char *cellName3, const char *viewName3, int32_t opType, int16_t lyr1, int16_t lyr2, int16_t lyr3, bool hier=true, bool outputTraps=false, bool size=false, float64_t sizeBy=1.0)

Performs boolean operations on layer(s) between two cellviews, outputting to a third.

• libName1 The library name of the first cellView to process.
• cellName1 The cell name of the first cellView to process.
• viewName1 The view name of the first cellView to process.
• libName2 The library name of the second cellView to process.
• cellName2 The cell name of the second cellView to process.
• viewName2 The view name of the seconf cellView to process.
• libName3 The library name of the output cellView.
• cellName3 The cell name of the output cellView.
• viewName3 The view name of the output cellView.
• opType The operation to perform:
• OP_AND - two layer and
• OP_OR2 - two layer or
• OP_OR1 - single layer or
• OP_NOT2 - two layer not
• OP_NOT1 - single layer not
• OP_XOR - two layer xor
• OP_SIZE
• OP_OVERUNDERSIZE
• OP_SELECTTOUCH
• OP_SELECTOVERLAP
• OP_SELECTABUT
• lyr1 The first layer
• lyr2 The second layer
• lyr3 The output layer
• hier If True, performs hierarchically; all input is flattenned before processing.
• outputTraps If True, outputs shapes as trapezoids, else outputs polygons potnetially with holes/cutlines.
• size If True, size output shapes using the sizeBy> value.
• sizeBy Size factor if size> is set, in microns.

bool ok = ui::tiledBooleanOp( const char* libName, const char *cellName, const char *viewName, int32_t opType, int16_t lyr1, int16_t lyr2, int16_t lyr3, bool hier=true, bool outputTraps=false, bool size=false, float64_t sizeBy=1.0, bool multiThreaded=true, int32_t maxThreads=QThread::idealThreadCount(), bool tileAuto=true, float64_t tileWidth=1, float64_t tileHeight=1)

Performs tiled boolean operations on layer(s) in a cellView.

• libName The library name of the cellView to process.
• cellName The cell name of the cellView to process.
• viewName The view name of the cellView to process.
• opType The operation to perform:
• OP_AND - two layer and
• OP_OR2 - two layer or
• OP_OR1 - single layer or
• OP_NOT2 - two layer not
• OP_NOT1 - single layer not
• OP_XOR - two layer xor
• OP_SIZE
• OP_OVERUNDERSIZE
• OP_SELECTTOUCH
• OP_SELECTOVERLAP
• OP_SELECTABUT
• lyr1 The first layer
• lyr2 The second layer
• lyr3 The output layer
• hier If True, performs hierarchically; all input is flattenned before processing.
• outputTraps If True, outputs shapes as trapezoids, else outputs polygons potnetially with holes/cutlines.
• size If True, size output shapes using the sizeBy> value.
• sizeBy Size factor if size> is set, in microns.
• multithreaded If True, run multithreaded mode.
• maxThreads The maximum nomber of threads to run concurrently.
• tileAuto If True, use an automatic tiling algorithm to determin the number of tiles.
• tileWidth Set the tile width in non-auto mode, in database units.
• tileHeight Set the tile height in non-auto mode, in database units.

bool ok = ui::tiledBooleanOp( const char* libName1, const char *cellName1, const char *viewName1, const char* libName2, const char *cellName2, const char *viewName2, const char* libName3, const char *cellName3, const char *viewName3, int32_t opType, int16_t lyr1, int16_t lyr2, int16_t lyr3, bool hier=true, bool outputTraps=false, bool size=false, float64_t sizeBy=1.0, bool multiThreaded=true, int32_t maxThreads=QThread::idealThreadCount(), bool tileAuto=true, float64_t tileWidth=1, float64_t tileHeight=1)

Performs tiled boolean operations on layer(s) between two cellviews, outputting to a third.

• libName1 The library name of the first cellView to process.
• cellName1 The cell name of the first cellView to process.
• viewName1 The view name of the first cellView to process.
• libName2 The library name of the second cellView to process.
• cellName2 The cell name of the second cellView to process.
• viewName2 The view name of the seconf cellView to process.
• libName3 The library name of the output cellView.
• cellName3 The cell name of the output cellView.
• viewName3 The view name of the output cellView.
• opType The operation to perform:
• OP_AND - two layer and
• OP_OR2 - two layer or
• OP_OR1 - single layer or
• OP_NOT2 - two layer not
• OP_NOT1 - single layer not
• OP_XOR - two layer xor
• OP_SIZE
• OP_OVERUNDERSIZE
• OP_SELECTTOUCH
• OP_SELECTOVERLAP
• OP_SELECTABUT
• lyr1 The first layer
• lyr2 The second layer
• lyr3 The output layer
• hier If True, performs hierarchically; all input is flattenned before processing.
• outputTraps If True, outputs shapes as trapezoids, else outputs polygons potnetially with holes/cutlines.
• size If True, size output shapes using the sizeBy> value.
• sizeBy Size factor if size> is set, in microns.
• multithreaded If True, run multithreaded mode.
• maxThreads The maximum nomber of threads to run concurrently.
• tileAuto If True, use an automatic tiling algorithm to determin the number of tiles.
• tileWidth Set the tile width in non-auto mode, in database units.
• tileHeight Set the tile height in non-auto mode, in database units.

bool val = ui::runLVS( const char *libName, const char *cellName, const char *viewName, const char *netlist, const char *globalNets=NULL, const char *workDir= ".", bool isHierNetList=false, const char *delimiter= "/", const char *topCellName=NULL, bool checkDeviceProps=false, bool collapseLikeSized= false, bool noCollapseFingered= false, bool noCollapseChains= false, bool warnChains= false, bool caseFoldNets= false, bool noLocalMatching= false, bool noOptLabelling= false, bool matchProperties=false, bool matchPorts=false, bool warnZeroNets= false, bool verbose= false, const char *errorLimit= NULL, const const char *netSizeLimit= NULL, const char *progressLimit= NULL, const char *suspectNodeLimit= NULL, double Tolerance=10.0 , const char *equivInFileName= NULL, const char *equivOutFileName= NULL)

Runs LVS, comparing the cellview given by libName/cellName/viewName, which should be an extracted cellView, against the Spice/CDL netlist given by netlist.

• libName The library name.
• cellname The cell name.
• viewName The view name.
• netlist> The name of the CDL netlist to compare with the cellView.
• globalNets A string list of global net names e.g. "vdd vss"
• workDir A directory name used for temporary files.
• isHierNetlist If True, the netlist is assumed hierarchical and will be flattenned before comparison.
• delimiter The hierarchy delimier character used if flattening the netlist.
• topCellName The name of the top subcircuit in the netlist if flattening.
• checkDeviceProps If True, device properties e.g. W, L are checked according to Tolerance.
• collapseLikeSized If True, collapse like sized MOS devices.
• noCollapseFingered If True, do not collapse fingered MOS devices.
• noCollapseChains If True, do not collapse chains.
• warnChains If True, warn device chains.
• caseFoldNets If True use case folding on nets.
• noLocalMatching If True, do not use local matching.
• noOptLabelling If True, do not optimise labelling.
• matchProperties If True, match device properties.
• matchPorts If True, match ports (pins)
• warnZeroNets If True, warn nets with no connections.
• verbose If true, use verbose mode.
• errorLimit Set error limit.
• netSizeLimit Set net size limit.
• progressLimit Set progress limit.
• suspectNodeLimit Set suspect node limit.
• Tolerance Set matching tolerance.
• equivInFileName Set equivalent node input file name.
• equivOutFileName Set equivalent node output file name.

int32_t errors = ui::schCheck(char *libName, char *cellName, char *viewName, bool snapLabels, float64_t snapDist)

Check a schematic cellView. errors is the number of errors found, or -1 if the cell could not be checked. If snapLabels is true, labels within snapDist of a wire will be snapped to the wire.

int32_t errors = ui::symCheck(char *libName, char *cellName, char *viewName, bool snapLabels, float64_t snapDist)

Check a symbol cellView. errors is the number of errors found, or -1 if the cell could not be checked.

line = ui::routeWire(Point start, Point stop, char *netName=null, float64_t wrongWayCost=2.0, float64_t blockageCost=4.0)

Routes a line on the wire layer from start to stop, avoiding obstacles (symbols and parallel collinear wires). If the route is successful, returns the line object created, or None if failed. If netName is specified, then the line is assigned that net name.

bool ok = ui::createCellView(char *libName, char *cellName, char *viewName, int32_t shape=0, int32_t pinSize=4, float64_t snapGrid=0.0625)

Create a symbol cellView from the given cellView (normally a schematic). Returns true if successful. The symbol outline can be set by shape, and can be 0 (rectangular), 1 (triangular) or 2 (circular). pinSize sets the pi size in database units. snapGrid sets the snapping grid of the generated shapes

ui::deleteCell(const char *libName, const char *cellName, const char *viewName)

Delete the cell specified by libName, cellName and viewName.This function does nothing in non-graphics mode.

ui::renameCell(const char *libName, const char *cellName, const char *viewName)

Rename the cell specified by libName, cellName and viewName. A dialog will be displayed prompting for the new cell name. This function does nothing in non-graphics mode.

ui::copyCell(const char *libName, const char *cellName, const char *viewName)

Copy the cell specified by libName, cellName and viewName. A dialog will be displayed prompting for the new cell name. This function does nothing in non-graphics mode.

ui::properties(const char *libName, const char *cellName, const char *viewName)

Display the properties of the cell specified by libName, cellName and viewName. This function does nothing in non-graphics mode.

Contents|Index

Copyright © Peardrop Design 2026.