com.sun.electric.database.network
Class Network

java.lang.Object
  extended by com.sun.electric.database.network.Network

public class Network
extends java.lang.Object

Networks represent connectivity.

For a Cell, each Network represents a collection of PortInsts that are electrically connected.


Method Summary
 java.lang.String describe(boolean withQuotes)
          Method to describe this Network as a string.
 Export findExportWithSameCharacteristic(PortProto p)
           
 java.util.Iterator<ArcInst> getArcs()
          Get iterator over all ArcInsts on Network
 java.util.Iterator<java.lang.String> getExportedNames()
          A net can have multiple names.
 java.util.Iterator<Export> getExports()
          Get iterator over all Exports on Network
 java.util.Iterator<Global> getGlobals()
          Get iterator over all Globals on Network
 java.lang.String getName()
          Returns most appropriate name of the net.
 java.util.Iterator<java.lang.String> getNames()
          A net can have multiple names.
 int getNetIndex()
          Returns index of this Network in netlist.
 Netlist getNetlist()
          Returns the Netlist of this Network.
 java.util.Iterator<NodeInst> getNodes()
          Get iterator over all NodeInsts on Network.
 Cell getParent()
          Returns parent cell of this Network.
 java.util.Iterator<PortInst> getPorts()
          Get iterator over all PortInsts on Network.
 java.util.List<PortInst> getPortsList()
           
 boolean hasName(java.lang.String nm)
          Returns true if nm is one of Network's names
 boolean isExported()
          Method to tell whether this network has any exports or globals on it.
 boolean isUsernamed()
          Method to tell whether this network has user-defined name.
 java.lang.String toString()
          Returns a printable version of this Network.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getNetlist

public Netlist getNetlist()
Returns the Netlist of this Network.

Returns:
Netlist of this Network.

getParent

public Cell getParent()
Returns parent cell of this Network.

Returns:
parent cell of this Network.

getNetIndex

public int getNetIndex()
Returns index of this Network in netlist.


getNames

public java.util.Iterator<java.lang.String> getNames()
A net can have multiple names. Return alphabetized list of names.


getExportedNames

public java.util.Iterator<java.lang.String> getExportedNames()
A net can have multiple names. Return alphabetized list of names.


getName

public java.lang.String getName()
Returns most appropriate name of the net. Intitialized net has at least one name - user-defiend or temporary.


hasName

public boolean hasName(java.lang.String nm)
Returns true if nm is one of Network's names


getPorts

public java.util.Iterator<PortInst> getPorts()
Get iterator over all PortInsts on Network. Note that the PortFilter class is useful for filtering out frequently excluded PortInsts.


getPortsList

public java.util.List<PortInst> getPortsList()

getNodes

public java.util.Iterator<NodeInst> getNodes()
Get iterator over all NodeInsts on Network.


getGlobals

public java.util.Iterator<Global> getGlobals()
Get iterator over all Globals on Network


getExports

public java.util.Iterator<Export> getExports()
Get iterator over all Exports on Network


getArcs

public java.util.Iterator<ArcInst> getArcs()
Get iterator over all ArcInsts on Network


isExported

public boolean isExported()
Method to tell whether this network has any exports or globals on it.

Returns:
true if there are exports or globals on this Network.

isUsernamed

public boolean isUsernamed()
Method to tell whether this network has user-defined name.

Returns:
true if this Network has user-defined name.

describe

public java.lang.String describe(boolean withQuotes)
Method to describe this Network as a string.

Parameters:
withQuotes - to wrap description between quotes
Returns:
a String describing this Network.

findExportWithSameCharacteristic

public Export findExportWithSameCharacteristic(PortProto p)

toString

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

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