com.sun.electric.technology
Enum PrimitiveNode.Function

java.lang.Object
  extended by java.lang.Enum<PrimitiveNode.Function>
      extended by com.sun.electric.technology.PrimitiveNode.Function
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PrimitiveNode.Function>
Enclosing class:
PrimitiveNode

public static enum PrimitiveNode.Function
extends java.lang.Enum<PrimitiveNode.Function>

Function is a typesafe enum class that describes the function of a NodeProto. Functions are technology-independent and include different types of transistors, contacts, and other circuit elements.


Enum Constant Summary
ALIGN
          Describes an alignment object.
ARRAY
          Describes an array.
ART
          Describes a pure artwork.
BASE
          Describes a transistor base.
BUFFER
          Describes a buffer.
CAPAC
          Describes a capacitor.
CCCS
          Describes a current-controlled current source.
CCVS
          Describes a current-controlled voltage source.
COLLECT
          Describes a transistor collector.
CONGROUND
          Describes a ground connection.
CONNECT
          node a node that connects all ports.
CONPOWER
          Describes a power connection.
CONTACT
          Describes a two-layer contact.
DIODE
          Describes a diode.
DIODEZ
          Describes a zener diode.
ECAPAC
          Describes an electrolytic capacitor.
EMIT
          Describes a transistor emitter.
ESDDEVICE
          Describes an esd device
FLIPFLOPDMS
          Describes a D flip-flop with master-slave triggering.
FLIPFLOPDN
          Describes a D flip-flop with negative triggering.
FLIPFLOPDP
          Describes a D flip-flop with positive triggering.
FLIPFLOPJKMS
          Describes a JK flip-flop with master-slave triggering.
FLIPFLOPJKN
          Describes a JK flip-flop with negative triggering.
FLIPFLOPJKP
          Describes a JK flip-flop with positive triggering.
FLIPFLOPRSMS
          Describes a RS flip-flop with master-slave triggering.
FLIPFLOPRSN
          Describes a RS flip-flop with negative triggering.
FLIPFLOPRSP
          Describes a RS flip-flop with positive triggering.
FLIPFLOPTMS
          Describes a T flip-flop with master-slave triggering.
FLIPFLOPTN
          Describes a T flip-flop with negative triggering.
FLIPFLOPTP
          Describes a T flip-flop with positive triggering.
GATEAND
          Describes an AND gate.
GATEOR
          Describes an OR gate.
GATEXOR
          Describes an XOR gate.
INDUCT
          Describes an inductor.
METER
          Describes a meter.
MUX
          Describes a multiplexor.
NODE
          Describes a pure-layer node.
PIN
          Describes a single-layer pin.
PRESIST
          Describes a poly resistor.
RESIST
          Describes a resistor.
SOURCE
          Describes voltage or current source.
SUBSTRATE
          Describes a substrate contact.
TLINE
          Describes a transmission line.
TRA4DMES
          Describes a 4-port MESFET depletion transistor.
TRA4DMOS
          Describes a 4-port MOS depletion transistor.
TRA4EMES
          Describes a 4-port MESFET enhancement transistor.
TRA4NJFET
          Describes a 4-port N-channel junction transistor.
TRA4NMOS
          Describes a 4-port MOS enhancement transistor.
TRA4NPN
          Describes a 4-port NPN junction transistor.
TRA4PJFET
          Describes a 4-port P-channel junction transistor.
TRA4PMOS
          Describes a 4-port MOS complementary transistor.
TRA4PNP
          Describes a 4-port PNP junction transistor.
TRADMES
          Describes a MESFET depletion transistor.
TRADMOS
          Describes a MOS depletion transistor.
TRAEMES
          Describes a MESFET enhancement transistor.
TRANJFET
          Describes a N-channel junction transistor.
TRANMOS
          Describes a MOS enhancement transistor.
TRANPN
          Describes a NPN junction transistor.
TRANS
          Describes an undetermined transistor.
TRANS4
          Describes a general-purpose transistor.
TRANSREF
          Describes a general-purpose transistor.
TRAPJFET
          Describes a P-channel junction transistor.
TRAPMOS
          Describes a MOS complementary transistor.
TRAPNP
          Describes a PNP junction transistor.
UNKNOWN
          Describes a node with unknown behavior.
VCCS
          Describes a voltage-controlled current source.
VCVS
          Describes a voltage-controlled voltage source.
WELL
          Describes a well contact.
WRESIST
          Describes a well resistor.
 
Method Summary
static PrimitiveNode.Function findName(java.lang.String name)
          Method to find a Function from its name.
 Name getBasename()
          Returns a base name of this Function for autonaming.
 java.lang.String getConstantName()
          Returns the constant name for this Function.
static java.util.List<PrimitiveNode.Function> getFunctions()
          Method to return a List of all Functions that exist.
 java.lang.String getName()
          Returns a name of this Function.
 java.lang.String getShortName()
          Returns a short name of this Function.
 boolean isCapacitor()
          Method to tell whether this function describes a capacitor (normal or electrolytic).
 boolean isESDDevice()
          Method to tell whether this function describes an ESD device.
 boolean isFlipFlop()
          Method to tell whether this function describes a flip-flop.
 boolean isResistor()
          Method to tell whether this function describes a resistor (normal, poly or nwell resistor).
 boolean isTransistor()
          Method to tell whether this function describes a transistor.
 java.lang.String toString()
          Returns a printable version of this Function.
static PrimitiveNode.Function valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PrimitiveNode.Function[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UNKNOWN

public static final PrimitiveNode.Function UNKNOWN
Describes a node with unknown behavior.


PIN

public static final PrimitiveNode.Function PIN
Describes a single-layer pin. Pins connects wires of a single layer, have no geometry, and connect in the center of the node.


CONTACT

public static final PrimitiveNode.Function CONTACT
Describes a two-layer contact. Contacts connects wires of two different layers in the center of the node.


NODE

public static final PrimitiveNode.Function NODE
Describes a pure-layer node. Pure-layer nodes have a solid piece of geometry on a single layer.


CONNECT

public static final PrimitiveNode.Function CONNECT
node a node that connects all ports.


TRANMOS

public static final PrimitiveNode.Function TRANMOS
Describes a MOS enhancement transistor. It has gate on the first and third ports, the source on the second port, and the drain on the fourth port.


TRADMOS

public static final PrimitiveNode.Function TRADMOS
Describes a MOS depletion transistor. It has gate on the first and third ports, the source on the second port, and the drain on the fourth port.


TRAPMOS

public static final PrimitiveNode.Function TRAPMOS
Describes a MOS complementary transistor. It has gate on the first and third ports, the source on the second port, and the drain on the fourth port.


TRANPN

public static final PrimitiveNode.Function TRANPN
Describes a NPN junction transistor. It has base on the first port, emitter on the second port, and collector on the third port.


TRAPNP

public static final PrimitiveNode.Function TRAPNP
Describes a PNP junction transistor. It has base on the first port, emitter on the second port, and collector on the third port.


TRANJFET

public static final PrimitiveNode.Function TRANJFET
Describes a N-channel junction transistor. It has gate on the first port, source on the second port, and drain on the third port.


TRAPJFET

public static final PrimitiveNode.Function TRAPJFET
Describes a P-channel junction transistor. It has gate on the first port, source on the second port, and drain on the third port.


TRADMES

public static final PrimitiveNode.Function TRADMES
Describes a MESFET depletion transistor. It has gate on the first port, source on the second port, and drain on the third port.


TRAEMES

public static final PrimitiveNode.Function TRAEMES
Describes a MESFET enhancement transistor. It has gate on the first port, source on the second port, and drain on the third port.


TRANSREF

public static final PrimitiveNode.Function TRANSREF
Describes a general-purpose transistor. It is defined self-referentially by the prototype name of the primitive.


TRANS

public static final PrimitiveNode.Function TRANS
Describes an undetermined transistor. It has gate on the first port, source on the second port, and drain on the third port. The specific transistor type can be determined by examining the value from the NodeInst's "getTechSpecific" method.


TRA4NMOS

public static final PrimitiveNode.Function TRA4NMOS
Describes a 4-port MOS 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.


TRA4DMOS

public static final PrimitiveNode.Function TRA4DMOS
Describes a 4-port MOS 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.


TRA4PMOS

public static final PrimitiveNode.Function TRA4PMOS
Describes a 4-port MOS complementary transistor. It has gate on the first port, source on the second port, drain on the third port, and substrate on the fourth port.


TRA4NPN

public static final PrimitiveNode.Function TRA4NPN
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.


TRA4PNP

public static final PrimitiveNode.Function TRA4PNP
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.


TRA4NJFET

public static final PrimitiveNode.Function TRA4NJFET
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.


TRA4PJFET

public static final PrimitiveNode.Function TRA4PJFET
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.


TRA4DMES

public static final PrimitiveNode.Function TRA4DMES
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.


TRA4EMES

public static final PrimitiveNode.Function TRA4EMES
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.


TRANS4

public static final PrimitiveNode.Function TRANS4
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.


RESIST

public static final PrimitiveNode.Function RESIST
Describes a resistor.


PRESIST

public static final PrimitiveNode.Function PRESIST
Describes a poly resistor.


WRESIST

public static final PrimitiveNode.Function WRESIST
Describes a well resistor.


ESDDEVICE

public static final PrimitiveNode.Function ESDDEVICE
Describes an esd device


CAPAC

public static final PrimitiveNode.Function CAPAC
Describes a capacitor.


ECAPAC

public static final PrimitiveNode.Function ECAPAC
Describes an electrolytic capacitor.


DIODE

public static final PrimitiveNode.Function DIODE
Describes a diode.


DIODEZ

public static final PrimitiveNode.Function DIODEZ
Describes a zener diode.


INDUCT

public static final PrimitiveNode.Function INDUCT
Describes an inductor.


METER

public static final PrimitiveNode.Function METER
Describes a meter.


BASE

public static final PrimitiveNode.Function BASE
Describes a transistor base.


EMIT

public static final PrimitiveNode.Function EMIT
Describes a transistor emitter.


COLLECT

public static final PrimitiveNode.Function COLLECT
Describes a transistor collector.


BUFFER

public static final PrimitiveNode.Function BUFFER
Describes a buffer. It has input on the first port, clocking on the second port, and output on the third port.


GATEAND

public static final PrimitiveNode.Function GATEAND
Describes an AND gate. It has inputs on the first port and output on the second port.


GATEOR

public static final PrimitiveNode.Function GATEOR
Describes an OR gate. It has inputs on the first port and output on the second port.


GATEXOR

public static final PrimitiveNode.Function GATEXOR
Describes an XOR gate. It has inputs on the first port and output on the second port.


FLIPFLOPRSMS

public static final PrimitiveNode.Function FLIPFLOPRSMS
Describes a RS flip-flop with master-slave triggering.


FLIPFLOPRSP

public static final PrimitiveNode.Function FLIPFLOPRSP
Describes a RS flip-flop with positive triggering.


FLIPFLOPRSN

public static final PrimitiveNode.Function FLIPFLOPRSN
Describes a RS flip-flop with negative triggering.


FLIPFLOPJKMS

public static final PrimitiveNode.Function FLIPFLOPJKMS
Describes a JK flip-flop with master-slave triggering.


FLIPFLOPJKP

public static final PrimitiveNode.Function FLIPFLOPJKP
Describes a JK flip-flop with positive triggering.


FLIPFLOPJKN

public static final PrimitiveNode.Function FLIPFLOPJKN
Describes a JK flip-flop with negative triggering.


FLIPFLOPDMS

public static final PrimitiveNode.Function FLIPFLOPDMS
Describes a D flip-flop with master-slave triggering.


FLIPFLOPDP

public static final PrimitiveNode.Function FLIPFLOPDP
Describes a D flip-flop with positive triggering.


FLIPFLOPDN

public static final PrimitiveNode.Function FLIPFLOPDN
Describes a D flip-flop with negative triggering.


FLIPFLOPTMS

public static final PrimitiveNode.Function FLIPFLOPTMS
Describes a T flip-flop with master-slave triggering.


FLIPFLOPTP

public static final PrimitiveNode.Function FLIPFLOPTP
Describes a T flip-flop with positive triggering.


FLIPFLOPTN

public static final PrimitiveNode.Function FLIPFLOPTN
Describes a T flip-flop with negative triggering.


MUX

public static final PrimitiveNode.Function MUX
Describes a multiplexor.


CONPOWER

public static final PrimitiveNode.Function CONPOWER
Describes a power connection.


CONGROUND

public static final PrimitiveNode.Function CONGROUND
Describes a ground connection.


SOURCE

public static final PrimitiveNode.Function SOURCE
Describes voltage or current source.


SUBSTRATE

public static final PrimitiveNode.Function SUBSTRATE
Describes a substrate contact.


WELL

public static final PrimitiveNode.Function WELL
Describes a well contact.


ART

public static final PrimitiveNode.Function ART
Describes a pure artwork.


ARRAY

public static final PrimitiveNode.Function ARRAY
Describes an array.


ALIGN

public static final PrimitiveNode.Function ALIGN
Describes an alignment object.


CCVS

public static final PrimitiveNode.Function CCVS
Describes a current-controlled voltage source.


CCCS

public static final PrimitiveNode.Function CCCS
Describes a current-controlled current source.


VCVS

public static final PrimitiveNode.Function VCVS
Describes a voltage-controlled voltage source.


VCCS

public static final PrimitiveNode.Function VCCS
Describes a voltage-controlled current source.


TLINE

public static final PrimitiveNode.Function TLINE
Describes a transmission line.

Method Detail

values

public static PrimitiveNode.Function[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (PrimitiveNode.Function c : PrimitiveNode.Function.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static PrimitiveNode.Function valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getFunctions

public static java.util.List<PrimitiveNode.Function> getFunctions()
Method to return a List of all Functions that exist.

Returns:
a List of all Functions that exist.

findName

public static PrimitiveNode.Function findName(java.lang.String name)
Method to find a Function from its name.

Parameters:
name - the name to find.
Returns:
a Function (null if not found).

getName

public java.lang.String getName()
Returns a name of this Function.

Returns:
a name of this Function.

getConstantName

public java.lang.String getConstantName()
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.

Returns:
the constant name for this Function.

getShortName

public java.lang.String getShortName()
Returns a short name of this Function.

Returns:
a short name of this Function.

getBasename

public Name getBasename()
Returns a base name of this Function for autonaming.

Returns:
a base name of this Function for autonaming.

isCapacitor

public boolean isCapacitor()
Method to tell whether this function describes a capacitor (normal or electrolytic).

Returns:
true if this function describes a capacitor (normal or electrolytic).

isResistor

public boolean isResistor()
Method to tell whether this function describes a resistor (normal, poly or nwell resistor).

Returns:
true if this function describes a resistor (normal, poly or nwell resistor).

isESDDevice

public boolean isESDDevice()
Method to tell whether this function describes an ESD device.

Returns:
true if this function describes an ESD device.

isTransistor

public boolean isTransistor()
Method to tell whether this function describes a transistor.

Returns:
true if this function describes a transistor.

isFlipFlop

public boolean isFlipFlop()
Method to tell whether this function describes a flip-flop.

Returns:
true if this function describes a flip-flop.

toString

public java.lang.String toString()
Returns a printable version of this Function.

Overrides:
toString in class java.lang.Enum<PrimitiveNode.Function>
Returns:
a printable version of this Function.