user.java

The ElectricTM VLSI Design System is an open-source Electronic Design Automation (EDA) system that c

	/**
	 * Method to set whether generated icons should have a body drawn.
	 * The body is just a rectangle.
	 * @param on true if generated icons should have a body drawn.
	 */
	public static void setIconGenDrawBody(boolean on) { cacheIconGenDrawBody.setBoolean(on); }
	/**
	 * Method to tell whether generated icons should have a body drawn by default.
	 * The body is just a rectangle.
	 * @return true if generated icons should have a body drawn by default.
	 */
	public static boolean isFactoryIconGenDrawBody() { return cacheIconGenDrawBody.getBooleanFactoryValue(); }

	private static Pref cacheIconGenBodyTextSize = Pref.makeDoublePref("IconGenBodyTextSize", tool.prefs, 2.0);
	/**
	 * Method to tell the size of body text on generated icons.
	 * The default is 2 unit.
	 * @return the size of body text on generated icons.
	 */
	public static double getIconGenBodyTextSize() { return cacheIconGenBodyTextSize.getDouble(); }
	/**
	 * Method to set the size of body text on generated icons.
	 * @param s the size of body text on generated icons.
	 */
	public static void setIconGenBodyTextSize(double s) { cacheIconGenBodyTextSize.setDouble(s); }
	/**
	 * Method to tell the size of body text on generated icons, by default.
	 * @return the size of body text on generated icons, by default.
	 */
	public static double getFactoryIconGenBodyTextSize() { return cacheIconGenBodyTextSize.getDoubleFactoryValue(); }

	private static Pref cacheIconGenReverseExportOrder = Pref.makeBooleanPref("IconGenReverseExportOrder", tool.prefs, false);
	/**
	 * Method to tell whether generated icons should reverse the order of exports.
	 * Normally, exports are drawn top-to-bottom alphabetically.
	 * The default is "false".
	 * @return true if generated icons should reverse the order of exports.
	 */
	public static boolean isIconGenReverseExportOrder() { return cacheIconGenReverseExportOrder.getBoolean(); }
	/**
	 * Method to set whether generated icons should reverse the order of exports.
	 * Normally, exports are drawn top-to-bottom alphabetically.
	 * @param on true if generated icons should reverse the order of exports.
	 */
	public static void setIconGenReverseExportOrder(boolean on) { cacheIconGenReverseExportOrder.setBoolean(on); }
	/**
	 * Method to tell whether generated icons should reverse the order of exports, by default.
	 * Normally, exports are drawn top-to-bottom alphabetically.
	 * @return true if generated icons should reverse the order of exports, by default.
	 */
	public static boolean isFactoryIconGenReverseExportOrder() { return cacheIconGenReverseExportOrder.getBooleanFactoryValue(); }

	private static Pref cacheIconGenInputSide = Pref.makeIntPref("IconGenInputSide", tool.prefs, 0);
	/**
	 * Method to tell where Input ports should go on generated icons.
	 * @return information about where Input ports should go on generated icons.
	 * 0: left (the default)   1: right   2: top   3: bottom
	 */
	public static int getIconGenInputSide() { return cacheIconGenInputSide.getInt(); }
	/**
	 * Method to set where Input ports should go on generated icons.
	 * @param side information about where Input ports should go on generated icons.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static void setIconGenInputSide(int side) { cacheIconGenInputSide.setInt(side); }
	/**
	 * Method to tell where Input ports should go on generated icons, by default.
	 * @return information about where Input ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenInputSide() { return cacheIconGenInputSide.getIntFactoryValue(); }

	private static Pref cacheIconGenOutputSide = Pref.makeIntPref("IconGenOutputSide", tool.prefs, 1);
	/**
	 * Method to tell where Output ports should go on generated icons.
	 * @return information about where Output ports should go on generated icons.
	 * 0: left   1: right (the default)   2: top   3: bottom
	 */
	public static int getIconGenOutputSide() { return cacheIconGenOutputSide.getInt(); }
	/**
	 * Method to set where Output ports should go on generated icons.
	 * @param side information about where Output ports should go on generated icons.
	 * 0: left   1: right (the default)   2: top   3: bottom
	 */
	public static void setIconGenOutputSide(int side) { cacheIconGenOutputSide.setInt(side); }
	/**
	 * Method to tell where Output ports should go on generated icons, by default.
	 * @return information about where Output ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenOutputSide() { return cacheIconGenOutputSide.getIntFactoryValue(); }

	private static Pref cacheIconGenBidirSide = Pref.makeIntPref("IconGenBidirSide", tool.prefs, 2);
	/**
	 * Method to tell where Bidirectional ports should go on generated icons.
	 * @return information about where Bidirectional ports should go on generated icons.
	 * 0: left   1: right   2: top (the default)   3: bottom
	 */
	public static int getIconGenBidirSide() { return cacheIconGenBidirSide.getInt(); }
	/**
	 * Method to set where Bidirectional ports should go on generated icons.
	 * @param side information about where Bidirectional ports should go on generated icons.
	 * 0: left   1: right   2: top (the default)   3: bottom
	 */
	public static void setIconGenBidirSide(int side) { cacheIconGenBidirSide.setInt(side); }
	/**
	 * Method to tell where Bidirectional ports should go on generated icons, by default.
	 * @return information about where Bidirectional ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenBidirSide() { return cacheIconGenBidirSide.getIntFactoryValue(); }

	private static Pref cacheIconGenPowerSide = Pref.makeIntPref("IconGenPowerSide", tool.prefs, 3);
	/**
	 * Method to tell where Power ports should go on generated icons.
	 * @return information about where Power ports should go on generated icons.
	 * 0: left   1: right   2: top   3: bottom (the default)
	 */
	public static int getIconGenPowerSide() { return cacheIconGenPowerSide.getInt(); }
	/**
	 * Method to set where Power ports should go on generated icons.
	 * @param side information about where Power ports should go on generated icons.
	 * 0: left   1: right   2: top   3: bottom (the default)
	 */
	public static void setIconGenPowerSide(int side) { cacheIconGenPowerSide.setInt(side); }
	/**
	 * Method to tell where Power ports should go on generated icons, by default.
	 * @return information about where Power ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenPowerSide() { return cacheIconGenPowerSide.getIntFactoryValue(); }

	private static Pref cacheIconGenGroundSide = Pref.makeIntPref("IconGenGroundSide", tool.prefs, 3);
	/**
	 * Method to tell where Ground ports should go on generated icons.
	 * @return information about where Ground ports should go on generated icons.
	 * 0: left   1: right   2: top   3: bottom (the default)
	 */
	public static int getIconGenGroundSide() { return cacheIconGenGroundSide.getInt(); }
	/**
	 * Method to set where Ground ports should go on generated icons.
	 * @param side information about where Ground ports should go on generated icons.
	 * 0: left   1: right   2: top   3: bottom (the default)
	 */
	public static void setIconGenGroundSide(int side) { cacheIconGenGroundSide.setInt(side); }
	/**
	 * Method to tell where Ground ports should go on generated icons, by default.
	 * @return information about where Ground ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenGroundSide() { return cacheIconGenGroundSide.getIntFactoryValue(); }

	private static Pref cacheIconGenClockSide = Pref.makeIntPref("IconGenClockSide", tool.prefs, 0);
	/**
	 * Method to tell where Clock ports should go on generated icons.
	 * @return information about where Clock ports should go on generated icons.
	 * 0: left (the default)   1: right   2: top   3: bottom
	 */
	public static int getIconGenClockSide() { return cacheIconGenClockSide.getInt(); }
	/**
	 * Method to set where Clock ports should go on generated icons.
	 * @param side information about where Clock ports should go on generated icons.
	 * 0: left (the default)   1: right   2: top   3: bottom
	 */
	public static void setIconGenClockSide(int side) { cacheIconGenClockSide.setInt(side); }
	/**
	 * Method to tell where Clock ports should go on generated icons, by default.
	 * @return information about where Clock ports should go on generated icons, by default.
	 * 0: left   1: right   2: top   3: bottom
	 */
	public static int getFactoryIconGenClockSide() { return cacheIconGenClockSide.getIntFactoryValue(); }

	private static Pref cacheIconGenExportPlacement = Pref.makeIntPref("IconGenExportPlacement", tool.prefs, 0);
	/**
	 * Method to tell how exports are placed in generated icons.
	 * @return information about how exports are placed in generated icons.
	 * 0: by characteristic   1: by location in original cell
	 */
	public static int getIconGenExportPlacement() { return cacheIconGenExportPlacement.getInt(); }
	/**
	 * Method to set how exports are placed in generated icons.
	 * @param rot information about how exports are placed in generated icons.
	 * 0: by characteristic   1: by location in original cell
	 */
	public static void setIconGenExportPlacement(int rot) { cacheIconGenExportPlacement.setInt(rot); }
	/**
	 * Method to tell how exports are placed in generated icons, by default.
	 * @return information about how exports are placed in generated icons, by default.
	 * 0: by characteristic   1: by location in original cell
	 */
	public static int getFactoryIconGenExportPlacement() { return cacheIconGenExportPlacement.getIntFactoryValue(); }

	/**
	 * Flag to specify that generated exports in icons should be placed in the exact location
	 * specified in the schematics.
	 */
	private static Pref cacheIconGenExportPlacementExact = Pref.makeBooleanPref("IconGenExportPlacementExact", tool.prefs, true);
	/**
	 * Method to tell whether exports are placed exactly according to schematics.
	 * Only valid if icon ports are being placed by location.
	 * @return true to place exports exactly according to schematics.
	 * false: to place exports relative to their location in the original cell.
	 */
	public static boolean getIconGenExportPlacementExact() { return cacheIconGenExportPlacementExact.getBoolean(); }
	/**
	 * Method to set whether exports are placed exactly according to schematics.
	 * Only valid if icon ports are being placed by location.
	 * @param flag true to place exports exactly according to schematics.
	 * false: to place exports relative to their location in the original cell.
	 */
	public static void setIconGenExportPlacementExact(boolean flag) { cacheIconGenExportPlacementExact.setBoolean(flag); }
	/**
	 * Method to tell whether exports are placed exactly according to schematics, by default.
	 * Only valid if icon ports are being placed by location.
	 * @return true to place exports exactly according to schematics, by default.
	 * false: to place exports relative to their location in the original cell.
	 */
	public static boolean getFactoryIconGenExportPlacementExact() { return cacheIconGenExportPlacementExact.getBooleanFactoryValue(); }

	private static Pref cacheIconGenInputRot = Pref.makeIntPref("IconGenInputRot", tool.prefs, 0);
	/**
	 * Method to tell what angle Input ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Input ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getIconGenInputRot() { return cacheIconGenInputRot.getInt(); }
	/**
	 * Method to set what angle Input ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @param rot information about what angle Input ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static void setIconGenInputRot(int rot) { cacheIconGenInputRot.setInt(rot); }
	/**
	 * Method to tell what angle Input ports should go on generated icons, by default.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Input ports should go on generated icons, by default.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getFactoryIconGenInputRot() { return cacheIconGenInputRot.getIntFactoryValue(); }

	private static Pref cacheIconGenOutputRot = Pref.makeIntPref("IconGenOutputRot", tool.prefs, 0);
	/**
	 * Method to tell what angle Output ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Output ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getIconGenOutputRot() { return cacheIconGenOutputRot.getInt(); }
	/**
	 * Method to set what angle Output ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @param rot information about what angle Output ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static void setIconGenOutputRot(int rot) { cacheIconGenOutputRot.setInt(rot); }
	/**
	 * Method to tell what angle Output ports should go on generated icons, by default.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Output ports should go on generated icons, by default.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getFactoryIconGenOutputRot() { return cacheIconGenOutputRot.getIntFactoryValue(); }

	private static Pref cacheIconGenBidirRot = Pref.makeIntPref("IconGenBidirRot", tool.prefs, 0);
	/**
	 * Method to tell what angle Bidirectional ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Bidirectional ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getIconGenBidirRot() { return cacheIconGenBidirRot.getInt(); }
	/**
	 * Method to set what angle Bidirectional ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @param rot information about what angle Bidirectional ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static void setIconGenBidirRot(int rot) { cacheIconGenBidirRot.setInt(rot); }
	/**
	 * Method to tell what angle Bidirectional ports should go on generated icons, by default.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Bidirectional ports should go on generated icons, by default.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getFactoryIconGenBidirRot() { return cacheIconGenBidirRot.getIntFactoryValue(); }

	private static Pref cacheIconGenPowerRot = Pref.makeIntPref("IconGenPowerRot", tool.prefs, 0);
	/**
	 * Method to tell what angle Power ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @return information about what angle Power ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */
	public static int getIconGenPowerRot() { return cacheIconGenPowerRot.getInt(); }
	/**
	 * Method to set what angle Power ports should go on generated icons.
	 * This applies only when ports are placed by "characteristic", not "location".
	 * @param rot information about what angle Power ports should go on generated icons.
	 * 0: normal   1: rotate 90 degrees   2: rotate 180 degrees   3: rotate 270 degrees
	 */