com.xilinx.rapidwright.edif

Class EDIFPortInst

Object

com.xilinx.rapidwright.edif.EDIFPortInst

All Implemented Interfaces:

Comparable<EDIFPortInst>

public class EDIFPortInst
extends Object
implements Comparable<EDIFPortInst>

Represents an instance of a port on an EDIFCellInst. Created on: May 11, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	EXPORT_CONST_CLOSE_PORT_INST
static byte[]	EXPORT_CONST_INSTANCEREF
static byte[]	EXPORT_CONST_MEMBER
static byte[]	EXPORT_CONST_PORTREF

Constructor Summary

Constructors

Constructor and Description
EDIFPortInst(EDIFPort port, EDIFNet parentNet)
EDIFPortInst(EDIFPort port, EDIFNet parentNet, EDIFCellInst cellInst) Constructor to create a single bit port ref and associate it with its net and instance.
EDIFPortInst(EDIFPort port, EDIFNet parentNet, EDIFCellInst cellInst, boolean deferSort) Constructor to create a single bit port ref and associate it with its net and instance.
EDIFPortInst(EDIFPort port, EDIFNet parentNet, int index)
EDIFPortInst(EDIFPort port, EDIFNet parentNet, int index, EDIFCellInst cellInst) Constructor to create a new port ref on the provided instance and connect it to the provided net
EDIFPortInst(EDIFPort port, EDIFNet parentNet, int index, EDIFCellInst cellInst, boolean deferSort) Constructor to create a new port ref on the provided instance and connect it to the provided net
EDIFPortInst(EDIFPortInst portInst) Copy constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(EDIFPortInst o)
static EDIFPortInst	createPortInstFromPortInstName(String portInstName, EDIFCellInst inst) Creates a new port instance without connecting it to a net.
boolean	equals(Object obj)
EDIFCellInst	getCellInst()
EDIFDirection	getDirection()
String	getFullName()
int	getIndex()
EDIFNet	getInternalNet()
String	getName()
EDIFNet	getNet()
EDIFCell	getParentCell()
EDIFPort	getPort()
String	getPortInstNameFromPort()
int	hashCode()
boolean	isInput()
boolean	isOutput()
boolean	isPrimitiveStaticSource() Checks if this is an output of a GND or VCC primitive cell.
boolean	isTopLevelPort()
void	setCellInst(EDIFCellInst cellInst)
void	setCellInst(EDIFCellInst cellInst, boolean deferSort) Sets the corresponding cell instance for this port instance.
void	setIndex(int index)
void	setParentNet(EDIFNet parentNet)
void	setPort(EDIFPort port)
String	toString()
void	writeEDIFExport(OutputStream os, byte[] indent, EDIFWriteLegalNameCache<?> cache)

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPORT_CONST_PORTREF

public static final byte[] EXPORT_CONST_PORTREF

EXPORT_CONST_MEMBER

public static final byte[] EXPORT_CONST_MEMBER

EXPORT_CONST_INSTANCEREF

public static final byte[] EXPORT_CONST_INSTANCEREF

EXPORT_CONST_CLOSE_PORT_INST

public static final byte[] EXPORT_CONST_CLOSE_PORT_INST

Constructor Detail

EDIFPortInst

public EDIFPortInst(EDIFPort port,
                    EDIFNet parentNet)

EDIFPortInst

public EDIFPortInst(EDIFPortInst portInst)

Copy constructor

Parameters:

portInst -

EDIFPortInst

public EDIFPortInst(EDIFPort port,
                    EDIFNet parentNet,
                    int index)

EDIFPortInst

public EDIFPortInst(EDIFPort port,
                    EDIFNet parentNet,
                    EDIFCellInst cellInst)

Constructor to create a single bit port ref and associate it with its net and instance.

Parameters:

port - The port on the cell this port ref uses

parentNet - The net this port ref should belong to

cellInst - The instance this port ref belongs to

EDIFPortInst

public EDIFPortInst(EDIFPort port,
                    EDIFNet parentNet,
                    EDIFCellInst cellInst,
                    boolean deferSort)

Constructor to create a single bit port ref and associate it with its net and instance.

Parameters:

port - The port on the cell this port ref uses

parentNet - The net this port ref should belong to

cellInst - The instance this port ref belongs to

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).

EDIFPortInst

public EDIFPortInst(EDIFPort port,
                    EDIFNet parentNet,
                    int index,
                    EDIFCellInst cellInst)

Constructor to create a new port ref on the provided instance and connect it to the provided net

Parameters:

port - The port on the cell this port ref uses

parentNet - The net this port ref should be added to

index - For port refs part of a bussed port, this is the index into the bussed array, for single bit ports, it should be -1.

cellInst - This instance on which this port ref corresponds.

EDIFPortInst

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

Constructor to create a new port ref on the provided instance and connect it to the provided net

Parameters:

port - The port on the cell this port ref uses

parentNet - The net this port ref should be added to

index - For port refs part of a bussed port, this is the index into the bussed array, for single bit ports, it should be -1.

cellInst - This instance on which this port ref corresponds.

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).

Method Detail

createPortInstFromPortInstName

public static EDIFPortInst createPortInstFromPortInstName(String portInstName,
                                                          EDIFCellInst inst)

Creates a new port instance without connecting it to a net.

Parameters:

portInstName - Name of the port instance

inst - The instance on which to create the new port instance

Returns:

The new port instance.

getPortInstNameFromPort

public String getPortInstNameFromPort()

getName

public String getName()

getIndex

public int getIndex()

Returns:

the index

setIndex

public void setIndex(int index)

Parameters:

index - the index to set

getParentCell

public EDIFCell getParentCell()

getCellInst

public EDIFCellInst getCellInst()

Returns:

the cellInst

setCellInst

public void setCellInst(EDIFCellInst cellInst)

Parameters:

cellInst - the cellInst to set

setCellInst

public void setCellInst(EDIFCellInst cellInst,
                        boolean deferSort)

Sets the corresponding cell instance for this port instance.

Parameters:

cellInst - the cellInst to set

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 for 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).

isPrimitiveStaticSource

public boolean isPrimitiveStaticSource()

Checks if this is an output of a GND or VCC primitive cell.

Returns:

True if the underlying cell is a static output from GND or VCC, false otherwise.

getFullName

public String getFullName()

getPort

public EDIFPort getPort()

setPort

public void setPort(EDIFPort port)

getDirection

public EDIFDirection getDirection()

isOutput

public boolean isOutput()

isInput

public boolean isInput()

isTopLevelPort

public boolean isTopLevelPort()

getNet

public EDIFNet getNet()

Returns:

the parentNet

getInternalNet

public EDIFNet getInternalNet()

setParentNet

public void setParentNet(EDIFNet parentNet)

Parameters:

parentNet - the parentNet to set

writeEDIFExport

public void writeEDIFExport(OutputStream os,
                            byte[] indent,
                            EDIFWriteLegalNameCache<?> cache)
                     throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(EDIFPortInst o)

Specified by:

compareTo in interface Comparable<EDIFPortInst>