com.sun.electric.tool.io
Class IOTool

java.lang.Object
  extended by com.sun.electric.tool.Tool
      extended by com.sun.electric.tool.io.IOTool
All Implemented Interfaces:
java.lang.Comparable

public class IOTool
extends Tool

This class manages reading files in different formats. The class is subclassed by the different file readers.


Field Summary
static Variable.Key IO_TRUE_LIBRARY
          Varible key for true library of fake cell.
static Variable.Key POSTSCRIPT_EPS_SCALE
           
static Variable.Key POSTSCRIPT_FILEDATE
           
static Variable.Key POSTSCRIPT_FILENAME
           
 
Fields inherited from class com.sun.electric.tool.Tool
prefs
 
Constructor Summary
protected IOTool()
          The constructor sets up the I/O tool.
 
Method Summary
static int getBackupRedundancy()
          Method to tell what kind of redundancy to apply when writing library files.
static Setting getCIFOutInstantiatesTopLevelSetting()
          Returns Setting to tell whether CIF Output merges boxes into complex polygons.
static Setting getCIFOutMergesBoxesSetting()
          Returns Setting to tell whether CIF Output merges boxes into complex polygons.
static Setting getCIFOutMimicsDisplaySetting()
          Returns Setting to tell whether CIF Output mimics the display.
static java.lang.String getCopyrightMessage()
          Method to tell the copyright message that will be added to output decks.
static Setting getCopyrightMessageSetting()
          Returns project Setting to tell the copyright message that will be added to output decks.
static int getDXFScale()
          Method to tell the DXF scale.
static Setting getDXFScaleSetting()
          Returns project Settings to tell the DXF scale.
static java.lang.String getEDIFAcceptedParameters()
          Method to return a string with accepted parameter names.
static java.lang.String getEDIFConfigurationFile()
          Method to tell the configuration file to use.
static double getEDIFInputScale()
          Method to return the EDIF input scale.
static int getGDSCellNameLenMax()
          Get the maximum length (number of chars) for Cell names in the GDS output file
static Setting getGDSCellNameLenMaxSetting()
          Returns Setting to tell the maximum length (number of chars) for Cell names in the GDS output file
static boolean getGDSConvertNCCExportsConnectedByParentPins()
          True to convert pin names to name:name for pins that are specified in the NCC annotation, "exportsConnectedByParent".
static int getGDSOutDefaultTextLayer()
          Method to tell the default GDS layer to use for the text of Export pins.
static Setting getGDSOutDefaultTextLayerSetting()
          Returns Setting to tell the default GDS layer to use for the text of Export pins.
static Setting getGDSOutMergesBoxesSetting()
          Returns Setting to tell whether GDS Output merges boxes into complex polygons.
static boolean getGDSOutputConvertsBracketsInExports()
          Method to get the state of whether the GDS writer converts brackets to underscores in export names.
static Setting getGDSOutputConvertsBracketsInExportsSetting()
          Returns Setting to tell the state of whether the GDS writer converts brackets to underscores in export names.
static Setting getGDSOutUpperCaseSetting()
          Returns Setting to tell whether GDS Output makes all text upper-case.
static Setting getGDSOutWritesExportPinsSetting()
          Returns Setting to tell whether GDS Output writes pins at Export locations.
static IOTool getIOTool()
          Method to retrieve the singleton associated with the IOTool tool.
static int getPlotArea()
          Method to tell the area of the screen to plot for printing/PostScript/HPGL.
static int getPrintColorMethod()
          Method to tell the color method of PostScript Output.
static java.util.Date getPrintEPSSavedDate(Cell cell)
          Method to tell the EPS synchronization file of a given Cell.
static double getPrintEPSScale(Cell cell)
          Method to tell the EPS scale of a given Cell.
static java.lang.String getPrintEPSSynchronizeFile(Cell cell)
          Method to tell the EPS synchronization file of a given Cell.
static java.lang.String getPrinterName()
          Method to tell the default printer name to use.
static double getPrintHeight()
          Method to tell the height of PostScript Output.
static double getPrintMargin()
          Method to tell the margin of PostScript Output.
static double getPrintPSLineWidth()
          Method to tell the width of PostScript lines.
static int getPrintResolution()
          Method to tell the default printing resolution.
static int getPrintRotation()
          Method to tell the rotation of PostScript Output.
static double getPrintWidth()
          Method to tell the width of PostScript Output.
static Setting getUseCopyrightMessageSetting()
          Returns project Setting to tell whether to add the copyright message to output decks.
static boolean hasDais()
          Method to tell whether Dais input is available.
static boolean hasSkill()
          Method to tell whether Skill output is available.
protected  void initProjectSettings()
          Subclasses override this method to create ProjectSettings by Tool.makeXXXSetting methods declared below.
static boolean isCIFInSquaresWires()
          Method to tell whether CIF input makes wire ends square or round.
static boolean isCIFOutInstantiatesTopLevel()
          Method to tell whether CIF Output instantiates the top-level.
static boolean isCIFOutMergesBoxes()
          Method to tell whether CIF Output merges boxes into complex polygons.
static boolean isCIFOutMimicsDisplay()
          Method to tell whether CIF Output mimics the display.
static boolean isDaisDisplayOnly()
          Method to tell whether Dais Input creates real geometry.
static boolean isDaisReadCellInstances()
          Method to tell whether Dais Input creates real geometry.
static boolean isDaisReadConnectivity()
          Method to tell whether Dais Input reads connectivity.
static boolean isDaisReadDetailWires()
          Method to tell whether Dais Input creates real geometry.
static boolean isDaisReadGlobalWires()
          Method to tell whether Dais Input creates real geometry.
static boolean isDaisReadPowerAndGround()
          Method to tell whether Dais Input creates real geometry.
static boolean isDEFLogicalPlacement()
          Method to tell whether DEF Input makes logical placement.
static boolean isDEFPhysicalPlacement()
          Method to tell whether DEF Input makes physical placement.
static boolean isDXFInputFlattensHierarchy()
          Method to tell whether DXF Input flattens the hierarchy.
static boolean isDXFInputReadsAllLayers()
          Method to tell whether DXF input reads all layers.
static boolean isEDIFCadenceCompatibility()
          Method to tell whether EDIF I/O is compatible with Cadence.
static boolean isEDIFUseSchematicView()
          Method to tell whether EDIF uses the schematic view.
static boolean isGDSColapseVddGndPinNames()
          Method to tell whether Vdd_* and Gnd_* export pins must be colapsed.
static boolean isGDSInExpandsCells()
          Method to tell whether GDS Input expands cells.
static boolean isGDSInIgnoresUnknownLayers()
          Method to tell whether GDS Input ignores unknown layers The default is "false".
static boolean isGDSInIncludesText()
          Method to tell whether GDS Input ignores text.
static boolean isGDSInInstantiatesArrays()
          Method to tell whether GDS Input instantiates arrays.
static boolean isGDSInMergesBoxes()
          Method to tell whether GDS Input merges boxes into complex polygons.
static boolean isGDSInSimplifyCells()
          Method to tell whether GDS Input simplifies contact vias.
static boolean isGDSOutMergesBoxes()
          Method to tell whether GDS Output merges boxes into complex polygons.
static boolean isGDSOutUpperCase()
          Method to tell whether GDS Output makes all text upper-case.
static boolean isGDSOutWritesExportPins()
          Method to tell whether GDS Output writes pins at Export locations.
static boolean isPlotDate()
          Method to tell whether to plot the date in PostScript output.
static boolean isPrintEncapsulated()
          Method to tell whether PostScript Output is Encapsulated.
static boolean isPrintForPlotter()
          Method to tell whether PostScript Output is for a plotter.
static boolean isSkillExcludesSubcells()
          Method to tell whether Skill Output excludes subcells.
static boolean isSkillFlattensHierarchy()
          Method to tell whether Skill Output flattens the hierarchy.
static boolean isSkillGDSNameLimit()
          Method to tell whether Skill Output flattens the hierarchy.
static boolean isSueConvertsExpressions()
          Method to tell whether Sue input converts Sue expressions to Electric form.
static boolean isSueUses4PortTransistors()
          Method to tell whether Sue input creates 4-port transistors.
static boolean isUseCopyrightMessage()
          Method to tell whether to add the copyright message to output decks.
static void readDais(java.net.URL url, Library lib, boolean newLib)
          Method to invoke the Dais input module via reflection.
static void setBackupRedundancy(int r)
          Method to set the level of redundancy to apply when writing library files.
static void setCIFInSquaresWires(boolean s)
          Method to set whether CIF input makes wire ends square or round.
static void setDaisDisplayOnly(boolean on)
          Method to set whether Dais Input creates real geometry.
static void setDaisReadCellInstances(boolean on)
          Method to set whether Dais Input creates real geometry.
static void setDaisReadConnectivity(boolean on)
          Method to set whether Dais Input reads connectivity.
static void setDaisReadDetailWires(boolean on)
          Method to set whether Dais Input creates real geometry.
static void setDaisReadGlobalWires(boolean on)
          Method to set whether Dais Input creates real geometry.
static void setDaisReadPowerAndGround(boolean on)
          Method to set whether Dais Input creates real geometry.
static void setDEFLogicalPlacement(boolean on)
          Method to set whether DEF Input makes logical placement.
static void setDEFPhysicalPlacement(boolean on)
          Method to set whether DEF Input makes physical placement.
static void setDXFInputFlattensHierarchy(boolean f)
          Method to set whether DXF Input flattens the hierarchy.
static void setDXFInputReadsAllLayers(boolean a)
          Method to set whether DXF input reads all layers.
static void setEDIFAcceptedParameters(java.lang.String ap)
          Method to set a string with accepted parameter names.
static void setEDIFCadenceCompatibility(boolean c)
          Method to set whether EDIF I/O is compatible with Cadence.
static void setEDIFConfigurationFile(java.lang.String cFile)
          Method to set the configuration file to use.
static void setEDIFInputScale(double f)
          Method to set the EDIF input scale.
static void setEDIFUseSchematicView(boolean f)
          Method to set whether EDIF uses the schematic view.
static void setGDSColapseVddGndPinNames(boolean on)
          Method to set whether Vdd_* and Gnd_* export pins must be colapsed.
static void setGDSConvertNCCExportsConnectedByParentPins(boolean b)
          True to convert pin names to name:name for pins that are specified in the NCC annotation, "exportsConnectedByParent".
static void setGDSInExpandsCells(boolean on)
          Method to set whether GDS Input expands cells.
static void setGDSInIgnoresUnknownLayers(boolean on)
          Method to set whether GDS Input ignores unknown layers Unknown layers are replaced with "DRC exclusion" nodes if not ignored.
static void setGDSInIncludesText(boolean on)
          Method to set whether GDS Input ignores text.
static void setGDSInInstantiatesArrays(boolean on)
          Method to set whether GDS Input instantiates arrays.
static void setGDSInMergesBoxes(boolean on)
          Method to set whether GDS Input merges boxes into complex polygons.
static void setGDSInSimplifyCells(boolean on)
          Method to set whether GDS Input simplifies contact vias.
static void setPlotArea(int pa)
          Method to set the area of the screen to plot for printing/PostScript/HPGL.
static void setPlotDate(boolean pd)
          Method to set whether to plot the date in PostScript output.
static void setPrintColorMethod(int cm)
          Method to set the color method of PostScript Output.
static void setPrintEncapsulated(boolean on)
          Method to set whether PostScript Output is Encapsulated.
static void setPrintEPSSavedDate(Cell cell, java.util.Date date)
          Method to set the EPS synchronization file of a given Cell.
static void setPrintEPSScale(Cell cell, double scale)
          Method to set the EPS scale of a given Cell.
static void setPrintEPSSynchronizeFile(Cell cell, java.lang.String syncFile)
          Method to set the EPS synchronization file of a given Cell.
static void setPrinterName(java.lang.String pName)
          Method to set the default printer name to use.
static void setPrintForPlotter(boolean on)
          Method to set whether PostScript Output is for a plotter.
static void setPrintHeight(double hei)
          Method to set the height of PostScript Output.
static void setPrintMargin(double mar)
          Method to set the margin of PostScript Output.
static void setPrintPSLineWidth(double mar)
          Method to set the width of PostScript lines.
static void setPrintResolution(int r)
          Method to set the default printing resolution.
static void setPrintRotation(int rot)
          Method to set the rotation of PostScript Output.
static void setPrintWidth(double wid)
          Method to set the width of PostScript Output.
static void setSkillExcludesSubcells(boolean on)
          Method to set whether Skill Output excludes subcells.
static void setSkillFlattensHierarchy(boolean on)
          Method to set whether Skill Output flattens the hierarchy.
static void setSkillGDSNameLimit(boolean on)
          Method to set whether Skill Output flattens the hierarchy.
static void setSueConvertsExpressions(boolean on)
          Method to set whether Sue input converts Sue expressions to Electric form.
static void setSueUses4PortTransistors(boolean on)
          Method to set whether Sue input creates 4-port transistors.
static void writeSkill(Cell cell, java.lang.String fileName, boolean exportsOnly)
          Method to invoke the Skill output module via reflection.
 
Methods inherited from class com.sun.electric.tool.Tool
clearAnalysis, clearBackground, clearFixErrors, clearIncremental, clearOn, clearSynthesis, compareTo, findTool, getIndex, getListeners, getName, getNumTools, getProjectSettings, getTools, init, initAllTools, isAnalysis, isBackground, isFixErrors, isIncremental, isOn, isSynthesis, makeBooleanSetting, makeDoubleSetting, makeIntSetting, makeLongSetting, makeStringSetting, setAnalysis, setBackground, setFixErrors, setIncremental, setOn, setSynthesis, setVarInJob, testAll, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

IO_TRUE_LIBRARY

public static final Variable.Key IO_TRUE_LIBRARY
Varible key for true library of fake cell.


POSTSCRIPT_EPS_SCALE

public static final Variable.Key POSTSCRIPT_EPS_SCALE

POSTSCRIPT_FILENAME

public static final Variable.Key POSTSCRIPT_FILENAME

POSTSCRIPT_FILEDATE

public static final Variable.Key POSTSCRIPT_FILEDATE
Constructor Detail

IOTool

protected IOTool()
The constructor sets up the I/O tool.

Method Detail

getIOTool

public static IOTool getIOTool()
Method to retrieve the singleton associated with the IOTool tool.

Returns:
the IOTool tool.

hasSkill

public static boolean hasSkill()
Method to tell whether Skill output is available. Skill is a proprietary format of Cadence, and only valid licensees are given this module. This method dynamically figures out whether the Skill module is present by using reflection.

Returns:
true if the Skill output module is available.

writeSkill

public static void writeSkill(Cell cell,
                              java.lang.String fileName,
                              boolean exportsOnly)
Method to invoke the Skill output module via reflection.

Parameters:
cell - the Cell to write in Skill.
fileName - the name of the file to write.

hasDais

public static boolean hasDais()
Method to tell whether Dais input is available. Dais is a proprietary format of Sun Microsystems. This method dynamically figures out whether the Dais module is present by using reflection.

Returns:
true if the Dais input module is available.

readDais

public static void readDais(java.net.URL url,
                            Library lib,
                            boolean newLib)
Method to invoke the Dais input module via reflection.

Parameters:
lib - the Library to read.

initProjectSettings

protected void initProjectSettings()
Description copied from class: Tool
Subclasses override this method to create ProjectSettings by Tool.makeXXXSetting methods declared below.

Overrides:
initProjectSettings in class Tool

getBackupRedundancy

public static int getBackupRedundancy()
Method to tell what kind of redundancy to apply when writing library files. The value is: 0 for no backup (just overwrite the old file) [the default]; 1 for 1-level backup (rename the old file to have a "~" at the end); 2 for full history backup (rename the old file to have date information in it).

Returns:
the level of redundancy to apply when writing library files.

setBackupRedundancy

public static void setBackupRedundancy(int r)
Method to set the level of redundancy to apply when writing library files. The value is: 0 for no backup (just overwrite the old file); 1 for 1-level backup (rename the old file to have a "~" at the end); 2 for full history backup (rename the old file to have date information in it).

Parameters:
r - the level of redundancy to apply when writing library files.

isUseCopyrightMessage

public static boolean isUseCopyrightMessage()
Method to tell whether to add the copyright message to output decks. The default is "false".

Returns:
true to add the copyright message to output decks.

getUseCopyrightMessageSetting

public static Setting getUseCopyrightMessageSetting()
Returns project Setting to tell whether to add the copyright message to output decks.

Returns:
project Setting to tell whether to add the copyright message to output decks.

getCopyrightMessage

public static java.lang.String getCopyrightMessage()
Method to tell the copyright message that will be added to output decks. The default is "".

Returns:
the copyright message that will be added to output decks.

getCopyrightMessageSetting

public static Setting getCopyrightMessageSetting()
Returns project Setting to tell the copyright message that will be added to output decks.

Returns:
project Setting to tell the copyright message that will be added to output decks.

getPlotArea

public static int getPlotArea()
Method to tell the area of the screen to plot for printing/PostScript/HPGL.

Returns:
the area of the screen to plot for printing/PostScript/HPGL: 0=plot the entire cell (the default); 1=plot only the highlighted area; 2=plot only the displayed window.

setPlotArea

public static void setPlotArea(int pa)
Method to set the area of the screen to plot for printing/PostScript/HPGL.

Parameters:
pa - the area of the screen to plot for printing/PostScript/HPGL. 0=plot the entire cell; 1=plot only the highlighted area; 2=plot only the displayed window.

isPlotDate

public static boolean isPlotDate()
Method to tell whether to plot the date in PostScript output. The default is "false".

Returns:
whether to plot the date in PostScript output.

setPlotDate

public static void setPlotDate(boolean pd)
Method to set whether to plot the date in PostScript output.

Parameters:
pd - true to plot the date in PostScript output.

getPrinterName

public static java.lang.String getPrinterName()
Method to tell the default printer name to use. The default is "".

Returns:
the default printer name to use.

setPrinterName

public static void setPrinterName(java.lang.String pName)
Method to set the default printer name to use.

Parameters:
pName - the default printer name to use.

isCIFOutMimicsDisplay

public static boolean isCIFOutMimicsDisplay()
Method to tell whether CIF Output mimics the display. To mimic the display, unexpanded cell instances are described as black boxes, instead of calls to their contents. The default is "false".

Returns:
true if CIF Output mimics the display.

getCIFOutMimicsDisplaySetting

public static Setting getCIFOutMimicsDisplaySetting()
Returns Setting to tell whether CIF Output mimics the display. To mimic the display, unexpanded cell instances are described as black boxes, instead of calls to their contents.

Returns:
Setting to tell whether CIF Output mimics the display.

isCIFOutMergesBoxes

public static boolean isCIFOutMergesBoxes()
Method to tell whether CIF Output merges boxes into complex polygons. This takes more time but produces a smaller output file. The default is "false".

Returns:
true if CIF Output merges boxes into complex polygons.

getCIFOutMergesBoxesSetting

public static Setting getCIFOutMergesBoxesSetting()
Returns Setting to tell whether CIF Output merges boxes into complex polygons. This takes more time but produces a smaller output file.

Returns:
Setting to tell whether CIF Output merges boxes into complex polygons.

isCIFOutInstantiatesTopLevel

public static boolean isCIFOutInstantiatesTopLevel()
Method to tell whether CIF Output instantiates the top-level. When this happens, a CIF "call" to the top cell is emitted. The default is "true".

Returns:
true if CIF Output merges boxes into complex polygons.

getCIFOutInstantiatesTopLevelSetting

public static Setting getCIFOutInstantiatesTopLevelSetting()
Returns Setting to tell whether CIF Output merges boxes into complex polygons. When this happens, a CIF "call" to the top cell is emitted.

Returns:
Setting to tell whether CIF Output merges boxes into complex polygons.

isCIFInSquaresWires

public static boolean isCIFInSquaresWires()
Method to tell whether CIF input makes wire ends square or round. The default is "true" (square).

Returns:
true if CIF input makes wire ends square.

setCIFInSquaresWires

public static void setCIFInSquaresWires(boolean s)
Method to set whether CIF input makes wire ends square or round.

Parameters:
s - true if CIF input makes wire ends square.

isDEFLogicalPlacement

public static boolean isDEFLogicalPlacement()
Method to tell whether DEF Input makes logical placement. The default is "true" (do the logical placement).

Returns:
true if DEF Input makes logical placement.

setDEFLogicalPlacement

public static void setDEFLogicalPlacement(boolean on)
Method to set whether DEF Input makes logical placement.

Parameters:
on - true if DEF Input makes logical placement.

isDEFPhysicalPlacement

public static boolean isDEFPhysicalPlacement()
Method to tell whether DEF Input makes physical placement. The default is "true" (do the physical placement).

Returns:
true if DEF Input makes physical placement.

setDEFPhysicalPlacement

public static void setDEFPhysicalPlacement(boolean on)
Method to set whether DEF Input makes physical placement.

Parameters:
on - true if DEF Input makes physical placement.

isGDSOutMergesBoxes

public static boolean isGDSOutMergesBoxes()
Method to tell whether GDS Output merges boxes into complex polygons. This takes more time but produces a smaller output file. The default is "false".

Returns:
true if GDS Output merges boxes into complex polygons.

getGDSOutMergesBoxesSetting

public static Setting getGDSOutMergesBoxesSetting()
Returns Setting to tell whether GDS Output merges boxes into complex polygons. This takes more time but produces a smaller output file.

Returns:
Setting to tell if GDS Output merges boxes into complex polygons.

isGDSOutWritesExportPins

public static boolean isGDSOutWritesExportPins()
Method to tell whether GDS Output writes pins at Export locations. Some systems can use this information to reconstruct export locations. The default is "false".

Returns:
true if GDS Output writes pins at Export locations.

getGDSOutWritesExportPinsSetting

public static Setting getGDSOutWritesExportPinsSetting()
Returns Setting to tell whether GDS Output writes pins at Export locations. Some systems can use this information to reconstruct export locations.

Returns:
Setting to tell whether GDS Output writes pins at Export locations.

isGDSOutUpperCase

public static boolean isGDSOutUpperCase()
Method to tell whether GDS Output makes all text upper-case. Some systems insist on this. The default is "false".

Returns:
true if GDS Output makes all text upper-case.

getGDSOutUpperCaseSetting

public static Setting getGDSOutUpperCaseSetting()
Returns Setting to tell whether GDS Output makes all text upper-case. Some systems insist on this.

Returns:
Setting to tell whether GDS Output makes all text upper-case.

getGDSOutDefaultTextLayer

public static int getGDSOutDefaultTextLayer()
Method to tell the default GDS layer to use for the text of Export pins. Export pins are annotated with text objects on this layer. If this is negative, do not write Export pins. The default is "230".

Returns:
the default GDS layer to use for the text of Export pins.

getGDSOutDefaultTextLayerSetting

public static Setting getGDSOutDefaultTextLayerSetting()
Returns Setting to tell the default GDS layer to use for the text of Export pins. Export pins are annotated with text objects on this layer. If this is negative, do not write Export pins.

Returns:
Setting to tell to set the default GDS layer to use for the text of Export pins.

getGDSOutputConvertsBracketsInExports

public static boolean getGDSOutputConvertsBracketsInExports()
Method to get the state of whether the GDS writer converts brackets to underscores in export names.


getGDSOutputConvertsBracketsInExportsSetting

public static Setting getGDSOutputConvertsBracketsInExportsSetting()
Returns Setting to tell the state of whether the GDS writer converts brackets to underscores in export names.

Returns:
Setting to tell the state of whether the GDS writer converts brackets

getGDSCellNameLenMax

public static int getGDSCellNameLenMax()
Get the maximum length (number of chars) for Cell names in the GDS output file

Returns:
the number of chars

getGDSCellNameLenMaxSetting

public static Setting getGDSCellNameLenMaxSetting()
Returns Setting to tell the maximum length (number of chars) for Cell names in the GDS output file

Returns:
Setting to tell the maximum length (number of chars) for Cell names in the GDS output file

isGDSInMergesBoxes

public static boolean isGDSInMergesBoxes()
Method to tell whether GDS Input merges boxes into complex polygons. This takes more time but produces a smaller database. The default is "false".

Returns:
true if GDS Input merges boxes into complex polygons.

setGDSInMergesBoxes

public static void setGDSInMergesBoxes(boolean on)
Method to set whether GDS Input merges boxes into complex polygons. This takes more time but produces a smaller database.

Parameters:
on - true if GDS Input merges boxes into complex polygons.

isGDSInIncludesText

public static boolean isGDSInIncludesText()
Method to tell whether GDS Input ignores text. Text can clutter the display, so some users don't want to read it. The default is "false".

Returns:
true if GDS Input ignores text.

setGDSInIncludesText

public static void setGDSInIncludesText(boolean on)
Method to set whether GDS Input ignores text. Text can clutter the display, so some users don't want to read it.

Parameters:
on - true if GDS Input ignores text.

isGDSInExpandsCells

public static boolean isGDSInExpandsCells()
Method to tell whether GDS Input expands cells. The default is "false".

Returns:
true if GDS Input expands cells.

setGDSInExpandsCells

public static void setGDSInExpandsCells(boolean on)
Method to set whether GDS Input expands cells.

Parameters:
on - true if GDS Input expands cells.

isGDSInInstantiatesArrays

public static boolean isGDSInInstantiatesArrays()
Method to tell whether GDS Input instantiates arrays. The default is "true". When false, only the edges of arrays are instantiated, not those entries in the center.

Returns:
true if GDS Input instantiates arrays.

setGDSInInstantiatesArrays

public static void setGDSInInstantiatesArrays(boolean on)
Method to set whether GDS Input instantiates arrays. When false, only the edges of arrays are instantiated, not those entries in the center.

Parameters:
on - true if GDS Input instantiates arrays.

isGDSInIgnoresUnknownLayers

public static boolean isGDSInIgnoresUnknownLayers()
Method to tell whether GDS Input ignores unknown layers The default is "false". Unknown layers are replaced with "DRC exclusion" nodes if not ignored.

Returns:
true if GDS Input ignores unknown layers

setGDSInIgnoresUnknownLayers

public static void setGDSInIgnoresUnknownLayers(boolean on)
Method to set whether GDS Input ignores unknown layers Unknown layers are replaced with "DRC exclusion" nodes if not ignored.

Parameters:
on - true if GDS Input ignores unknown layers

getGDSConvertNCCExportsConnectedByParentPins

public static boolean getGDSConvertNCCExportsConnectedByParentPins()
True to convert pin names to name:name for pins that are specified in the NCC annotation, "exportsConnectedByParent". This allows external LVS tools to perform the analogous operation of virtual connection of networks. For example, 'exportsConnectedByParent vdd /vdd_[0-9]+/' will rename all pins that match the assertion to vdd:vdd.


setGDSConvertNCCExportsConnectedByParentPins

public static void setGDSConvertNCCExportsConnectedByParentPins(boolean b)
True to convert pin names to name:name for pins that are specified in the NCC annotation, "exportsConnectedByParent". This allows external LVS tools to perform the analogous operation of virtual connection of networks. For example, 'exportsConnectedByParent vdd /vdd_[0-9]+/' will rename all pins that match the assertion to vdd:vdd.


isGDSInSimplifyCells

public static boolean isGDSInSimplifyCells()
Method to tell whether GDS Input simplifies contact vias. The default is "false".

Returns:
true if GDS Input simplifies contact vias.

setGDSInSimplifyCells

public static void setGDSInSimplifyCells(boolean on)
Method to set whether GDS Input simplifies contact vias.

Parameters:
on - true if GDS Input simplifies contact vias.

isGDSColapseVddGndPinNames

public static boolean isGDSColapseVddGndPinNames()
Method to tell whether Vdd_* and Gnd_* export pins must be colapsed. This is for extraction in Fire/Ice.

Returns:
true if GDS Input colapses vdd/gnd names.

setGDSColapseVddGndPinNames

public static void setGDSColapseVddGndPinNames(boolean on)
Method to set whether Vdd_* and Gnd_* export pins must be colapsed. This is for extraction in Fire/Ice.

Parameters:
on - true if GDS Input colapses vdd/gnd names.

isPrintEncapsulated

public static boolean isPrintEncapsulated()
Method to tell whether PostScript Output is Encapsulated. Encapsulated PostScript can be inserted into other documents. The default is "false".

Returns:
true if PostScript Output is Encapsulated.

setPrintEncapsulated

public static void setPrintEncapsulated(boolean on)
Method to set whether PostScript Output is Encapsulated. Encapsulated PostScript can be inserted into other documents.

Parameters:
on - true if PostScript Output is Encapsulated.

getPrintResolution

public static int getPrintResolution()
Method to tell the default printing resolution. Java printing assumes 72 DPI, this is an override. The default is "300".

Returns:
the default printing resolution.

setPrintResolution

public static void setPrintResolution(int r)
Method to set the default printing resolution. Java printing assumes 72 DPI, this is an override.

Parameters:
r - the default printing resolution.

isPrintForPlotter

public static boolean isPrintForPlotter()
Method to tell whether PostScript Output is for a plotter. Plotters have width, but no height, since they are continuous feed. The default is "false".

Returns:
true if PostScript Output is for a plotter.

setPrintForPlotter

public static void setPrintForPlotter(boolean on)
Method to set whether PostScript Output is for a plotter. Plotters have width, but no height, since they are continuous feed.

Parameters:
on - true if PostScript Output is for a plotter.

getPrintWidth

public static double getPrintWidth()
Method to tell the width of PostScript Output. The width is in inches. The default is "8.5".

Returns:
the width of PostScript Output.

setPrintWidth

public static void setPrintWidth(double wid)
Method to set the width of PostScript Output. The width is in inches.

Parameters:
wid - the width of PostScript Output.

getPrintHeight

public static double getPrintHeight()
Method to tell the height of PostScript Output. The height is in inches, and only applies if printing (not plotting). The default is "11".

Returns:
the height of PostScript Output.

setPrintHeight

public static void setPrintHeight(double hei)
Method to set the height of PostScript Output. The height is in inches, and only applies if printing (not plotting).

Parameters:
hei - the height of PostScript Output.

getPrintMargin

public static double getPrintMargin()
Method to tell the margin of PostScript Output. The margin is in inches and insets from all sides. The default is "0.75".

Returns:
the margin of PostScript Output.

setPrintMargin

public static void setPrintMargin(double mar)
Method to set the margin of PostScript Output. The margin is in inches and insets from all sides.

Parameters:
mar - the margin of PostScript Output.

getPrintRotation

public static int getPrintRotation()
Method to tell the rotation of PostScript Output. The plot can be normal or rotated 90 degrees to better fit the paper.

Returns:
the rotation of PostScript Output: 0=no rotation (the default); 1=rotate 90 degrees; 2=rotate automatically to fit best.

setPrintRotation

public static void setPrintRotation(int rot)
Method to set the rotation of PostScript Output. The plot can be normal or rotated 90 degrees to better fit the paper.

Parameters:
rot - the rotation of PostScript Output. 0=no rotation; 1=rotate 90 degrees; 2=rotate automatically to fit best.

getPrintColorMethod

public static int getPrintColorMethod()
Method to tell the color method of PostScript Output.

Returns:
the color method of PostScript Output: 0=Black & White (the default); 1=Color (solid); 2=Color (stippled); 3=Color (merged).

setPrintColorMethod

public static void setPrintColorMethod(int cm)
Method to set the color method of PostScript Output.

Parameters:
cm - the color method of PostScript Output. 0=Black & White; 1=Color (solid); 2=Color (stippled); 3=Color (merged).

getPrintEPSScale

public static double getPrintEPSScale(Cell cell)
Method to tell the EPS scale of a given Cell.

Parameters:
cell - the cell to query.
Returns:
the EPS scale of that Cell.

setPrintEPSScale

public static void setPrintEPSScale(Cell cell,
                                    double scale)
Method to set the EPS scale of a given Cell.

Parameters:
cell - the cell to modify.
scale - the EPS scale of that Cell.

getPrintEPSSynchronizeFile

public static java.lang.String getPrintEPSSynchronizeFile(Cell cell)
Method to tell the EPS synchronization file of a given Cell. During automatic synchronization of PostScript, any cell changed more recently than the date on this file will cause that file to be generated from the Cell.

Parameters:
cell - the cell to query.
Returns:
the EPS synchronization file of that Cell.

setPrintEPSSynchronizeFile

public static void setPrintEPSSynchronizeFile(Cell cell,
                                              java.lang.String syncFile)
Method to set the EPS synchronization file of a given Cell. During automatic synchronization of PostScript, any cell changed more recently than the date on this file will cause that file to be generated from the Cell.

Parameters:
cell - the cell to modify.
syncFile - the EPS synchronization file to associate with that Cell.

getPrintEPSSavedDate

public static java.util.Date getPrintEPSSavedDate(Cell cell)
Method to tell the EPS synchronization file of a given Cell. During automatic synchronization of PostScript, any cell changed more recently than the date on this file will cause that file to be generated from the Cell.

Parameters:
cell - the cell to query.
Returns:
the EPS synchronization file of that Cell.

setPrintEPSSavedDate

public static void setPrintEPSSavedDate(Cell cell,
                                        java.util.Date date)
Method to set the EPS synchronization file of a given Cell. During automatic synchronization of PostScript, any cell changed more recently than the date on this file will cause that file to be generated from the Cell.

Parameters:
cell - the cell to modify.
date - the EPS synchronization date to associate with that Cell.

getPrintPSLineWidth

public static double getPrintPSLineWidth()
Method to tell the width of PostScript lines. Lines have their width scaled by this amount, so the default (1) means normal lines.

Returns:
the width of PostScript lines.

setPrintPSLineWidth

public static void setPrintPSLineWidth(double mar)
Method to set the width of PostScript lines. Lines have their width scaled by this amount, so the default (1) means normal lines.

Parameters:
mar - the width of PostScript lines.

isEDIFUseSchematicView

public static boolean isEDIFUseSchematicView()
Method to tell whether EDIF uses the schematic view. The default is "true".

Returns:
true if EDIF uses the schematic view.

setEDIFUseSchematicView

public static void setEDIFUseSchematicView(boolean f)
Method to set whether EDIF uses the schematic view.

Parameters:
f - true if EDIF uses the schematic view.

isEDIFCadenceCompatibility

public static boolean isEDIFCadenceCompatibility()
Method to tell whether EDIF I/O is compatible with Cadence. The default is "true".

Returns:
true if EDIF I/O is compatible with Cadence.

setEDIFCadenceCompatibility

public static void setEDIFCadenceCompatibility(boolean c)
Method to set whether EDIF I/O is compatible with Cadence.

Parameters:
c - true if EDIF I/O is compatible with Cadence.

getEDIFInputScale

public static double getEDIFInputScale()
Method to return the EDIF input scale. The default is "1".

Returns:
the EDIF input scale.

setEDIFInputScale

public static void setEDIFInputScale(double f)
Method to set the EDIF input scale.

Parameters:
f - the EDIF input scale.

getEDIFConfigurationFile

public static java.lang.String getEDIFConfigurationFile()
Method to tell the configuration file to use. The default is "" (no configuration file).

Returns:
the configuration file to use.

setEDIFConfigurationFile

public static void setEDIFConfigurationFile(java.lang.String cFile)
Method to set the configuration file to use.

Parameters:
cFile - the configuration file to use.

getEDIFAcceptedParameters

public static java.lang.String getEDIFAcceptedParameters()
Method to return a string with accepted parameter names. These parameter names will be placed on cells when reading EDIF. The string lists the names, separated by slashes. The default is "" (no parameters accepted).

Returns:
a string with accepted parameter names.

setEDIFAcceptedParameters

public static void setEDIFAcceptedParameters(java.lang.String ap)
Method to set a string with accepted parameter names. These parameter names will be placed on cells when reading EDIF. The string lists the names, separated by slashes.

Parameters:
ap - the accepted parameter names.

getDXFScale

public static int getDXFScale()
Method to tell the DXF scale. The DXF scale is: The default is "2" (MicroMeters).

Returns:
the DXF scale.

getDXFScaleSetting

public static Setting getDXFScaleSetting()
Returns project Settings to tell the DXF scale. The DXF scale is:

Returns:
project Settings to tell the DXF scale.

isDXFInputFlattensHierarchy

public static boolean isDXFInputFlattensHierarchy()
Method to tell whether DXF Input flattens the hierarchy. Flattened DXF appears in a single cell. The default is "true".

Returns:
true if DXF Input flattens the hierarchy.

setDXFInputFlattensHierarchy

public static void setDXFInputFlattensHierarchy(boolean f)
Method to set whether DXF Input flattens the hierarchy. Flattened DXF appears in a single cell.

Parameters:
f - true if DXF Input flattens the hierarchy.

isDXFInputReadsAllLayers

public static boolean isDXFInputReadsAllLayers()
Method to tell whether DXF input reads all layers. When a DXF layer in the file is unknown, it is ignored if all layers are NOT being read; it is converted to another layer if all layers ARE being read. The default is "false".

Returns:
true if DXF input reads all layers.

setDXFInputReadsAllLayers

public static void setDXFInputReadsAllLayers(boolean a)
Method to set whether DXF input reads all layers. When a DXF layer in the file is unknown, it is ignored if all layers are NOT being read; it is converted to another layer if all layers ARE being read.

Parameters:
a - true if DXF input reads all layers.

isSueUses4PortTransistors

public static boolean isSueUses4PortTransistors()
Method to tell whether Sue input creates 4-port transistors. Without this, standard 3-port transistors are created. The default is "false".

Returns:
true if Sue input creates 4-port transistors.

setSueUses4PortTransistors

public static void setSueUses4PortTransistors(boolean on)
Method to set whether Sue input creates 4-port transistors. Without this, standard 3-port transistors are created.

Parameters:
on - true if Sue input creates 4-port transistors.

isSueConvertsExpressions

public static boolean isSueConvertsExpressions()
Method to tell whether Sue input converts Sue expressions to Electric form. Electric expressions have "@" in front of variables. The default is "false".

Returns:
true if Sue input converts Sue expressions to Electric form.

setSueConvertsExpressions

public static void setSueConvertsExpressions(boolean on)
Method to set whether Sue input converts Sue expressions to Electric form. Electric expressions have "@" in front of variables.

Parameters:
on - true if Sue input converts Sue expressions to Electric form.

isSkillExcludesSubcells

public static boolean isSkillExcludesSubcells()
Method to tell whether Skill Output excludes subcells. If subcells are included, a Skill output files have multiple cell definitions in them. The default is "false".

Returns:
true if Skill Output excludes subcells.

setSkillExcludesSubcells

public static void setSkillExcludesSubcells(boolean on)
Method to set whether Skill Output excludes subcells. If subcells are included, a Skill output files have multiple cell definitions in them.

Parameters:
on - true if Skill Output excludes subcells.

isSkillFlattensHierarchy

public static boolean isSkillFlattensHierarchy()
Method to tell whether Skill Output flattens the hierarchy. Flattened files are larger, but have no hierarchical structure. The default is "false".

Returns:
true if Skill Output flattens the hierarchy.

setSkillFlattensHierarchy

public static void setSkillFlattensHierarchy(boolean on)
Method to set whether Skill Output flattens the hierarchy. Flattened files are larger, but have no hierarchical structure.

Parameters:
on - true if Skill Output flattens the hierarchy.

isSkillGDSNameLimit

public static boolean isSkillGDSNameLimit()
Method to tell whether Skill Output flattens the hierarchy. Flattened files are larger, but have no hierarchical structure. The default is "false".

Returns:
true if Skill Output flattens the hierarchy.

setSkillGDSNameLimit

public static void setSkillGDSNameLimit(boolean on)
Method to set whether Skill Output flattens the hierarchy. Flattened files are larger, but have no hierarchical structure.

Parameters:
on - true if Skill Output flattens the hierarchy.

isDaisDisplayOnly

public static boolean isDaisDisplayOnly()
Method to tell whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing. The default is "false".

Returns:
true if Dais Input creates real geometry.

setDaisDisplayOnly

public static void setDaisDisplayOnly(boolean on)
Method to set whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing.

Parameters:
on - true if Dais Input creates real geometry.

isDaisReadCellInstances

public static boolean isDaisReadCellInstances()
Method to tell whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing. The default is "false".

Returns:
true if Dais Input creates real geometry.

setDaisReadCellInstances

public static void setDaisReadCellInstances(boolean on)
Method to set whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing.

Parameters:
on - true if Dais Input creates real geometry.

isDaisReadDetailWires

public static boolean isDaisReadDetailWires()
Method to tell whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing. The default is "false".

Returns:
true if Dais Input creates real geometry.

setDaisReadDetailWires

public static void setDaisReadDetailWires(boolean on)
Method to set whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing.

Parameters:
on - true if Dais Input creates real geometry.

isDaisReadGlobalWires

public static boolean isDaisReadGlobalWires()
Method to tell whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing. The default is "false".

Returns:
true if Dais Input creates real geometry.

setDaisReadGlobalWires

public static void setDaisReadGlobalWires(boolean on)
Method to set whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing.

Parameters:
on - true if Dais Input creates real geometry.

isDaisReadPowerAndGround

public static boolean isDaisReadPowerAndGround()
Method to tell whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing. The default is "false".

Returns:
true if Dais Input creates real geometry.

setDaisReadPowerAndGround

public static void setDaisReadPowerAndGround(boolean on)
Method to set whether Dais Input creates real geometry. When real geometry is created, it takes more time and memory, but the circuitry can be edited. When false, Dais input is read directly into the display system for rapid viewing.

Parameters:
on - true if Dais Input creates real geometry.

isDaisReadConnectivity

public static boolean isDaisReadConnectivity()
Method to tell whether Dais Input reads connectivity. Connectivity is represented by "unrouted" arcs from the Generic technology, which appear in a "rats nest" on the circuit. The default is "true".

Returns:
true if Dais Input reads connectivity.

setDaisReadConnectivity

public static void setDaisReadConnectivity(boolean on)
Method to set whether Dais Input reads connectivity. Connectivity is represented by "unrouted" arcs from the Generic technology, which appear in a "rats nest" on the circuit.

Parameters:
on - true if Dais Input reads connectivity.