primitivenode.java

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

		TRA4PMOSHV3("high-voltage-3-pMOS-4-port-transistor", "pmos-hv3-4", true, false),

		/** Describes a 4-port nMOS native high-voltage (1) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4NMOSNTHV1("native-high-voltage-1-nMOS-4-port-transistor", "nmos-nt-hv1-4", true, false),

		/** Describes a 4-port pMOS native high-threshold (1) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4PMOSNTHV1("native-high-voltage-1-pMOS-4-port-transistor", "pmos-nt-hv1-4", true, false),

		/** Describes a 4-port nMOS native higher-voltage (2) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4NMOSNTHV2("native-high-voltage-2-nMOS-4-port-transistor", "nmos-nt-hv2-4", true, false),

		/** Describes a 4-port pMOS native higher-threshold (2) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4PMOSNTHV2("native-high-voltage-2-pMOS-4-port-transistor", "pmos-nt-hv2-4", true, false),

		/** Describes a 4-port nMOS native highest-voltage (3) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4NMOSNTHV3("native-high-voltage-3-nMOS-4-port-transistor", "nmos-nt-hv3-4", true, false),

		/** Describes a 4-port pMOS native highest-threshold (3) transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4PMOSNTHV3("native-high-voltage-3-pMOS-4-port-transistor", "pmos-nt-hv3-4", true, false),

		/** Describes a 4-port NPN junction transistor.
		 * It has base on the first port, emitter on the second port, collector on the third port, and substrate on the fourth port. */
		TRA4NPN("NPN-4-port-transistor", "npn-4", true, false),

		/** Describes a 4-port PNP junction transistor.
		 * It has base on the first port, emitter on the second port, collector on the third port, and substrate on the fourth port. */
		TRA4PNP("PNP-4-port-transistor", "pnp-4", true, false),

		/** Describes a 4-port N-channel junction transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4NJFET("n-type-JFET-4-port-transistor", "njfet-4", true, false),

		/** Describes a 4-port P-channel junction transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4PJFET("p-type-JFET-4-port-transistor", "pjfet-4", true, false),

		/** Describes a 4-port MESFET depletion transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4DMES("4-port-depletion-mesfet", "dmes-4", true, false),

		/** Describes a 4-port MESFET enhancement transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port. */
		TRA4EMES("4-port-enhancement-mesfet", "emes-4", true, false),

		/** Describes a general-purpose transistor.
		 * It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port.
		 * The specific transistor type can be determined by examining the value from the NodeInst's "getTechSpecific" method. */
		TRANS4("4-port-transistor", "trans-4", true, false),

		/** Describes a resistor. */
		RESIST("resistor", "res", false, false),

		/** Describes a poly resistor. */
		//@Deprecated
		PRESIST("poly-resistor", "pres", false, false),

		/** Describes an n-poly resistor */
		RESNPOLY("n-type-poly-resistor", "resnpoly", false, false),

		/** Describes a p-poly resistor */
		RESPPOLY("p-type-poly-resistor", "resppoly", false, false),

		/** Describes a well resistor. */
		//@Deprecated
		WRESIST("well-resistor", "wres", false, false),

		/** Describes an n-well resistor */
		RESNWELL("n-type-well-resistor", "resnwell", false, false),

		/** Describes a p-well resistor */
		RESPWELL("p-type-well-resistor", "respwell", false, false),

		/** Describes an esd device */
		ESDDEVICE("esd-device", "esdd", false, false),

		/** Describes a capacitor. */
		CAPAC("capacitor", "cap", false, false),

		/** Describes an electrolytic capacitor. */
		ECAPAC("electrolytic-capacitor", "ecap", false, false),

		/** Describes a diode. */
		DIODE("diode", "diode", false, false),

		/** Describes a zener diode. */
		DIODEZ("zener-diode", "zdiode", false, false),

		/** Describes an inductor. */
		INDUCT("inductor", "ind", false, false),

		/** Describes a meter. */
		METER("meter", "meter", false, false),

		/** Describes a transistor base. */
		BASE("base", "base", false, false),

		/** Describes a transistor emitter. */
		EMIT("emitter", "emit", false, false),

		/** Describes a transistor collector. */
		COLLECT("collector", "coll", false, false),

		/** Describes a buffer.
		 * It has input on the first port, clocking on the second port, and output on the third port. */
		BUFFER("buffer", "buf", false, false),

		/** Describes an AND gate.
		 * It has inputs on the first port and output on the second port. */
		GATEAND("AND-gate", "and", false, false),

		/** Describes an OR gate.
		 * It has inputs on the first port and output on the second port. */
		GATEOR("OR-gate", "or", false, false),

		/** Describes an XOR gate.
		 * It has inputs on the first port and output on the second port. */
		GATEXOR("XOR-gate", "xor", false, false),

		/** Describes a RS flip-flop with master-slave triggering. */
		FLIPFLOPRSMS("flip-flop-RS-MS", "ffRSms", false, true),

		/** Describes a RS flip-flop with positive triggering. */
		FLIPFLOPRSP("flip-flop-RS-P", "ffRSp", false, true),

		/** Describes a RS flip-flop with negative triggering. */
		FLIPFLOPRSN("flip-flop-RS-N", "ffRSn", false, true),

		/** Describes a JK flip-flop with master-slave triggering. */
		FLIPFLOPJKMS("flip-flop-JK-MS", "ffJKms", false, true),

		/** Describes a JK flip-flop with positive triggering. */
		FLIPFLOPJKP("flip-flop-JK-P", "ffJKp", false, true),

		/** Describes a JK flip-flop with negative triggering. */
		FLIPFLOPJKN("flip-flop-JK-N", "ffJKn", false, true),

		/** Describes a D flip-flop with master-slave triggering. */
		FLIPFLOPDMS("flip-flop-D-MS", "ffDms", false, true),

		/** Describes a D flip-flop with positive triggering. */
		FLIPFLOPDP("flip-flop-D-P", "ffDp", false, true),

		/** Describes a D flip-flop with negative triggering. */
		FLIPFLOPDN("flip-flop-D-N", "ffDn", false, true),

		/** Describes a T flip-flop with master-slave triggering. */
		FLIPFLOPTMS("flip-flop-T-MS", "ffTms", false, true),

		/** Describes a T flip-flop with positive triggering. */
		FLIPFLOPTP("flip-flop-T-P", "ffTp", false, true),

		/** Describes a T flip-flop with negative triggering. */
		FLIPFLOPTN("flip-flop-T-N", "ffTn", false, true),

		/** Describes a multiplexor. */
		MUX("multiplexor", "mux", false, false),

		/** Describes a power connection. */
		CONPOWER("power", "pwr", false, false),

		/** Describes a ground connection. */
		CONGROUND("ground", "gnd", false, false),

		/** Describes voltage or current source. */
		SOURCE("source", "source", false, false),

		/** Describes a substrate contact. */
		SUBSTRATE("substrate", "substr", false, false),

		/** Describes a well contact. */
		WELL("well", "well", false, false),

		/** Describes a pure artwork. */
		ART("artwork", "art", false, false),

		/** Describes an array. */
		ARRAY("array", "array", false, false),

		/** Describes an alignment object. */
		ALIGN("align", "align", false, false),

		/** Describes a current-controlled voltage source. */
		CCVS("ccvs", "ccvs", false, false),

		/** Describes a current-controlled current source. */
		CCCS("cccs", "cccs", false, false),

		/** Describes a voltage-controlled voltage source. */
		VCVS("vcvs", "vcvs", false, false),

		/** Describes a voltage-controlled current source. */
		VCCS("vccs", "vccs", false, false),

		/** Describes a transmission line. */
		TLINE("transmission-line", "transm", false, false);

		private final String name;
		private final String shortName;
		private final Name basename;
		private final boolean isTransistor;
		private final boolean isFlipFlop;

		private Function(String name, String shortName, boolean isTransistor, boolean isFlipFlop)
		{
			this.name = name;
			this.shortName = shortName;
			this.basename = Name.findName(TextUtils.canonicString(shortName)+"@0").getBasename();
			this.isTransistor = isTransistor;
			this.isFlipFlop = isFlipFlop;
		}

		/**
		 * Method to return a List of all Functions that exist.
		 * @return a List of all Functions that exist.
		 */
		public static List<Function> getFunctions() { return Arrays.asList(Function.class.getEnumConstants()); }

		/**
		 * Method to find a Function from its name.
		 * @param name the name to find.
		 * @return a Function (null if not found).
		 */
		public static Function findName(String name)
		{
			List<Function> allFuncs = getFunctions();
			for(Function fun : allFuncs)
			{
				if (fun.name.equalsIgnoreCase(name)) return fun;
			}
			return null;
		}

		/**
		 * Returns a name of this Function.
		 * @return a name of this Function.
		 */
		public String getName() { return name; }

		/**
		 * Returns the constant name for this Function.
		 * Constant names are used when writing Java code, so they must be the same as the actual symbol name.
		 * @return the constant name for this Function.
		 */
		public String getConstantName() { return name(); }

		/**
		 * Returns a short name of this Function.
		 * @return a short name of this Function.
		 */
		public String getShortName() { return shortName; }

		/**
		 * Returns a base name of this Function for autonaming.
		 * @return a base name of this Function for autonaming.
		 */
		public Name getBasename() { return basename; }

        /**
         * Method to tell whether this function describes a capacitor (normal or electrolytic).
         * @return true if this function describes a capacitor (normal or electrolytic).
         */
        public boolean isCapacitor() { return this == CAPAC || this == ECAPAC; }

        /**
         * Method to tell whether this function describes a resistor (normal, poly or nwell resistor).
         * @return true if this function describes a resistor (normal, poly or nwell resistor).
         */
        public boolean isResistor() { return this == RESIST || this == PRESIST || this == WRESIST ||
                                      this == RESNPOLY || this == RESPPOLY || this == RESNWELL ||
                                      this == RESPWELL;}

        /**
         * Method to tell whether this function describes a poly or well resistor.
         * @return true if this function describes a poly or well resistor.
         */
        public boolean isPolyOrWellResistor() { return this == PRESIST || this == WRESIST ||
                                      this == RESNPOLY || this == RESPPOLY || this == RESNWELL || this == RESPWELL;}

        /**
         * Method to tell whether this function describes an ESD device.
         * @return true if this function describes an ESD device.
         */
        public boolean isESDDevice() {return this == ESDDEVICE;}