com.sun.electric.database.hierarchy
Class View

java.lang.Object
  extended by com.sun.electric.database.hierarchy.View
All Implemented Interfaces:
java.lang.Comparable<View>

public class View
extends java.lang.Object
implements java.lang.Comparable<View>

A View is an object that represents a style of design, for example schematic, layout, etc. Each Cell has a View associated with it. Views have full names (such as "layout") and abbreviations which are used in cell names (for example "gate{lay}").

Electric has a set of Views at the start, and users can define their own.


Field Summary
static View DOC
          Defines the Documentation view (a text view).
static View DOCWAVE
          Defines the simulation snapshot view.
static View ICON
          Defines the Icon view.
static View LAYOUT
          Defines the Layout view.
static View LAYOUTCOMP
          Defines the Compensated view.
static View LAYOUTSKEL
          Defines the Skeleton view.
static View NETLIST
          Defines the general Netlist view (a text view).
static View NETLISTALS
          Defines the ALS (netlist) view (a text view).
static View NETLISTNETLISP
          Defines the NetLisp (netlist) view (a text view).
static View NETLISTQUISC
          Defines the QUISC (netlist) view (a text view).
static View NETLISTRSIM
          Defines the RSIM (netlist) view (a text view).
static View NETLISTSILOS
          Defines the SILOS (netlist) view (a text view).
static View SCHEMATIC
          Defines the Schematic view.
static View UNKNOWN
          Defines the unknown view.
static View VERILOG
          Defines the Verilog view (a text view).
static View VHDL
          Defines the VHDL view (a text view).
 
Method Summary
 int compareTo(View that)
          Compares two View objects.
static View findView(java.lang.String name)
          Method to return a View using its full or short name.
 java.lang.String getAbbreviation()
          Method to return the short name of this View.
 java.lang.String getAbbreviationExtension()
          Method to return the string containing the extension to be used for cell names
 java.lang.String getFullName()
          Method to return the full name of this View.
static int getNumViews()
          Method to return the number of views.
 int getOrder()
          Method to get the ordering of this View for sorting.
static java.util.List<View> getOrderedViews()
          Method to return a List of all libraries, sorted by name.
static java.util.Iterator<View> getViews()
          Method to return an iterator over the views.
 boolean isPermanentView()
          Method to return true if this View is permanent.
 boolean isTextView()
          Method to return true if this View is Text-only.
 void kill()
          Method to delete this View.
static View newInstance(java.lang.String fullName, java.lang.String abbreviation)
          Method to create a View with the given name.
static View newTextInstance(java.lang.String fullName, java.lang.String abbreviation)
          Method to create a Text-only View with the given name.
 java.lang.String toString()
          Returns a printable version of this View.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SCHEMATIC

public static final View SCHEMATIC
Defines the Schematic view.


ICON

public static final View ICON
Defines the Icon view. This is used in schematics to represent instances. Cells with this view typically use primitives from the Artwork Technology.


LAYOUT

public static final View LAYOUT
Defines the Layout view.


LAYOUTSKEL

public static final View LAYOUTSKEL
Defines the Skeleton view. Cells with this view contains only a protection frame or other dummy version of true layout.


LAYOUTCOMP

public static final View LAYOUTCOMP
Defines the Compensated view. Cells with this view contains compensated layout (adjusted for fabrication).


VHDL

public static final View VHDL
Defines the VHDL view (a text view). Cells with this view contains a textual description in the VHDL hardware-description language. The text is located in the "FACET_message" variable on the cell.


VERILOG

public static final View VERILOG
Defines the Verilog view (a text view). Cells with this view contains a textual description in the Verilog hardware-description language. The text is located in the "FACET_message" variable on the cell.


DOC

public static final View DOC
Defines the Documentation view (a text view). Cells with this view contain documentation for other cells in the cell group. The text is located in the "FACET_message" variable on the cell.


DOCWAVE

public static final View DOCWAVE
Defines the simulation snapshot view. Cells with this view contain snapshots of the simulation waveform window.


NETLIST

public static final View NETLIST
Defines the general Netlist view (a text view). Cells with this view contain an unknown format netlist. The text is located in the "FACET_message" variable on the cell.


NETLISTNETLISP

public static final View NETLISTNETLISP
Defines the NetLisp (netlist) view (a text view). Cells with this view contain a "netlisp" format netlist (for simulation). The text is located in the "FACET_message" variable on the cell.


NETLISTRSIM

public static final View NETLISTRSIM
Defines the RSIM (netlist) view (a text view). Cells with this view contain an "RSIM" format netlist (for simulation). The text is located in the "FACET_message" variable on the cell.


NETLISTSILOS

public static final View NETLISTSILOS
Defines the SILOS (netlist) view (a text view). Cells with this view contain a "SILOS" format netlist (for simulation). The text is located in the "FACET_message" variable on the cell.


NETLISTQUISC

public static final View NETLISTQUISC
Defines the QUISC (netlist) view (a text view). Cells with this view contain an "QUISC" format netlist (for place-and-route by the QUISC Silicon Compiler). The text is located in the "FACET_message" variable on the cell.


NETLISTALS

public static final View NETLISTALS
Defines the ALS (netlist) view (a text view). Cells with this view contain an "ALS" format netlist (for simulation). The text is located in the "FACET_message" variable on the cell.


UNKNOWN

public static final View UNKNOWN
Defines the unknown view. This view has an empty abbreviation.

Method Detail

newInstance

public static View newInstance(java.lang.String fullName,
                               java.lang.String abbreviation)
Method to create a View with the given name.

Parameters:
fullName - the full name of the View, for example "layout".
abbreviation - the short name of the View, for example "lay". The short name is used inside of braces when naming a cell (for example "gate{lay}").
Returns:
the newly created View.

newTextInstance

public static View newTextInstance(java.lang.String fullName,
                                   java.lang.String abbreviation)
Method to create a Text-only View with the given name. Cells with text-only views have no nodes or arcs, just text.

Parameters:
fullName - the full name of the View, for example "documentation".
abbreviation - the short name of the View, for example "doc". The short name is used inside of braces when naming a cell (for example "gate{doc}").
Returns:
the newly created Text-only View.

kill

public void kill()
Method to delete this View.


findView

public static View findView(java.lang.String name)
Method to return a View using its full or short name.

Parameters:
name - the name of the View.
Returns:
the named View, or null if no such View exists.

getFullName

public java.lang.String getFullName()
Method to return the full name of this View.

Returns:
the full name of this View.

getAbbreviation

public java.lang.String getAbbreviation()
Method to return the short name of this View. The short name is used inside of braces when naming a cell (for example "gate{doc}").

Returns:
the short name of this View.

getAbbreviationExtension

public java.lang.String getAbbreviationExtension()
Method to return the string containing the extension to be used for cell names

Returns:
the short name of this View with appropiated parentesis

getOrder

public int getOrder()
Method to get the ordering of this View for sorting.

Returns:
the ordering this View.

isTextView

public boolean isTextView()
Method to return true if this View is Text-only. Cells with text-only views have no nodes or arcs, just text.

Returns:
true if this View is Text-only.

isPermanentView

public boolean isPermanentView()
Method to return true if this View is permanent. Permanent views are those that are created initially, and cannot be deleted.

Returns:
true if this View is permanent.

getViews

public static java.util.Iterator<View> getViews()
Method to return an iterator over the views.

Returns:
an iterator over the views.

getNumViews

public static int getNumViews()
Method to return the number of views.

Returns:
the number of views.

getOrderedViews

public static java.util.List<View> getOrderedViews()
Method to return a List of all libraries, sorted by name. The list excludes hidden libraries (i.e. the clipboard).

Returns:
a List of all libraries, sorted by name.

compareTo

public int compareTo(View that)
Compares two View objects.

Specified by:
compareTo in interface java.lang.Comparable<View>
Parameters:
that - the View to be compared.
Returns:
the result of comparison.

toString

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

Overrides:
toString in class java.lang.Object
Returns:
a printable version of this View.