com.xilinx.rapidwright.edif

Class EDIFCollapsedView

Object

com.xilinx.rapidwright.edif.EDIFCollapsedView

public class EDIFCollapsedView
extends Object

A view of a netlist with its macros collapsed, as Vivado writes and reads them. RapidWright keeps the macros of a netlist expanded in memory (see EDIFNetlist.expandMacroUnisims()), and writes them collapsed through this view (see EDIFNetlist.exportEDIF(java.io.OutputStream)), which, unlike EDIFNetlist.collapseMacroUnisims(com.xilinx.rapidwright.device.Series), leaves the netlist as it is. In this view:

• A cell of the primitives library with contents, which is an expanded macro, has no contents.
• A macro that an instance is expanded into for its IOStandard, such as OBUFDS_DUAL_BUF, has the name of the primitive it is expanded from, such as OBUFDS. If the primitives library also has that primitive, instances of the macro are of the primitive instead, and the macro is left out.
• A primitive whose every instance is inside expanded macros, such as one that was added by expanding them, is left out.
• An instance of a cell of the netlist's external library (see EDIFNetlist.setExternalLibrary(EDIFLibrary)) is of the black box that the cell fills.

The view is of the netlist when it is created, so it should not be kept while the netlist changes.

Constructor Summary

Constructors

Constructor and Description
EDIFCollapsedView(EDIFNetlist netlist) Creates a view of the given netlist with its macros collapsed.

Method Summary

Modifier and Type	Method and Description
EDIFCell	getInstanceType(EDIFCell cellType) Gets the cell that an instance of the given cell is an instance of in this view, whose name (see EDIFCollapsedView.getName(EDIFCell)) and library an instance refers to.
String	getName(EDIFCell cell) Gets the name of the given cell in this view.
EDIFPort	getPort(EDIFPortInst portInst) Gets the port of the given port instance in this view, which is the matching port of the cell that its instance is of in this view (see EDIFCollapsedView.getInstanceType(EDIFCell)).
List<EDIFCell>	getValidCellExportOrder(EDIFLibrary lib, boolean stable) Gets the cells of the given library in this view, in an order that they can be written in (see EDIFLibrary.getValidCellExportOrder(boolean)).
EDIFName	getViewref(EDIFCellInst inst) Gets the view that the given instance refers to in this view: that of the cell that it is of in this view (see EDIFCollapsedView.getInstanceType(EDIFCell)) if that is not its cell type, as when its cell type is replaced (see EDIFCellInst.setCellType(EDIFCell)), otherwise its own.
boolean	isCollapsed(EDIFCell cell) Checks if the given cell is a macro that is collapsed in this view, so has no contents in it.
boolean	isOmitted(EDIFCell cell) Checks if the given cell is left out of this view.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EDIFCollapsedView

public EDIFCollapsedView(EDIFNetlist netlist)

Creates a view of the given netlist with its macros collapsed. This only looks at the cells of its primitives library and the contents of its expanded macros, not at the rest of it.

Parameters:

netlist - The netlist.

Method Detail

isOmitted

public boolean isOmitted(EDIFCell cell)

Checks if the given cell is left out of this view.

Parameters:

cell - A cell of the netlist.

Returns:

True if the cell is left out, false otherwise.

isCollapsed

public boolean isCollapsed(EDIFCell cell)

Checks if the given cell is a macro that is collapsed in this view, so has no contents in it.

Parameters:

cell - A cell of the netlist.

Returns:

True if the cell is collapsed, false otherwise.

getName

public String getName(EDIFCell cell)

Gets the name of the given cell in this view.

Parameters:

cell - A cell of the netlist.

Returns:

The name of the cell in this view.

getInstanceType

public EDIFCell getInstanceType(EDIFCell cellType)

Gets the cell that an instance of the given cell is an instance of in this view, whose name (see EDIFCollapsedView.getName(EDIFCell)) and library an instance refers to.

Parameters:

cellType - The cell type of an instance in the netlist.

Returns:

The cell that the instance is of in this view.

getViewref

public EDIFName getViewref(EDIFCellInst inst)

Gets the view that the given instance refers to in this view: that of the cell that it is of in this view (see EDIFCollapsedView.getInstanceType(EDIFCell)) if that is not its cell type, as when its cell type is replaced (see EDIFCellInst.setCellType(EDIFCell)), otherwise its own.

Parameters:

inst - An instance in the netlist.

Returns:

The view that the instance refers to in this view.

getPort

public EDIFPort getPort(EDIFPortInst portInst)

Gets the port of the given port instance in this view, which is the matching port of the cell that its instance is of in this view (see EDIFCollapsedView.getInstanceType(EDIFCell)).

Parameters:

portInst - A port instance in the netlist.

Returns:

The port of the port instance in this view.

getValidCellExportOrder

public List<EDIFCell> getValidCellExportOrder(EDIFLibrary lib,
                                              boolean stable)

Gets the cells of the given library in this view, in an order that they can be written in (see EDIFLibrary.getValidCellExportOrder(boolean)).

Parameters:

lib - A library of the netlist.

stable - If true, the order is always the same for the same library.

Returns:

The cells of the library that are not left out of this view.