com.sun.electric.technology
Enum ArcProto.Function

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

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

Function is a typesafe enum class that describes the function of an ArcProto. Functions are technology-independent and include different types of metal, polysilicon, and other basic wire types.


Enum Constant Summary
BUS
          Describes a bus arc.
DIFF
          Describes an arc on the Diffusion layer.
DIFFN
          Describes an arc on the N-Diffusion layer.
DIFFP
          Describes an arc on the P-Diffusion layer.
DIFFS
          Describes an arc on the Substrate-Diffusion layer.
DIFFW
          Describes an arc on the Well-Diffusion layer.
METAL1
          Describes an arc on Metal layer 1.
METAL10
          Describes an arc on Metal layer 10.
METAL11
          Describes an arc on Metal layer 11.
METAL12
          Describes an arc on Metal layer 12.
METAL2
          Describes an arc on Metal layer 2.
METAL3
          Describes an arc on Metal layer 3.
METAL4
          Describes an arc on Metal layer 4.
METAL5
          Describes an arc on Metal layer 5.
METAL6
          Describes an arc on Metal layer 6.
METAL7
          Describes an arc on Metal layer 7.
METAL8
          Describes an arc on Metal layer 8.
METAL9
          Describes an arc on Metal layer 9.
NONELEC
          Describes an arc that is non-electrical (does not make a circuit connection).
POLY1
          Describes an arc on Polysilicon layer 1.
POLY2
          Describes an arc on Polysilicon layer 2.
POLY3
          Describes an arc on Polysilicon layer 3.
UNKNOWN
          Describes an arc with unknown type.
UNROUTED
          Describes an arc that is unrouted (to be replaced by routers).
WELL
          Describes an arc on the Well layer (bias connections).
 
Method Summary
 java.lang.String getConstantName()
          Returns the constant name for this Function.
static ArcProto.Function getContact(int level)
          Method to find the Function that corresponds to a contact on a given arc.
static java.util.List<ArcProto.Function> getFunctions()
          Method to return a List of all ArcProto functions.
 int getLevel()
          Method to get the level of this ArcProto.Function.
static ArcProto.Function getMetal(int level)
          Method to find the Function that corresponds to Metal on a given layer.
static ArcProto.Function getPoly(int level)
          Method to find the Function that corresponds to Polysilicon on a given layer.
 boolean isDiffusion()
          Method to tell whether this ArcProto.Function is diffusion.
 boolean isMetal()
          Method to tell whether this ArcProto.Function is metal.
 boolean isPoly()
          Method to tell whether this ArcProto.Function is polysilicon.
 java.lang.String toString()
          Returns a printable version of this ArcProto.
static ArcProto.Function valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ArcProto.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 ArcProto.Function UNKNOWN
Describes an arc with unknown type.


METAL1

public static final ArcProto.Function METAL1
Describes an arc on Metal layer 1.


METAL2

public static final ArcProto.Function METAL2
Describes an arc on Metal layer 2.


METAL3

public static final ArcProto.Function METAL3
Describes an arc on Metal layer 3.


METAL4

public static final ArcProto.Function METAL4
Describes an arc on Metal layer 4.


METAL5

public static final ArcProto.Function METAL5
Describes an arc on Metal layer 5.


METAL6

public static final ArcProto.Function METAL6
Describes an arc on Metal layer 6.


METAL7

public static final ArcProto.Function METAL7
Describes an arc on Metal layer 7.


METAL8

public static final ArcProto.Function METAL8
Describes an arc on Metal layer 8.


METAL9

public static final ArcProto.Function METAL9
Describes an arc on Metal layer 9.


METAL10

public static final ArcProto.Function METAL10
Describes an arc on Metal layer 10.


METAL11

public static final ArcProto.Function METAL11
Describes an arc on Metal layer 11.


METAL12

public static final ArcProto.Function METAL12
Describes an arc on Metal layer 12.


POLY1

public static final ArcProto.Function POLY1
Describes an arc on Polysilicon layer 1.


POLY2

public static final ArcProto.Function POLY2
Describes an arc on Polysilicon layer 2.


POLY3

public static final ArcProto.Function POLY3
Describes an arc on Polysilicon layer 3.


DIFF

public static final ArcProto.Function DIFF
Describes an arc on the Diffusion layer.


DIFFP

public static final ArcProto.Function DIFFP
Describes an arc on the P-Diffusion layer.


DIFFN

public static final ArcProto.Function DIFFN
Describes an arc on the N-Diffusion layer.


DIFFS

public static final ArcProto.Function DIFFS
Describes an arc on the Substrate-Diffusion layer.


DIFFW

public static final ArcProto.Function DIFFW
Describes an arc on the Well-Diffusion layer.


WELL

public static final ArcProto.Function WELL
Describes an arc on the Well layer (bias connections).


BUS

public static final ArcProto.Function BUS
Describes a bus arc.


UNROUTED

public static final ArcProto.Function UNROUTED
Describes an arc that is unrouted (to be replaced by routers).


NONELEC

public static final ArcProto.Function NONELEC
Describes an arc that is non-electrical (does not make a circuit connection).

Method Detail

values

public static ArcProto.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 (ArcProto.Function c : ArcProto.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 ArcProto.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

toString

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

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

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.

getFunctions

public static java.util.List<ArcProto.Function> getFunctions()
Method to return a List of all ArcProto functions.

Returns:
a List of all ArcProto functions.

getLevel

public int getLevel()
Method to get the level of this ArcProto.Function. The level applies to metal and polysilicon functions, and gives the layer number (i.e. Metal-2 is level 2).

Returns:
the level of this ArcProto.Function.

getMetal

public static ArcProto.Function getMetal(int level)
Method to find the Function that corresponds to Metal on a given layer.

Parameters:
level - the layer (starting at 1 for Metal-1).
Returns:
the Function that represents that Metal layer.

getPoly

public static ArcProto.Function getPoly(int level)
Method to find the Function that corresponds to Polysilicon on a given layer.

Parameters:
level - the layer (starting at 1 for Polysilicon-1).
Returns:
the Function that represents that Polysilicon layer.

getContact

public static ArcProto.Function getContact(int level)
Method to find the Function that corresponds to a contact on a given arc.

Parameters:
level - the arc (starting at 1 for Contact-1).
Returns:
the Function that represents that Contact arc.

isMetal

public boolean isMetal()
Method to tell whether this ArcProto.Function is metal.

Returns:
true if this ArcProto.Function is metal.

isPoly

public boolean isPoly()
Method to tell whether this ArcProto.Function is polysilicon.

Returns:
true if this ArcProto.Function is polysilicon.

isDiffusion

public boolean isDiffusion()
Method to tell whether this ArcProto.Function is diffusion.

Returns:
true if this ArcProto.Function is diffusion.