Class Reference setup

A static class for any global setup. More...

Member

void addNetlistNotUseDatatype(int datatype)
double apLamda
bool autoDisableUnusedLayers
bool autoStoreLayerSetup
int autosaveTime
string autostartMacro
stringList autostartMacroTrigger
stringList callbackPath
void checkNetlistSetup(string type)
void clearNetlistNotUseDatatype()
bool cifSaveCircle
bool cifTopCell
double circularDefault
string csvFieldDelimiter
void dataClear(string name)
void dataClearAll()
string dataGet(string name)
void dataStore(string name, string value)
int defaultBezierIteration
int defaultPathCap
int defaultPathWidth
bool defaultPolygonFixSelfintersectingPolygons
bool defaultPolygonRemoveNotNeededPoints
int defaultShapeConstraint
int defaultTextPresentation
int defaultTextWidth
stringList defSpecialnets
string defExtra
int depthOfCellrefs
bool displayCellName
bool displayCellOrigin
bool displayCells
int displayCellSingleLayer
bool displayText
int dsnBoundaryLayer
string dsnKeepoutLayer
bool dxfSaveArc
bool dxfSaveCircle
double dxfUnits
int epsEndOfLine
double epsScale
string font
int fontIteration
int fontSize
bool fullLicense()
intList getNetlistNotUseDatatype()
bool gdsAutoMapDatatypes
bool gdsBoxToPolygon
bool gdsMapLayer
int gdsMaxPoints
bool gdsMultiXYRecord
bool gdsOnlyStoreEnabledLayer
bool gdsPad2048
bool gdsPathToPolygon
bool gdsStoreLayerNames
bool gdsTextToPolygon
int gdsTextToPolygonDefaultWidth
bool gdsValidate
bool gerberInverseShapesOnOtherLayer
bool gerberSaveArc
bool gerberSaveCircle
bool gerberSaveOptimize
string getNetlistFormat(string type)
string getNetlistSubFormat(string type)
string getNetlistSubModelFormat(string type)
bool ignoreTextTrans
int layerDockStyle
int lefCellBoundaryLayer
int lefPitchHorizontal
int lefPitchVertical
string lefExtra
stringList macroPath
stringList model3dPath
int mouseView
bool netlistAutotrigger
bool netlistExtractAllAsDevice
stringList netlistFormats()
string netlistGlobalNodes
bool netListImportVhdlUpperNames
tatic bool netListImportUseComponentLibrary
string netlistUnnamedNodes
bool oasisAutoMapDatatypes
bool oasisMapLayer
bool oasisOnlyStoreEnabledLayer
bool oasisSaveCBlock
bool oasisSaveCircle
bool oasisSaveCtrapezoid
bool oasisSaveTrapezoid
double offUnits
string openAccessPyCell
int paintEngine
double pcbSolderClearance
double pcbCreamClearance
int pixelColorBits
int pixelDither
bool pixelInvert
int pixelLayerMap
int pixelMethod
double pixelMinSize
int pixelResolution
int pixelSteps
bool placeModeForPCB
double povUnits
string pythonSuffix
void resetToolbars()
bool scrollDirection
void set(string parameter,string value)
void setBackgroundColor(int red, int green, int blue)
tatic void setBusColor(int red, int green, int blue)
void setDeviceColor(int red, int green, int blue)
void setGridColor(int red, int green, int blue)
void setHighlightBrush(int brush)
void setHighlightColor(int red, int green, int blue)
void setInstanceColor(int red, int green, int blue)
void setLicense(string license)
void setMouseColor(int red, int green, int blue)
void setNetlistFormat(string type, string value)
void setNetlistSubFormat(string type, string value)
void setNetlistSubModelFormat(string type, string value)
void setPinColor(int red, int green, int blue)
void setSelectColor(int red, int green, int blue)
void setTextColor(int red, int green, int blue)
void setWireColor(int red, int green, int blue)
void setZeroColor(int red, int green, int blue)
bool showGrid
bool showMenuIcons
bool showPlacementsPorts
int showReport
bool showScale
bool showSnap
double sourceDatabase
double stlUnits
int svgEndOfLine
double tldLamda
bool updateCheck
void useOaVersion(string)
bool wheelDirection
bool whiteBackground()
string macroDirectory
string openAccessCallbackPath

Detailed Description

In this cell you can modify the basic setup.

Example:

setup::showGrid=false;

Alternative you can call the ''set'' method to modify any value. The ''set'' method is the preferred method in the LayoutEditor for Python as a Python bug limit the access to static class variables.

Example:

setup::set("defaultPathWidth","0");

Member Function Documentation


static void setup::addNetlistNotUseDatatype(int datatype)

Add ''datatype'' the the list of datatypes, which are ignored in the BuildConnections feature.


static double setup::apLamda

Lamda value for the preview of the Alliance physical format.


static bool setup::autoDisableUnusedLayers

If true, all layers not used in the current design are disabled atfer a loading


static bool setup::autoStoreLayerSetup

If true, layer setting will be save to disc on shutdown of the LayoutEditor and restored on program start.


static int setup::autosaveTime

After this time in minutes any design (layout and schematic) is saved to the temporary system folder as backup. The store is only performed if the design was modified. Set this value to 0 to disable this feature.


static string setup::autostartMacro

A file name of a macro is named which is executed automaticly after program start. If the string a empty no auto start macro will be called. For more details please see the [[SetupDialog#Autostart_Macro|setup dialog]]


static stringList setup::autostartMacroTrigger

A list of triggers that will start the autostartMacro. Available triggers are:

Trigger: Feature:
layoutStart after start of the LayoutEditor, this event will not be triggered if also the layoutNew event is enabled
layoutNew opening a new layout window
layoutOpen after opening a deisng in the layout window

This feature was introduced with release 20180420.


static stringList setup::callbackPath

holds the pathes where callback macros and tcl callbacks for the [[iPDK]] are searched.


static void setup::checkNetlistSetup(string type)

It checks if a setup for the given netlist type exists. If not or if the setup is empty the default setting is used for the setup of this netlist type. The default setup can be adjusted with the setup::setNetlistFormat command or with the SetupDialog. Please see NetlistGeneration for more details on generating netlists.


static void setup::clearNetlistNotUseDatatype()

Clears the list of datatypes, which are ignored inthe BuildConnections feature.


static bool setup::cifSaveCircle

If true, regular polygon are saved as circle in cif files.


static bool setup::cifTopCell

of the design. If more than one top cell exists, the top cell with the most shapes is used. Some CIF viewer need this option to avoid a warnings.


static double setup::circularDefault

The angle pro point for conversion of circles to polygons.


static string setup::csvFieldDelimiter

Field delimiter for the csv file format import/export.


static void setup::dataClear(string name)

Remove the entry ''name'' from the user data.


static void setup::dataClearAll()

Removes all entries from the user data.


static string setup::dataGet(string name)

Returns: the user data for name


static void setup::dataStore(string name, string value)

User specific data for name is stored. The data will be stored with the setup data of the LayoutEditor and will be available after a restart of the LayoutEditor. Although the data size has no limitations, it is intended for a small amount of data.


static int setup::defaultBezierIteration

The iteration depth of bezier elements. The number of additional points can be calculated by (2^defaultBezierIteration)-1.


static int setup::defaultPathCap

The default cap of path elements.

Value Cap
0 flat ended caps
1 round caps
2 square ended caps

static int setup::defaultPathWidth

The default width of path elements.


static bool setup::defaultPolygonFixSelfintersectingPolygons

Selfintersecting polygons (polygons where two boaderlines cross) are fixed automaticly.


static bool setup::defaultPolygonRemoveNotNeededPoints

Points which have no effect in a polygon are removed. e.g. three point in a line, the middle point is removed.


static int setup::defaultShapeConstraint

Angle limitation for creating new shapes:

Values:
0 all angle
1 fine angles (5°)
2 45°
3 90°

static int setup::defaultTextPresentation

The default text presentation of new created text element.

Value: Alignment:
0 top/left
1 top/horizontal center
2 top/right
4 vertical centered/left
5 centered
6 vertical centered/right
8 bottom/left
9 bottom/horizontal center
10 bottom/right

static int setup::defaultTextWidth

The default width of text elements.


static stringList setup::defSpecialnets

net names to be stored under specialnets section instead of the net section in the DEF file. This setting will be be stored after program shut-down.


static string setup::defExtra

Extra information store in the DEF file. This setting will be be stored after program shut-down.


static int setup::depthOfCellrefs

The reference depth of the displayed cells. If is set to 0, all cellref are displayed.


static bool setup::displayCellName

If true, the name of the cells are display in cellrefs.


static bool setup::displayCellOrigin

If true, the origin of cell ref will be displayed.


static bool setup::displayCells

If true, the complete cells are display in cellrefs.


static int setup::displayCellSingleLayer

If the to a positive layer, cellrefs are only display with this layer number. Any negative value will disable this feature and all layers of the cellrefs are displayed. (introduced with version 20180429)


static bool setup::displayText

If true, text elements will be displayed. Otherwise all text elements are rendered as a dot only.


static int setup::dsnBoundaryLayer

Layer used for board bounder in DSN output.


static string setup::dsnKeepoutLayer

Comma separated list of all layers with keepout area in DSN output. The keep out area will be used for all signal layers.


static bool setup::dxfSaveArc

If true, DXF arcs and bulge value are stored instead of the points of the arc.


static bool setup::dxfSaveCircle

If true, regular polygon are saved as circle in dxf files.


static double setup::dxfUnits

unit in meter used for reading/writing of DXF files. A value of 0 uses the user units instead.


static int setup::epsEndOfLine

Character use for EOF in PS/EPS format: 0 for LFCR, 1 for LF


static double setup::epsScale

Additional scaling for PS/EPS files.


static string setup::font

Path and file of the fontfile for text to polygon conversion


static int setup::fontIteration

The iteration depth of bezier elements in fonts for convertion to polygons. The number of additional points can be calculated by (2^defaultBezierIteration)-1.


static int setup::fontSize

size in pixel of documenting text in the drawing, e.g. ruler text, etc.


static bool setup::fullLicense()

Returns: true, if a full license is installed. Otherwise false.


static intList setup::getNetlistNotUseDatatype()

Returns: a list with all datatype which are ignored in the BuildConnections feature.


static bool setup::gdsAutoMapDatatypes

If true, any layer/datatype combination in a gds file is maped to an other layer


static bool setup::gdsBoxToPolygon

If true, all boxes are saved as polygons


static bool setup::gdsMapLayer

If true, the layers are mapped during GDSII file load/file save.


static int setup::gdsMaxPoints

The maximal number of points for polygons and path elements can be set. If elements have more points, they are splited during the gds save into two or more elements. The technical limit of the GDS file format is 8191. In early GDS versions this number was limited to 200 points.


static bool setup::gdsMultiXYRecord

The gds file format is limited to 8191 point per record. So polygons are limited to the number of points as well. As a workaround it is possible to save multi record for the points. This is not part of the gds standard, but supported by some viewers. If false, all poygons are splitted into a couple of polygon to store all information.


static bool setup::gdsOnlyStoreEnabledLayer

If true, shapes on disabled layers are not saved to GDSII.


static bool setup::gdsPad2048

If true, the length of stored gds files is extended to N*2048 Bytes by add 0 to the end of the file. Some tape storages and old system may need this opention to handle the files.


static bool setup::gdsPathToPolygon

If true, all path elements with a width bigger than 0 are stored as polygons in GDSII files.


static bool setup::gdsStoreLayerNames

If true, an additional cell LayerNames is created with the current layer setup during file save. On file load this cell is processed, the layer setup made accordingly and the cell is removed. This layer storage is not part of the GDS standard.


static bool setup::gdsTextToPolygon

If true, all text elements are saved as polygons. The current design is converted as well. gdsTextToPolygonDefaultWidth is used for scale independent text elements. For details see below.


static int setup::gdsTextToPolygonDefaultWidth

If gdsTextToPolygon is true, this value is used for scale independent text elements. If it is 0, scale independent text elements are not converted.


static bool setup::gdsValidate

If gdsValidate is true, a validation on any store GDSII file is made. Also a sha1 checksum is stored next to any GDSII file.


static bool setup::gerberInverseShapesOnOtherLayer

If true shapes with negative polarity will be stored on a different layer. If false a boolean operation will be performaed between shapes with positive and negative polarity.


static bool setup::gerberSaveArc

If true pathes are checked for arcs. These arcs will be saved with circular interpolation.


static bool setup::gerberSaveCircle

If true, regular polygon are saved as circle in gerber files.


static bool setup::gerberSaveOptimize

If true, gerber files are optimized to a minimal non exposure length.

string setup::getLibDefsFilename()

Returns: the filename of the main lib.defs file with all OpenAccess Libraries (introduced with release 20180614)


static string setup::getNetlistFormat(string type)

Returns: the description of the netlistformat


static string setup::getNetlistSubFormat(string type)

Returns: the description of hierarchical components in the netlist


static string setup::getNetlistSubModelFormat(string type)

Returns: the description of hierarchical components in the model section of netlist


static bool setup::ignoreTextTrans

If true, any text is displayed non rotate and non mirror for a optimal readability.


static int setup::layerDockStyle

style of the layer dock, 0 for automatic


static int setup::lefCellBoundaryLayer

Layer on which nominal bounding box of the cell will be added. In LEF file the nominal bounding box must not be identical with the real box dimensions.


static int setup::lefPitchHorizontal

horizontal pitch of the LEF file. This setting will be be stored after program shut-down.


static int setup::lefPitchVertical

vertical pitch of the LEF file. This setting will be be stored after program shut-down.


static string setup::lefExtra

Extra information store in the LEF file. This setting will be be stored after program shut-down.


static stringList setup::macroPath

A list of paths is set containing the macro tree to be added to the main menu.


static stringList setup::model3dPath

holds the pathes where models for the 3d view are searched.


static int setup::mouseView

The type of the mouse in the drawing windows can be set:

Value Mouse
0 single point
1 litle cross
2 cross over drawing
3 dual cross

static bool setup::netlistAutotrigger

If true, netlist are automatically extracted after any modification of the design.

See also: Autotrigger of building Connections/Netlists


static bool setup::netlistExtractAllAsDevice

If true, extracted netlists will contain any connected cell reference as a netlist device. If false only cell refereneces with type information/devicename will be added as a device to a netlist.


static stringList setup::netlistFormats()

Returns: a list with all defined netlist formats


static string setup::netlistGlobalNodes

Regular expression for nodes, which should be defected as global.


static bool setup::netListImportVhdlUpperNames

Any device type name and node name is converted to upper characters while importing netlists from structual VHDL files.


tatic bool setup::netListImportUseComponentLibrary

The component library from the schematic is used as well to match imported devices.


static string setup::netlistUnnamedNodes

Prefix for node names, if not named via the text element.


static bool setup::oasisAutoMapDatatypes

If true, any layer/datatype combination in a oasis file is maped to an other layer


static bool setup::oasisMapLayer

If true, the layers are mapped during OASIS file load/file save.


static bool setup::oasisOnlyStoreEnabledLayer

If true, disabled layers are not saved to GDSII


static bool setup::oasisSaveCBlock

If true, compressed blocks are used to write oasis files


static bool setup::oasisSaveCircle

If true, regular polygon are saved as circle in oasis files.


static bool setup::oasisSaveCtrapezoid

If true, suitable polygon are saved as ctrapezoid in oasis files.

See also: using Ctrapezoids/Trapezoids


static bool setup::oasisSaveTrapezoid

If true, suitable polygon are saved as trapezoid in oasis files.


static double setup::offUnits

unit in meter used for reading/writing of OFF files. A value of 0 uses the user units instead.


static string setup::openAccessPyCell

if not empty, it will be search at this path for an OpenAccess PyCell plugin on startup of the LayoutEditor. If found the correct openAccess version is choosen for this installation. If set it is to CNI_ROOT ,the enviourment variable is used. Any modification of this value will take effective with the next restart. This feature was introduced with version 20180420.


static int setup::paintEngine

The paint engine defines how the elements are displayed on the screen. Modifications will take affect after program restart.

value engine
0 overlay: Elements are drawn over each other.
1 transparent: Elements are semi transparent.
2 stacked: Elements are painted in the order as used for the 3D view (using layer.level3d).

static double setup::pcbSolderClearance

Value used for the solder mask clearance in all file format for PCB not explicite naming this value (e.g. Eagle, KiCad).


static double setup::pcbCreamClearance

Value used for the solder cream clearance in all file format for PCB not explicite naming this value (e.g. Eagle, KiCad).


static int setup::pixelColorBits

For pixel import method map colors to layers ' only: The color resolution for pixel import can be set with this value. Values from 1 to 8 bit are possible. A value of 4 bit equals (2^4 )^ 3 = 4096 colors. Lower value will result in a better performance. Higher value in a better quality.


static int setup::pixelDither

For pixel import method grey scale with dithering only:

Sets the used dithering method: 0 Floyd-Steinberg Dithering, 1 Jarvis, Judice, and Ninke Dithering, 2 Sierra Dithering (introduced with release 20181108)


static bool setup::pixelInvert

For pixel import method grey scale with dithering only: Set whether black or white collor is used for background/pixel.


static int setup::pixelLayerMap

For pixel import method map colors to layers only: If a pixel file is imported, boxes are added to the layer with the closest color to the original pixel color. By activating this option all layer colors above the entered value are adapted for a optimal display. Set to -1 to disable any adaption.


static int setup::pixelMethod

Set the method used for the pixel image import. Two methods are available:

  • 0 for ''map colors to layers''
  • 1 for ''grey scale with dithering''

static double setup::pixelMinSize

'''For pixel import method ''grey scale with dithering'' only:''' The relative size to the pixel size of the smallest allowed shape.


static int setup::pixelResolution

The resolution for pixel export in pixel per meter.


static int setup::pixelSteps

For pixel import method grey scale with dithering only: Number of sizes for shapes.


static bool setup::placeModeForPCB

If true the place feature will will in PCB mode. In that mode a mirrored placing is not possible. Instead the component will be placed on the bottom off the PCB. The layers of the refered cell will be mapped.


static double setup::povUnits

unit in meter used for reading/writing of POV files. A value of 0 uses the user units instead.


static string setup::pythonSuffix

Postfix of the used python command. For example if you want to use python3.5, set this value to ''3.5''. (Linux and Mac only, no effect on Windows).


static void setup::resetToolbars()

Sets the toolbars to the default position after the next restart.


static bool setup::scrollDirection

scroll direction of the arrow key can be changed if this value is set to true


static void setup::set(string parameter,string value)

Sets the parameter of the setup class to value. This method is a workaround for some python installation which fails to set static variables and should be used for python macros only.


static void setup::setBackgroundColor(int red, int green, int blue)

The bachground color is set.

Parameter:
red red channel
green green channel
blue blue channel

tatic void setup::setBusColor(int red, int green, int blue)

The wirecolor for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setDeviceColor(int red, int green, int blue)

The default device color for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setGridColor(int red, int green, int blue)

The gridcolor is set. The gridpoint are painted in this color.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setHighlightBrush(int brush)

The highlightbrush is set. The same brushes as for layer are possible.


static void setup::setHighlightColor(int red, int green, int blue)

The highlightcolor is set. The highlichtcolor is used in the select and deselect modes to highlight the element/point to be selected with a mouse click.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setInstanceColor(int red, int green, int blue)

The default instance color for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setLicense(string license)

Installs a license key.


static void setup::setMouseColor(int red, int green, int blue)

The mousecolor is set. The mousepoint is painted in this color.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setNetlistFormat(string type, string value)

Sets the decription of the netlistformat of type. Please see NetlistGeneration for details on netlist generation.


static void setup::setNetlistSubFormat(string type, string value)

sets the decription of hierarchical components in the netlist will be defined.


static void setup::setNetlistSubModelFormat(string type, string value)

sets the decription of hierarchical components in the model section of netlist will be defined.


static void setup::setPinColor(int red, int green, int blue)

The default pin color for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setSelectColor(int red, int green, int blue)

The selectcolor is set. All select element/points are painted in this color.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setTextColor(int red, int green, int blue)

The default text color for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setWireColor(int red, int green, int blue)

The wirecolor for the schematic is set.

Parameter:
red red channel
green green channel
blue blue channel

static void setup::setZeroColor(int red, int green, int blue)

The zerocolor is set. In the zerocolor the zeropoint of the coordinatessystem is painted.

Parameter:
red red channel
green green channel
blue blue channel

static bool setup::showGrid

If true, a grid is painted in the drawing.


static bool setup::showMenuIcons

If true, icon are shown next the menu entries.


static bool setup::showPlacementsPorts

If true, the port names in the SchematicEditor are always displayed . If false the port names are only displayed with the mouse pointeron the component.


static int setup::showReport

Situation when a report is shown automaticly.

value show report on
-1 never
0 fatal error
1 error
2 strong warnings
3 warnings
4 information
5 always

static bool setup::showScale

If true, a scale is painted in the drawing.


static bool setup::showSnap

If true, a small symbol is display next to the mouse cusor in case a snapping was made. (introduced with release 20180503)


static double setup::sourceDatabase

Database units for the source format


static double setup::stlUnits

unit in meter used for reading/writing of STL files. A value of 0 uses the user units instead.


static int setup::svgEndOfLine

Character use for EOF in SVG format: 0 for LFCR, 1 for LF


static double setup::tldLamda

Conversionfactor, if tld/tlc file are saved in lamda values. Value in µm.


static bool setup::updateCheck

enables regular checks for updates


static void setup::useOaVersion(string)

Sets the OpenAccess plugin to be used. It had to be called with before creating the first window. The string mus contain the OpenAccess version number without any prefix like setup.useOaVersion("22.50"). This feature will have no effect in LayoutEditor macros. There the OpenAccess version to be specified as parameter on program start.


static bool setup::wheelDirection

mouse wheel direction for zooming can be changed by this value.


static bool setup::whiteBackground()

Return: true, if the background is set to white or almost white. Otherwise false is returned.

Obsolete Members


static string setup::macroDirectory

OBSOLETE

The path is set containing the macro tree to be added to the main menu.


static string setup::openAccessCallbackPath

'''OBSOLETE'''<
> holds the relative path where callback macros and tcl callbacks for the iPDK are searched. Multi pathes are separated with a :. this method can only used for read out. To set the callback path, please use setup::callbackPath.