com.xilinx.rapidwright.edif

Class EDIFNet

Object

com.xilinx.rapidwright.edif.EDIFName

com.xilinx.rapidwright.edif.EDIFPropertyObject

com.xilinx.rapidwright.edif.EDIFNet

All Implemented Interfaces:

Comparable<EDIFName>

public class EDIFNet
extends EDIFPropertyObject

Represents a net within an EDIF netlist. Created on: May 11, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	EXPORT_CONST_JOINED
static byte[]	EXPORT_CONST_JOINED_END
static byte[]	EXPORT_CONST_NET_END
static byte[]	EXPORT_CONST_NET_START
static byte[]	EXPORT_CONST_PORT_INDENT
static byte[]	EXPORT_CONST_PROP_INDENT

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
EDIFNet(EDIFNet net) Copy constructor, does not copy portInsts
EDIFNet(String name, EDIFCell parentCell)

Method Summary

Modifier and Type	Method and Description
void	addPortInst(EDIFPortInst portInst) Adds the EDIFPortInst to this logical net.
void	addPortInst(EDIFPortInst portInst, boolean deferSort) Adds the EDIFPortInst to this logical net.
EDIFPortInst	createPortInst(EDIFPort port)
EDIFPortInst	createPortInst(EDIFPort port, EDIFCellInst cellInst)
EDIFPortInst	createPortInst(EDIFPort port, EDIFCellInst cellInst, boolean deferSort)
EDIFPortInst	createPortInst(EDIFPort port, int index)
EDIFPortInst	createPortInst(EDIFPort port, int index, EDIFCellInst cellInst)
EDIFPortInst	createPortInst(EDIFPort port, int index, EDIFCellInst cellInst, boolean deferSort)
EDIFPortInst	createPortInst(String portName, Cell cell)
EDIFPortInst	createPortInst(String portInstName, EDIFCell cell) Creates a new port instance from a name on the internal port of the provided cell.
EDIFPortInst	createPortInst(String portInstName, EDIFCellInst cellInst) Creates a new port instance from a name on the external port of the provided cell instance.
EDIFPortInst	createPortInst(String portInstName, EDIFCellInst cellInst, boolean deferSort)
EDIFPortInst	createPortInst(String portName, int index, Cell cell)
EDIFPortInst	createPortInst(String portName, int index, EDIFCellInst cellInst)
EDIFPortInst	createPortInstFromPortInstName(String portInstName, EDIFCell cell, EDIFCellInst inst) Creates a port instance from a name.
EDIFPortInst	createPortInstFromPortInstName(String portInstName, EDIFCell cell, EDIFCellInst inst, boolean deferSort) Creates a port instance from a name.
boolean	equals(Object obj)
void	exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache, boolean stable)
List<EDIFPortInst>	getAllTopLevelPortInsts() Gets all top level port instances connected to this net.
EDIFCell	getParentCell()
EDIFPortInst	getPortInst(EDIFCellInst inst, String portInstName) Gets the port instance specified by the cell instance and name of the port instance.
Collection<EDIFPortInst>	getPortInsts() Gets the sorted ArrayList of EDIFPortInsts on this net as a collection.
List<EDIFPortInst>	getSourcePortInsts(boolean includeTopLevelPorts) This returns all sources on the net, either output ports of the cell instances in the cell or the top level input ports.
EDIFPortInst	getTopLevelPortInst() Gets the first top level port instance from the stored list in the net.
boolean	isGND() Checks if this net is a logical GND net.
boolean	isInternalToParent() Checks if the net has all port instances (terminals) within the parent cell.
boolean	isVCC() Checks if this net is a logical VCC net.
EDIFPortInst	removePortInst(EDIFCellInst inst, String portInstName) Removes the port instance specified from the net.
EDIFPortInst	removePortInst(EDIFPortInst portInst) Removes the port instance provided from the net.
void	rename(String newName)
void	setParentCell(EDIFCell parentCell)
void	trackChanges(EDIFChangeType type, EDIFCellInst inst, String portInstName)

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, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPORT_CONST_NET_START

public static final byte[] EXPORT_CONST_NET_START

EXPORT_CONST_JOINED

public static final byte[] EXPORT_CONST_JOINED

EXPORT_CONST_PORT_INDENT

public static final byte[] EXPORT_CONST_PORT_INDENT

EXPORT_CONST_PROP_INDENT

public static final byte[] EXPORT_CONST_PROP_INDENT

EXPORT_CONST_JOINED_END

public static final byte[] EXPORT_CONST_JOINED_END

EXPORT_CONST_NET_END

public static final byte[] EXPORT_CONST_NET_END

Constructor Detail

EDIFNet

public EDIFNet(String name,
               EDIFCell parentCell)

EDIFNet

public EDIFNet(EDIFNet net)

Copy constructor, does not copy portInsts

Parameters:

net -

Method Detail

addPortInst

public void addPortInst(EDIFPortInst portInst)

Adds the EDIFPortInst to this logical net. The net stores the port instances using a sorted ArrayList (@link EDIFPortInstList). Worst case O(n) to add.

Parameters:

portInst - The port instance to add to this net.

addPortInst

public void addPortInst(EDIFPortInst portInst,
                        boolean deferSort)

Adds the EDIFPortInst to this logical net. The net stores the port instances using a sorted ArrayList (@link EDIFPortInstList). Worst case O(n) to add.

Parameters:

portInst - The port instance to add to this net.

deferSort - The EDIFPortInstList maintains a sorted list of EDIFPortInst objects and sorts them upon insertion. Setting this flag to true will skip a sort addition but the caller is responsible to conclude a batch of additions with a call to EDIFPortInstList.reSortList(). This is useful when a large number of EDIFPortInsts will be added consecutively (such as parsing a netlist).

trackChanges

public void trackChanges(EDIFChangeType type,
                         EDIFCellInst inst,
                         String portInstName)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port,
                                   int index)

createPortInst

public EDIFPortInst createPortInst(String portInstName,
                                   EDIFCellInst cellInst)

Creates a new port instance from a name on the external port of the provided cell instance. It looks up the appropriate port name from the portInstName and identifies the index if any.

Parameters:

portInstName - The name of the new port instance, including indexed bit if it belongs on a bussed port.

cellInst - The destination cell instance to receive the port instance

Returns:

The newly created port instance or null if none could be created on the instance.

createPortInst

public EDIFPortInst createPortInst(String portInstName,
                                   EDIFCellInst cellInst,
                                   boolean deferSort)

createPortInst

public EDIFPortInst createPortInst(String portInstName,
                                   EDIFCell cell)

Creates a new port instance from a name on the internal port of the provided cell. It looks up the appropriate port name from the portInstName and identifies the index if any.

Parameters:

portInstName - The name of the new port instance, including indexed bit if it belongs on a bussed port.

cell - The destination cell to receive the port instance (on an inward facing port).

Returns:

The newly created port instance or null if none could be created on the cell.

createPortInstFromPortInstName

public EDIFPortInst createPortInstFromPortInstName(String portInstName,
                                                   EDIFCell cell,
                                                   EDIFCellInst inst)

Creates a port instance from a name. Navigates port naming issues when bussed names can collide with single bit port names.

Parameters:

portInstName - Proposed name of the new port instance

cell - The cell from which to draw the port

inst - If this is not null, the port instance is added to the external facing port connection. If this is null, it will add it to the inward facing port connection.

Returns:

The newly created port instance or null if none could be created on the cell or cell instance.

createPortInstFromPortInstName

public EDIFPortInst createPortInstFromPortInstName(String portInstName,
                                                   EDIFCell cell,
                                                   EDIFCellInst inst,
                                                   boolean deferSort)

Creates a port instance from a name. Navigates port naming issues when bussed names can collide with single bit port names.

Parameters:

portInstName - Proposed name of the new port instance

cell - The cell from which to draw the port

inst - If this is not null, the port instance is added to the external facing port connection. If this is null, it will add it to the inward facing port connection.

deferSort - The EDIFPortInstList maintains a sorted list of EDIFPortInst objects and sorts them upon insertion. Setting this flag to true will skip a sort addition but the caller is responsible to conclude a batch of additions with a call to EDIFPortInstList.reSortList(). This is useful when a large number of EDIFPortInsts.

Returns:

The newly created port instance or null if none could be created on the cell or cell instance.

createPortInst

public EDIFPortInst createPortInst(String portName,
                                   int index,
                                   EDIFCellInst cellInst)

createPortInst

public EDIFPortInst createPortInst(String portName,
                                   Cell cell)

createPortInst

public EDIFPortInst createPortInst(String portName,
                                   int index,
                                   Cell cell)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port,
                                   EDIFCellInst cellInst)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port,
                                   EDIFCellInst cellInst,
                                   boolean deferSort)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port,
                                   int index,
                                   EDIFCellInst cellInst)

createPortInst

public EDIFPortInst createPortInst(EDIFPort port,
                                   int index,
                                   EDIFCellInst cellInst,
                                   boolean deferSort)

getPortInsts

public Collection<EDIFPortInst> getPortInsts()

Gets the sorted ArrayList of EDIFPortInsts on this net as a collection.

Returns:

The collection of EDIFPortInsts on this net.

rename

public void rename(String newName)

getSourcePortInsts

public List<EDIFPortInst> getSourcePortInsts(boolean includeTopLevelPorts)

This returns all sources on the net, either output ports of the cell instances in the cell or the top level input ports.

Returns:

A list of port ref sources.

getPortInst

public EDIFPortInst getPortInst(EDIFCellInst inst,
                                String portInstName)

Gets the port instance specified by the cell instance and name of the port instance. If the specified cell instance is null, this looks for a top level port instance on the parent cell. The net stores the port instances using a sorted ArrayList (@link EDIFPortInstList). Worst case O(log n) to get.

Parameters:

inst - The cell instance where the EDIFPortInst resides. If this is null, it gets the top level port instance connected to the parent cell port.

portInstName - Name of the port instance (EDIFPortInst.getName() to get

Returns:

The port instance connected to this net, or null if none exists.

getTopLevelPortInst

public EDIFPortInst getTopLevelPortInst()

Gets the first top level port instance from the stored list in the net. If multiple top level port instances exist on the net, this only returns the first found. For a comprehensive list call EDIFNet.getAllTopLevelPortInsts().

Returns:

The first top level port instance found in the net, or null if none exists.

getAllTopLevelPortInsts

public List<EDIFPortInst> getAllTopLevelPortInsts()

Gets all top level port instances connected to this net.

Returns:

A list of all top level port instances connected to this net.

removePortInst

public EDIFPortInst removePortInst(EDIFPortInst portInst)

Removes the port instance provided from the net. The net stores the port instances using a sorted ArrayList (@link EDIFPortInstList). Worst case O(n) to remove.

Parameters:

portInst - The port instance to remove from the net.

Returns:

The port instance object that was removed or null if no changes were made.

removePortInst

public EDIFPortInst removePortInst(EDIFCellInst inst,
                                   String portInstName)

Removes the port instance specified from the net. The net stores the port instances using a sorted ArrayList (@link EDIFPortInstList). Worst case O(n) to remove.

Parameters:

inst - The cell instance where the EDIFPortInst resides. If this is null, it removes the top level port instance connected to the parent cell port.

portInstName - Name of the port instance (EDIFPortInst.getName() to remove

Returns:

The port instance object that was removed or null if no changes were made.

getParentCell

public EDIFCell getParentCell()

Returns:

the parentCell

setParentCell

public void setParentCell(EDIFCell parentCell)

Parameters:

parentCell - the parentCell to set

isVCC

public boolean isVCC()

Checks if this net is a logical VCC net. It first checks if the net matches the defacto name for VCC in Vivado synthesis, (EDIFTools.LOGICAL_VCC_NET_NAME). If there is not match, it will also check the source of the net to see if it is a VCC primitive.

Returns:

True if this is a logical VCC net, false otherwise.

isGND

public boolean isGND()

Checks if this net is a logical GND net. It first checks if the net matches the defacto name for GND in Vivado synthesis, (EDIFTools.LOGICAL_GND_NET_NAME). If there is not match, it will also check the source of the net to see if it is a GND primitive.

Returns:

True if this is a logical GND net, false otherwise.

isInternalToParent

public boolean isInternalToParent()

Checks if the net has all port instances (terminals) within the parent cell.

Returns:

True if all port instances are internal to this net's parent cell, false otherwise. If the net has not port instances, it returns true.

exportEDIF

public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache,
                       boolean stable)
                throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class EDIFName