com.sun.electric.tool.ncc.basic
Class NccCellAnnotations

java.lang.Object
  extended by com.sun.electric.tool.ncc.basic.NccCellAnnotations

public class NccCellAnnotations
extends java.lang.Object

Representation of the NCC annotations that a user may place on a Cell


Nested Class Summary
static class NccCellAnnotations.NamePattern
           
 
Field Summary
static Variable.Key NCC_ANNOTATION_KEY
          key of Variable holding NCC Cell annotations.
 
Method Summary
static void addNccAnnotation(Cell c, java.lang.String newAnnotation)
          Add an NCC annotation to a Cell.
 boolean flattenInstance(java.lang.String instName)
           
static NccCellAnnotations getAnnotations(Cell cell)
          Method to get the NCC annotations on a Cell.
 java.util.Iterator<java.lang.String> getAnnotationText()
           
 java.lang.String getBlackBoxReason()
           
 java.util.Iterator<java.util.List<NccCellAnnotations.NamePattern>> getExportsConnected()
           
 java.util.List<java.lang.String> getForcePartMatches()
           
 java.util.List<java.lang.String> getForceWireMatches()
           
 Cell.CellGroup getGroupToJoin()
           
 java.lang.String getNotSubcircuitReason()
           
 java.lang.String getResistorType()
           
 java.lang.String getSkipReason()
           
 java.lang.String getTransistorType()
           
static void makeNCCAnnotationMenuCommand(java.lang.String newAnnotation)
          Method to create NCC annotations in the current Cell.
 boolean renameExport(java.lang.String exportName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NCC_ANNOTATION_KEY

public static final Variable.Key NCC_ANNOTATION_KEY
key of Variable holding NCC Cell annotations.

Method Detail

makeNCCAnnotationMenuCommand

public static void makeNCCAnnotationMenuCommand(java.lang.String newAnnotation)
Method to create NCC annotations in the current Cell. Called from the menu commands.


addNccAnnotation

public static void addNccAnnotation(Cell c,
                                    java.lang.String newAnnotation)
Add an NCC annotation to a Cell.


getAnnotations

public static NccCellAnnotations getAnnotations(Cell cell)
Method to get the NCC annotations on a Cell.

Parameters:
cell - the Cell to query.
Returns:
the NccCellAnnotations for the Cell. Returns null if the Cell has no NCC annotations

getSkipReason

public java.lang.String getSkipReason()
Returns:
a String which is the reason given by the user for not NCCing the cell or null if there is no skipNCC annotation on the cell.

getNotSubcircuitReason

public java.lang.String getNotSubcircuitReason()
Returns:
the reason given by the user for not treating this Cell as a subcircuit during hierarchical NCC. Return null if there is no notSubcircuitReason annotation on the Cell

getExportsConnected

public java.util.Iterator<java.util.List<NccCellAnnotations.NamePattern>> getExportsConnected()
Returns:
an Iterator over Lists of NamePatterns. Each List specifies the names (or regular expressions that match the names) of Exports that the user expects to be connected by the Cell's parent.

getAnnotationText

public java.util.Iterator<java.lang.String> getAnnotationText()

getGroupToJoin

public Cell.CellGroup getGroupToJoin()

flattenInstance

public boolean flattenInstance(java.lang.String instName)

renameExport

public boolean renameExport(java.lang.String exportName)

getBlackBoxReason

public java.lang.String getBlackBoxReason()
Returns:
the reason given by the user for block boxing this Cell. return null if there is no blackBox annotation.

getTransistorType

public java.lang.String getTransistorType()
Returns:
the transistor type if Cell has a transitorType annotation. Otherwise return null.

getResistorType

public java.lang.String getResistorType()
Returns:
the resistor type if Cell has a resistorType annotation. Otherwise return null.

getForceWireMatches

public java.util.List<java.lang.String> getForceWireMatches()
Returns:
the names of Wires for which we should force matches

getForcePartMatches

public java.util.List<java.lang.String> getForcePartMatches()
Returns:
the names of Wires for which we should force matches