com.xilinx.rapidwright.edif

Class EDIFCellInst

Object

com.xilinx.rapidwright.edif.EDIFName

com.xilinx.rapidwright.edif.EDIFPropertyObject

com.xilinx.rapidwright.edif.EDIFCellInst

All Implemented Interfaces:

Comparable<EDIFName>

public class EDIFCellInst
extends EDIFPropertyObject

A cell instance in a logical (EDIF) netlist. Instantiates an EDIFCell. Created on: May 11, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLACK_BOX_PROP
static String	BLACK_BOX_PROP_VERSAL
static EDIFName	DEFAULT_VIEWREF
static byte[]	EXPORT_CONST_CELLREF
static byte[]	EXPORT_CONST_CLOSE
static byte[]	EXPORT_CONST_CLOSE_NO_PROPS
static byte[]	EXPORT_CONST_CLOSE_WITH_PROPS
static byte[]	EXPORT_CONST_INSTANCE_BEGIN
static byte[]	EXPORT_CONST_LIBRARYREF
static byte[]	EXPORT_CONST_PROP_INDENT
static byte[]	EXPORT_CONST_VIEWREF

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
EDIFCellInst(EDIFCellInst inst, EDIFCell parentCell) Copy constructor.
EDIFCellInst(String name, EDIFCell cellType, EDIFCell parentCell)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
void	exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache, boolean stable)
String	getCellName()
Collection<EDIFPort>	getCellPorts()
EDIFCell	getCellType()
EDIFPortInst	getOrCreatePortInst(String name) Gets the named EDIFPortInst or creates it (if correctly named) and returns it.
EDIFCell	getParentCell()
EDIFPort	getPort(String name) Gets the port on the underlying cell type.
EDIFPortInst	getPortInst(String name) Gets the port instance on this cell by pin name (EDIFPortInst.getName()).
Collection<EDIFPortInst>	getPortInsts() Gets the sorted ArrayList of EDIFPortInsts on this cell instance as a collection.
EDIFName	getViewref()
boolean	isBlackBox()
boolean	isUniquified() True if this cell instance is attached to a parent cell, and is the only instantiation of its cell.
void	setCellType(EDIFCell cellType) Modify the cell being instantiated and update port refs on portInsts
void	setCellTypeRaw(EDIFCell cellType) Forcibly modify the cell being instantiated without updating portInsts
void	setParentCell(EDIFCell parent)
void	setViewref(EDIFName viewref)

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

DEFAULT_VIEWREF

public static final EDIFName DEFAULT_VIEWREF

BLACK_BOX_PROP

public static final String BLACK_BOX_PROP

See Also:

Constant Field Values

BLACK_BOX_PROP_VERSAL

public static final String BLACK_BOX_PROP_VERSAL

See Also:

Constant Field Values

EXPORT_CONST_INSTANCE_BEGIN

public static final byte[] EXPORT_CONST_INSTANCE_BEGIN

EXPORT_CONST_VIEWREF

public static final byte[] EXPORT_CONST_VIEWREF

EXPORT_CONST_CELLREF

public static final byte[] EXPORT_CONST_CELLREF

EXPORT_CONST_LIBRARYREF

public static final byte[] EXPORT_CONST_LIBRARYREF

EXPORT_CONST_CLOSE_WITH_PROPS

public static final byte[] EXPORT_CONST_CLOSE_WITH_PROPS

EXPORT_CONST_PROP_INDENT

public static final byte[] EXPORT_CONST_PROP_INDENT

EXPORT_CONST_CLOSE

public static final byte[] EXPORT_CONST_CLOSE

EXPORT_CONST_CLOSE_NO_PROPS

public static final byte[] EXPORT_CONST_CLOSE_NO_PROPS

Constructor Detail

EDIFCellInst

public EDIFCellInst(String name,
                    EDIFCell cellType,
                    EDIFCell parentCell)

EDIFCellInst

public EDIFCellInst(EDIFCellInst inst,
                    EDIFCell parentCell)

Copy constructor. Creates new objects except portInsts.

Parameters:

inst - Prototype instance to copy

Method Detail

getViewref

public EDIFName getViewref()

Returns:

the viewref

setViewref

public void setViewref(EDIFName viewref)

Parameters:

viewref - the viewref to set

getPortInst

public EDIFPortInst getPortInst(String name)

Gets the port instance on this cell by pin name (EDIFPortInst.getName()). The port instances are stored in a sorted ArrayList, so worst case is O(log n).

Parameters:

name - Name of the port instance to get.

Returns:

The named port instance, or null if none found by that name.

getOrCreatePortInst

public EDIFPortInst getOrCreatePortInst(String name)

Gets the named EDIFPortInst or creates it (if correctly named) and returns it. If the port instance is to be created, it will not be connected to an EDIFNet.

Parameters:

name - Name of the port instance to get.

Returns:

The existing or created port instance.

getPort

public EDIFPort getPort(String name)

Gets the port on the underlying cell type. It is the same as calling getCellType().getPort(name).

Parameters:

name - Name of the port to get.

Returns:

The port on the underlying cell type.

getPortInsts

public Collection<EDIFPortInst> getPortInsts()

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

Returns:

The collection of EDIFPortInsts on this cell.

getParentCell

public EDIFCell getParentCell()

Returns:

the parentCell

setParentCell

public void setParentCell(EDIFCell parent)

Parameters:

parent - the parentCell to set

getCellType

public EDIFCell getCellType()

Returns:

the cellType

getCellPorts

public Collection<EDIFPort> getCellPorts()

getCellName

public String getCellName()

setCellTypeRaw

public void setCellTypeRaw(EDIFCell cellType)

Forcibly modify the cell being instantiated without updating portInsts

Parameters:

cellType - the cellType to set

setCellType

public void setCellType(EDIFCell cellType)

Modify the cell being instantiated and update port refs on portInsts

Parameters:

cellType - the cellType to set

isBlackBox

public boolean isBlackBox()

exportEDIF

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

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class EDIFName

isUniquified

public boolean isUniquified()

True if this cell instance is attached to a parent cell, and is the only instantiation of its cell.