EDIFCell

Object
- com.xilinx.rapidwright.edif.EDIFName
- - com.xilinx.rapidwright.edif.EDIFPropertyObject
  - - com.xilinx.rapidwright.edif.EDIFCell

All Implemented Interfaces:

Comparable<EDIFName>
```
public class EDIFCell
extends EDIFPropertyObject
```
Represent a logical cell in an EDIF netlist. Can be both a leaf cell or a hierarchical cell. Created on: May 11, 2017

Field Summary

Fields
Modifier and Type	Field and Description
`static EDIFName`	`DEFAULT_VIEW`
`static byte[]`	`EXPORT_CONST_CELL_BEGIN`
`static byte[]`	`EXPORT_CONST_CELL_END`
`static byte[]`	`EXPORT_CONST_CELLTYPE`
`static byte[]`	`EXPORT_CONST_CONTENTS`
`static byte[]`	`EXPORT_CONST_CONTENTS_END`
`static byte[]`	`EXPORT_CONST_INTERFACE_END`
`static byte[]`	`EXPORT_CONST_PROP_INDENT`
`static byte[]`	`EXPORT_CONST_VIEW_END`
`static byte[]`	`EXPORT_CONST_VIEWTYPE`

Fields inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject
EXPORT_CONST_OWNER_END, EXPORT_CONST_OWNER_START, EXPORT_CONST_PROP_END, EXPORT_CONST_PROP_START

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName
EXPORT_CONST_RENAME_START

Constructor Summary

Constructors
Constructor and Description
`EDIFCell(EDIFCell orig)` Shallow Copy constructor - Creates a new EDIFCell object, EDIFCell contents point to orig.
`EDIFCell(EDIFLibrary lib, EDIFCell orig)` Shallow Copy constructor - Creates a new EDIFCell object, EDIFCell contents point to orig.
`EDIFCell(EDIFLibrary lib, EDIFCell orig, String newCellName)` Full Deep Copy Constructor with rename
`EDIFCell(EDIFLibrary lib, String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EDIFCellInst`	`addCellInst(EDIFCellInst instance)` Adds the instance to this cell.
`EDIFCellInst`	`addCellInstUniqueName(EDIFCellInst instance)` Ensures that the provided cell instance is added to this cell by renaming it to something unique.
`void`	`addInternalPortMapEntry(String portInstName, EDIFNet internalNet)` Populates an internal map between port-based port ref name, 'bus[3]' or 'clk'.
`EDIFNet`	`addNet(EDIFNet net)` Adds a net to the cell.
`EDIFCellInst`	`addNewCellInstUniqueName(String suggestedName, EDIFCell reference)`
`EDIFPort`	`addPort(EDIFPort port)` Adds a port to the cell.
`EDIFCellInst`	`createCellInst(String name, EDIFCell parent)`
`EDIFCellInst`	`createChildCellInst(String name, EDIFCell reference)`
`EDIFNet`	`createNet(String name)`
`EDIFPort`	`createPort(EDIFPort port)`
`EDIFPort`	`createPort(String name, EDIFDirection direction, int width)`
`void`	`decrementNonHierInstantiationCount()` Atomically decrement instance count of this cell.
`boolean`	`equals(Object o)`
`void`	`exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache)`
`void`	`exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache, boolean stable)`
`List<EDIFHierCellInst>`	`getAllLeafDescendants()` Recursively finds all leaf cell descendants of this cell The returned EDIFHierCellInsts are relative to this cell.
`List<EDIFHierCellInst>`	`getAllLeafDescendants(EDIFHierCellInst parentInstance)` Recursively finds all leaf cell descendants of this cell
`EDIFCellInst`	`getCellInst(String name)`
`Collection<EDIFCellInst>`	`getCellInsts()`
`EDIFName`	`getEDIFView()` Gets the EDIFName object representation of the view name
`EDIFNet`	`getInternalNet(EDIFPortInst portInst)` Takes an external (or internal) port ref and returns the corresponding EDIFNet connected inside the cell.
`EDIFNet`	`getInternalNet(String portInstName)` Takes an external (or internal) port name and returns the corresponding EDIFNet connected inside the cell.
`Map<String,EDIFNet>`	`getInternalNetMap()`
`EDIFLibrary`	`getLibrary()`
`EDIFNet`	`getNet(EDIFNet net)`
`EDIFNet`	`getNet(String name)`
`EDIFNetlist`	`getNetlist()`
`Collection<EDIFNet>`	`getNets()`
`int`	`getNonHierInstantiationCount()`
`EDIFPort`	`getPort(String name)` Gets a port by bus name (see `EDIFPort.getBusName()`).
`EDIFPort`	`getPortByLegalName(String name, EDIFReadLegalNameCache cache)`
`EDIFPort`	`getPortByPortInstName(String portInstName)` Given a port instance name (not including the name of the cell instance), gets the associated port.
`Map<String,EDIFPort>`	`getPortMap()`
`Collection<EDIFPort>`	`getPorts()`
`String`	`getView()` Gets the original view name
`boolean`	`hasCompatibleInterface(EDIFCell cell)` Checks if all the port on the provided cell match and are equal to the ports on this cell.
`boolean`	`hasContents()`
`int`	`hashCode()`
`void`	`incrementNonHierInstantiationCount()` Atomically increment instance count of this cell.
`boolean`	`isGNDSource()`
`boolean`	`isLeafCellOrBlackBox()`
`boolean`	`isPrimitive()`
`boolean`	`isStaticSource()`
`boolean`	`isUniquified()` True if this cell is instantiated no more than once.
`boolean`	`isVCCSource()`
`void`	`makePrimitive()` Deletes internal representation.
`void`	`moveToLibrary(EDIFLibrary newLibrary)`
`EDIFCellInst`	`removeCellInst(EDIFCellInst cellInstance)`
`EDIFCellInst`	`removeCellInst(String name)`
`EDIFNet`	`removeInternalPortMapEntry(String portInstName)` Removes the entry within the cell internal net map (when removing a port on a cell).
`EDIFNet`	`removeNet(EDIFNet net)`
`EDIFNet`	`removeNet(String name)`
`void`	`removePort(EDIFPort port)`
`void`	`rename(String newName)`
`EDIFCellInst`	`renameCellInst(EDIFCellInst i, String newName)` Renames the provided instance i with newName.
`void`	`setLibrary(EDIFLibrary library)`
`void`	`setView(EDIFName view)`
`void`	`setView(String view)`
`void`	`sortEDIFPortInstLists()`
`void`	`trackChange(EDIFChangeType type, String name)`

Methods inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject
addProperty, addProperty, addProperty, addProperty, addProperty, createDuplicatePropertiesMap, exportEDIFProperties, getIOStandard, getPropertiesMap, getProperty, removeProperty, setPropertiesMap

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName
compareTo, exportEDIFName, exportSomeEDIFName, getName, getNewMap, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_VIEW
```
public static final EDIFName DEFAULT_VIEW
```
  - EXPORT_CONST_CELL_BEGIN
```
public static final byte[] EXPORT_CONST_CELL_BEGIN
```
  - EXPORT_CONST_CELLTYPE
```
public static final byte[] EXPORT_CONST_CELLTYPE
```
  - EXPORT_CONST_VIEWTYPE
```
public static final byte[] EXPORT_CONST_VIEWTYPE
```
  - EXPORT_CONST_INTERFACE_END
```
public static final byte[] EXPORT_CONST_INTERFACE_END
```
  - EXPORT_CONST_CONTENTS
```
public static final byte[] EXPORT_CONST_CONTENTS
```
  - EXPORT_CONST_CONTENTS_END
```
public static final byte[] EXPORT_CONST_CONTENTS_END
```
  - EXPORT_CONST_VIEW_END
```
public static final byte[] EXPORT_CONST_VIEW_END
```
  - EXPORT_CONST_CELL_END
```
public static final byte[] EXPORT_CONST_CELL_END
```
  - EXPORT_CONST_PROP_INDENT
```
public static final byte[] EXPORT_CONST_PROP_INDENT
```
- Constructor Detail
  - EDIFCell
```
public EDIFCell(EDIFLibrary lib,
                String name)
```
  - EDIFCell
```
public EDIFCell(EDIFCell orig)
```
    Shallow Copy constructor - Creates a new EDIFCell object, EDIFCell contents point to orig.
    
    Parameters:
    
    orig - The original cell
  - EDIFCell
```
public EDIFCell(EDIFLibrary lib,
                EDIFCell orig)
```
    Shallow Copy constructor - Creates a new EDIFCell object, EDIFCell contents point to orig.
    
    Parameters:
    
    lib - Destination library of the copied cell.
    
    orig - The original cell
  - EDIFCell
```
public EDIFCell(EDIFLibrary lib,
                EDIFCell orig,
                String newCellName)
```
    Full Deep Copy Constructor with rename
    
    Parameters:
    
    lib - Destination library of the new cell
    
    orig - Prototype of the original cell
    
    newCellName - Name of the new cell copy
- Method Detail
  - createChildCellInst
```
public EDIFCellInst createChildCellInst(String name,
                                        EDIFCell reference)
```
  - addNewCellInstUniqueName
```
public EDIFCellInst addNewCellInstUniqueName(String suggestedName,
                                             EDIFCell reference)
```
  - addCellInst
```
public EDIFCellInst addCellInst(EDIFCellInst instance)
```
    Adds the instance to this cell. Checks for a name collision.
    
    Parameters:
    
    instance - The instance to add to this cell.
    
    Returns:
    
    The instance added to the cell.
  - addCellInstUniqueName
```
public EDIFCellInst addCellInstUniqueName(EDIFCellInst instance)
```
    Ensures that the provided cell instance is added to this cell by renaming it to something unique.
    
    Parameters:
    
    instance - The instance to be added to this cell.
    
    Returns:
    
    The instance added to the cell.
  - getCellInst
```
public EDIFCellInst getCellInst(String name)
```
  - addNet
```
public EDIFNet addNet(EDIFNet net)
```
    Adds a net to the cell. Checks for name collisions.
    
    Parameters:
    
    net - The net to add
    
    Returns:
    
    The net that was added.
  - getNet
```
public EDIFNet getNet(EDIFNet net)
```
  - getNet
```
public EDIFNet getNet(String name)
```
  - removeNet
```
public EDIFNet removeNet(EDIFNet net)
```
  - removeNet
```
public EDIFNet removeNet(String name)
```
  - addPort
```
public EDIFPort addPort(EDIFPort port)
```
    Adds a port to the cell. Checks for naming collisions and throws RuntimeException if it occurs. Single bit ports that are not bussed, are keyed by their full name. Bussed ports, however, have their range truncated to just the opening square bracket so that the port can be retrieved from a valid EDIFPortInst name (range being unknown). For example, bus[3:0] would be keyed by "bus[".
    
    Parameters:
    
    port - The port to add.
    
    Returns:
    
    The port that was added.
  - getPort
```
public EDIFPort getPort(String name)
```
    Gets a port by bus name (see EDIFPort.getBusName()). Multi-bit ports need to have closing square bracket and range removed (for example: "bus[3:0]" -> "bus["). See EDIFCell.addPort(EDIFPort) for more information.
    
    Parameters:
    
    name - Bus name (ends with '[' to represent a bussed port) of the port to get. Single bit ports use their entire name.
    
    Returns:
    
    The port or null if none exists.
  - getPortByPortInstName
```
public EDIFPort getPortByPortInstName(String portInstName)
```
    Given a port instance name (not including the name of the cell instance), gets the associated port.
    
    Parameters:
    
    portInstName -
    
    Returns:
  - createCellInst
```
public EDIFCellInst createCellInst(String name,
                                   EDIFCell parent)
```
  - removeCellInst
```
public EDIFCellInst removeCellInst(EDIFCellInst cellInstance)
```
  - removeCellInst
```
public EDIFCellInst removeCellInst(String name)
```
  - createNet
```
public EDIFNet createNet(String name)
```
  - createPort
```
public EDIFPort createPort(String name,
                           EDIFDirection direction,
                           int width)
```
  - createPort
```
public EDIFPort createPort(EDIFPort port)
```
  - rename
```
public void rename(String newName)
```
  - renameCellInst
```
public EDIFCellInst renameCellInst(EDIFCellInst i,
                                   String newName)
```
    Renames the provided instance i with newName.
    
    Parameters:
    
    i - Current instance in the cell.
    
    newName - New name for instance i
    
    Returns:
    
    The newly renamed instance
  - removePort
```
public void removePort(EDIFPort port)
```
  - moveToLibrary
```
public void moveToLibrary(EDIFLibrary newLibrary)
```
  - getView
```
public String getView()
```
    Gets the original view name
    
    Returns:
    
    the view
  - getEDIFView
```
public EDIFName getEDIFView()
```
    Gets the EDIFName object representation of the view name
    
    Returns:
    
    Gets the EDIFName object storing the view name
  - setView
```
public void setView(String view)
```
    Parameters:
    
    view - the view to set
  - setView
```
public void setView(EDIFName view)
```
  - getPorts
```
public Collection<EDIFPort> getPorts()
```
  - getPortMap
```
public Map<String,EDIFPort> getPortMap()
```
  - getCellInsts
```
public Collection<EDIFCellInst> getCellInsts()
```
  - getNets
```
public Collection<EDIFNet> getNets()
```
  - addInternalPortMapEntry
```
public void addInternalPortMapEntry(String portInstName,
                                    EDIFNet internalNet)
```
    Populates an internal map between port-based port ref name, 'bus[3]' or 'clk'.
    
    Parameters:
    
    portInstName - Name from a port ref as generated in @link EDIFPortInst.getPortInstNameFromPort()
    
    internalNet - The net inside this cell to match with the port ref name.
  - removeInternalPortMapEntry
```
public EDIFNet removeInternalPortMapEntry(String portInstName)
```
    Removes the entry within the cell internal net map (when removing a port on a cell).
    
    Parameters:
    
    portInstName - Name of the port ref to remove
    
    Returns:
    
    The net to which the removed port ref belongs, or null if none could be found.
  - getInternalNetMap
```
public Map<String,EDIFNet> getInternalNetMap()
```
  - getInternalNet
```
public EDIFNet getInternalNet(EDIFPortInst portInst)
```
    Takes an external (or internal) port ref and returns the corresponding EDIFNet connected inside the cell.
    
    Parameters:
    
    portInst - The external port ref to get the internal net.
    
    Returns:
    
    The internal connected net or null if none exists.
  - getInternalNet
```
public EDIFNet getInternalNet(String portInstName)
```
    Takes an external (or internal) port name and returns the corresponding EDIFNet connected inside the cell.
    
    Parameters:
    
    portInstName - The external port name to get the internal net.
    
    Returns:
    
    The internal connected net or null if none exists.
  - getLibrary
```
public EDIFLibrary getLibrary()
```
    Returns:
    
    the library
  - setLibrary
```
public void setLibrary(EDIFLibrary library)
```
    Parameters:
    
    library - the library to set
  - hasContents
```
public boolean hasContents()
```
  - isPrimitive
```
public boolean isPrimitive()
```
  - isStaticSource
```
public boolean isStaticSource()
```
  - isVCCSource
```
public boolean isVCCSource()
```
  - isGNDSource
```
public boolean isGNDSource()
```
  - isLeafCellOrBlackBox
```
public boolean isLeafCellOrBlackBox()
```
  - hasCompatibleInterface
```
public boolean hasCompatibleInterface(EDIFCell cell)
```
    Checks if all the port on the provided cell match and are equal to the ports on this cell.
    
    Parameters:
    
    cell - The other cell to check against.
    
    Returns:
    
    True if the ports on each cell match each other, false otherwise.
  - makePrimitive
```
public void makePrimitive()
```
    Deletes internal representation.
  - exportEDIF
```
public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache,
                       boolean stable)
                throws IOException
```
    Throws:
    
    IOException
  - exportEDIF
```
public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache)
                throws IOException
```
    Throws:
    
    IOException
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants()
```
    Recursively finds all leaf cell descendants of this cell The returned EDIFHierCellInsts are relative to this cell.
    
    Returns:
    
    A list of all leaf cell descendants of this cell
  - getAllLeafDescendants
```
public List<EDIFHierCellInst> getAllLeafDescendants(EDIFHierCellInst parentInstance)
```
    Recursively finds all leaf cell descendants of this cell
    
    Parameters:
    
    parentInstance - Parent name or prefix name for all leaf cell descendants to be added. Is not error checked against netlist because the context is not available.
    
    Returns:
    
    A list of all leaf cell descendants of this cell
  - getNetlist
```
public EDIFNetlist getNetlist()
```
  - trackChange
```
public void trackChange(EDIFChangeType type,
                        String name)
```
  - getPortByLegalName
```
public EDIFPort getPortByLegalName(String name,
                                   EDIFReadLegalNameCache cache)
```
  - sortEDIFPortInstLists
```
public void sortEDIFPortInstLists()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class EDIFName
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class EDIFName
  - incrementNonHierInstantiationCount
```
public void incrementNonHierInstantiationCount()
```
    Atomically increment instance count of this cell.
  - decrementNonHierInstantiationCount
```
public void decrementNonHierInstantiationCount()
```
    Atomically decrement instance count of this cell.
  - getNonHierInstantiationCount
```
public int getNonHierInstantiationCount()
```
    Returns:
    
    The number of times this cell has been instantiated.
  - isUniquified
```
public boolean isUniquified()
```
    True if this cell is instantiated no more than once.

Class EDIFCell

Field Summary

Fields inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName

Constructor Summary

Method Summary

Methods inherited from class com.xilinx.rapidwright.edif.EDIFPropertyObject

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName

Methods inherited from class Object

Field Detail

DEFAULT_VIEW

EXPORT_CONST_CELL_BEGIN

EXPORT_CONST_CELLTYPE

EXPORT_CONST_VIEWTYPE

EXPORT_CONST_INTERFACE_END

EXPORT_CONST_CONTENTS

EXPORT_CONST_CONTENTS_END

EXPORT_CONST_VIEW_END

EXPORT_CONST_CELL_END

EXPORT_CONST_PROP_INDENT

Constructor Detail

EDIFCell

EDIFCell

EDIFCell

EDIFCell

Method Detail

createChildCellInst

addNewCellInstUniqueName

addCellInst

addCellInstUniqueName

getCellInst

addNet

getNet

getNet

removeNet

removeNet

addPort

getPort

getPortByPortInstName

createCellInst

removeCellInst

removeCellInst

createNet

createPort

createPort

rename

renameCellInst

removePort

moveToLibrary

getView

getEDIFView

setView

setView

getPorts

getPortMap

getCellInsts

getNets

addInternalPortMapEntry

removeInternalPortMapEntry

getInternalNetMap

getInternalNet

getInternalNet

getLibrary

setLibrary

hasContents

isPrimitive

isStaticSource

isVCCSource

isGNDSource

isLeafCellOrBlackBox

hasCompatibleInterface

makePrimitive

exportEDIF

exportEDIF

getAllLeafDescendants

getAllLeafDescendants

getNetlist

trackChange

getPortByLegalName

sortEDIFPortInstLists