the fair gds editor MacroClassSetup
Please Sign in

Setup Class Reference

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

See also: List of Classes


Member

  1. addNetlistNotUseDatatype(int datatype)
  2. apLamda
  3. autoDisableUnusedLayers
  4. autoStoreLayerSetup
  5. autosaveTime
  6. autostartMacro
  7. callbackPath
  8. checkNetlistSetup(string type)
  9. clearNetlistNotUseDatatype()
  10. cifSaveCircle
  11. cifTopCell
  12. circularDefault
  13. csvFieldDelimiter
  14. dataClear(string name)
  15. dataClearAll()
  16. dataGet(string name)
  17. dataStore(string name, string value)
  18. defaultBezierIteration
  19. defaultPathCap
  20. defaultPathWidth
  21. defaultPolygonFixSelfintersectingPolygons
  22. defaultPolygonRemoveNotNeededPoints
  23. defaultShapeConstraint
  24. defaultTextPresentation
  25. defaultTextWidth
  26. defSpecialnets
  27. defExtra
  28. depthOfCellrefs
  29. displayCellName
  30. displayCellOrigin
  31. displayCells
  32. displayText
  33. dsnBoundaryLayer
  34. dsnKeepoutLayer
  35. dxfSaveArc
  36. dxfSaveCircle
  37. dxfUnits
  38. epsEndOfLine
  39. epsScale
  40. font
  41. fontIteration
  42. fontSize
  43. fullLicense()
  44. getNetlistNotUseDatatype()
  45. gdsAutoMapDatatypes
  46. gdsBoxToPolygon
  47. gdsMapLayer
  48. gdsMaxPoints
  49. gdsMultiXYRecord
  50. gdsOnlyStoreEnabledLayer
  51. gdsPad2048
  52. gdsPathToPolygon
  53. gdsStoreLayerNames
  54. gdsTextToPolygon
  55. gdsTextToPolygonDefaultWidth
  56. gdsValidate
  57. gerberInverseShapesOnOtherLayer
  58. gerberSaveArc
  59. gerberSaveCircle
  60. gerberSaveOptimize
  61. getNetlistFormat(string type)
  62. getNetlistSubFormat(string type)
  63. getNetlistSubModelFormat(string type)
  64. ignoreTextTrans
  65. layerDockStyle
  66. lefCellBoundaryLayer
  67. lefPitchHorizontal
  68. lefPitchVertical
  69. lefExtra
  70. macroDirectory
  71. macroPath
  72. model3dPath
  73. mouseView
  74. netlistAutotrigger
  75. netlistExtractAllAsDevice
  76. netlistFormats()
  77. netlistGlobalNodes
  78. netListImportVhdlUpperNames
  79. netListImportUseComponentLibrary
  80. netlistUnnamedNodes
  81. oasisAutoMapDatatypes
  82. oasisMapLayer
  83. oasisOnlyStoreEnabledLayer
  84. oasisSaveCBlock
  85. oasisSaveCircle
  86. oasisSaveCtrapezoid
  87. oasisSaveTrapezoid
  88. offUnits
  89. openAccessCallbackPath
  90. paintEngine
  91. pcbSolderClearance
  92. pcbCreamClearance
  93. pixelColorBits
  94. pixelInvert
  95. pixelLayerMap
  96. pixelMethod
  97. pixelMinSize
  98. pixelResolution
  99. pixelSteps
  100. placeModeForPCB
  101. povUnits
  102. pythonSuffix
  103. resetToolbars()
  104. scrollDirection
  105. set(string parameter,string value)
  106. setBackgroundColor(int red, int green, int blue)
  107. setBusColor(int red, int green, int blue)
  108. setDeviceColor(int red, int green, int blue)
  109. setGridColor(int red, int green, int blue)
  110. setHighlightBrush(int brush)
  111. setHighlightColor(int red, int green, int blue)
  112. setInstanceColor(int red, int green, int blue)
  113. setLicense(string license)
  114. setMouseColor(int red, int green, int blue)
  115. setNetlistFormat(string type, string value)
  116. setNetlistSubFormat(string type, string value)
  117. setNetlistSubModelFormat(string type, string value)
  118. setPinColor(int red, int green, int blue)
  119. setSelectColor(int red, int green, int blue)
  120. setTextColor(int red, int green, int blue)
  121. setWireColor(int red, int green, int blue)
  122. setZeroColor(int red, int green, int blue)
  123. showGrid
  124. showMenuIcons
  125. showPlacementsPorts
  126. showReport
  127. showScale
  128. sourceDatabase
  129. stlUnits
  130. svgEndOfLine
  131. tldLamda
  132. updateCheck
  133. useOaVersion(string)
  134. wheelDirection

Detailed Description

In this cell you can modify the basic setup.

Example:

   1 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:

   1 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. (introduced with version 20150421)

static double setup::apLamda

Lamda value for the preview of the Alliance physical format.

See also: Fileformat Alliance

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. (introduced with version 20170517)

bool setup::static bool autoStoreLayerSetup;

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. (introduced with version 20150619)

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. (introduced with version 20141015) For more details please see the setup dialog

static stringList setup::callbackPath

holds the pathes where callback macros and tcl callbacks for the iPDK are searched. (introduced with version 20160102)

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. (introduced with version 20141015) Please see NetlistGeneration for more details on generating netlists.

static void setup::clearNetlistNotUseDatatype()

Clears the list of datatypes, which are ignored inthe BuildConnections feature.(introduced with version 20150421)

static bool setup::cifSaveCircle

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

See also: CIF: save regular polygon as circle

static bool setup::cifTopCell

If true, one top cell is marked as the main cell 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.

See also: Setup Angle Resolution

static string setup::csvFieldDelimiter

Field delimiter for the csv file format import/export.

See also: Fileformat CSV

static void setup::dataClear(string name)

Remove the entry name from the user data. (introduced with version 20160401)

static void setup::dataClearAll()

Removes all entries from the user data (introduced with version 20160401)

static string setup::dataGet(string name)

Returns: the user data for name (introduced with version 20160401)

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. (introduced with version 20160401)

static int setup::defaultBezierIteration

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

See also: Setup Bezier Iteration

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.

See also: Path Defaults

static bool setup::defaultPolygonFixSelfintersectingPolygons

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

See also: Selfintersecting Polygons

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.

See also: Not needed Points

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 presentation of text elements

value

position

0

left aligned

1

horizontal center

2

right aligned

4

bottom

8

vertical centered

16

top

static int setup::defaultTextWidth

The default width of text elements.

See also: Text Defaults

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. (introduced with version 20160601)

static string setup::defExtra

Extra information store in the DEF file. This setting will be be stored after program shut-down. (introduced with version 20160601)

static int setup::depthOfCellrefs

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

See also: View Cellrefs

static bool setup::displayCellName

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

See also: View 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 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. (introduced with version 20150228)

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. (introduced with version 20150228)

static bool setup::dxfSaveArc

If true, DXF arcs and bulge value are stored instead of the points of the arc. (introduced with version 20160118)

static bool setup::dxfSaveCircle

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

See also: [[DXF|DXF: save regular polygon as circle]

static double setup::dxfUnits

unit in meter used for reading/writing of DXF files. A value of 0 uses the user units instead. (introduced with version 20130904)

static int setup::epsEndOfLine

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

See also: Fileformat EPS

static double setup::epsScale

Additional scaling for PS/EPS files.

See also: Fileformat EPS

static string setup::font

Path and file of the fontfile for text to polygon conversion

See also: Setup Font

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.

See also: Setup Font

static int setup::fontSize

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

See also: Setup Font

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. (introduced with version 20150421)

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

See also: Save Box as Polygon

static bool setup::gdsMapLayer

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

See also: Handling of Layers in GDS II

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.

See also: Set Maximal Number of Points in Polygons

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.

See also: Multi XY Records

static bool setup::gdsOnlyStoreEnabledLayer

If true, shapes on disabled layers are not saved to GDSII. (introduced with version 20120824)

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.

See also: Padding the Filesize to N*2048

static bool setup::gdsPathToPolygon

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

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.

See also: Save Text as Polygon

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.

See also: Save Text as Polygon

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. (introduced with version 20130101)

See also: Validate GDSII

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. (introduced with version 20150208)

static bool setup::gerberSaveArc

If true pathes are checked for arcs. These arcs will be saved with circular interpolation. (introduced with version 20141206)

static bool setup::gerberSaveCircle

If true, regular polygon are saved as circle in gerber files. (introduced with version 20150613)

See also: Gerber: save regular polygon as circle

static bool setup::gerberSaveOptimize

If true, gerber files are optimized to a minimal non exposure length. (introduced with version 20151023)

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.

See also: Fileformat LEF Fileformat DEF

static int setup::lefPitchHorizontal

horizontal pitch of the LEF file. This setting will be be stored after program shut-down. (introduced with version 20160601)

static int setup::lefPitchVertical

vertical pitch of the LEF file. This setting will be be stored after program shut-down. (introduced with version 20160601)

static string setup::lefExtra

Extra information store in the LEF file. This setting will be be stored after program shut-down. (introduced with version 20160601)

static string setup::macroDirectory

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

static stringList setup::macroPath

A list of paths is set containing the macro tree to be added to the main menu (introduced with version 20170703). For more details please see the setup dialog

static stringList setup::model3dPath

holds the pathes where models for the 3d view are searched. (introduced with version 20160102)

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. (introduced with version 20130101)

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.

See also: Global Nodes

static bool setup::netListImportVhdlUpperNames

Any device type name and node name is converted to upper characters while importing netlists from structual VHDL files. (introduced with version 20130508)

static bool setup::netListImportUseComponentLibrary

The component library from the schematic is used as well to match imported devices. (introduced with version 20130508)

static string setup::netlistUnnamedNodes

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

See also: Unnamed Nodes

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 (introduced with version 20120824)

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. (introduced with version 20170308)

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 :. Starting with version 20160102 this method can only used for read out. To set the callback path, please use setup::callbackPath.

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). (introduced with version 20150228)

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). (introduced with version 20150228)

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 (24 ) 3 = 4096 colors. Lower value will result in a better performance. Higher value in a better quality.

static bool setup::pixelInvert

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

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

(introduced with version 20130728)

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. (introduced with version 20130728)

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. (introduced with version 20130728)

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. (introduced with version 20150128)

static double setup::povUnits

unit in meter used for reading/writing of POV files. A value of 0 uses the user units instead. (introduced with version 20160912)

static QString setup::pythonSuffix

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

static void setup::resetToolbars()

Sets the toolbars to the default position after the next restart. (introduced with version 20150324)

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. (introduced with version 20141128)

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

The bachgroundcolor is set.

Parameter:

red

red channel

green

green channel

blue

blue channel

static 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. (introduced with version 20150228)

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. (introduced with version 20170923)

static double setup::sourceDatabase

Database units for the source format

See also: Fileformat SOURCE

static double setup::stlUnits

unit in meter used for reading/writing of STL files. A value of 0 uses the user units instead. (introduced with version 20151122)

static int setup::svgEndOfLine

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

See also: Fileformat SVG

static double setup::tldLamda

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

See also: Fileformat Lasi

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. (introduced with version 20161112)

static bool setup::wheelDirection

mouse wheel direction for zooming can be changed by this value. (introduced with version 20161226)

See also


CategoryMacroClass


MacroClassSetup (last edited 2017-09-23 19:46:01 by JurgenThies)