com.xilinx.rapidwright.design

Class AbstractModuleInst<ModuleT,PlacementT,T extends AbstractModuleInst<ModuleT,PlacementT,T>>

Object

com.xilinx.rapidwright.design.AbstractModuleInst<ModuleT,PlacementT,T>

Direct Known Subclasses:

ModuleImplsInst, ModuleInst

public abstract class AbstractModuleInst<ModuleT,PlacementT,T extends AbstractModuleInst<ModuleT,PlacementT,T>>
extends Object

Abstract base class for ModuleInst and ModuleImplsInst

Constructor Summary

Constructors

Constructor and Description
AbstractModuleInst(String name)
AbstractModuleInst(String name, EDIFCellInst cellInst)

Method Summary

Modifier and Type	Method and Description
void	connect(String portName, int busIndex0, T other, String otherPortName, int busIndex1) Connects two signals by port name between this module instance and another.
void	connect(String portName, String otherPortName) Connects two signals by port name between this module instance and a top-level port.
void	connect(String portName, String otherPortName, int busIndex) Connects two signals by port name between this module instance and a top-level port.
void	connect(String portName, T other, String otherPortName) Connects two signals by port name between this module instance and another.
void	connect(String portName, T other, String otherPortName, int busIndex) Connects two signals by port name between this module instance and another.
boolean	equals(Object obj)
abstract RelocatableTileRectangle	getBoundingBox()
EDIFCellInst	getCellInst()
abstract ModuleT	getModule()
String	getName()
String	getNewNetName(String portName, int busIndex0, T other, String otherPortName, int busIndex1)
abstract PlacementT	getPlacement()
int	hashCode()
abstract boolean	overlaps(T hm)
void	setCellInst(EDIFCellInst cellInst)
void	setName(String name)
String	toString()
abstract void	unplace()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractModuleInst

public AbstractModuleInst(String name,
                          EDIFCellInst cellInst)

AbstractModuleInst

public AbstractModuleInst(String name)

Method Detail

unplace

public abstract void unplace()

getModule

public abstract ModuleT getModule()

getName

public String getName()

Returns:

the name of this module instance

setName

public void setName(String name)

Parameters:

name - the name to set

getCellInst

public EDIFCellInst getCellInst()

setCellInst

public void setCellInst(EDIFCellInst cellInst)

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

connect

public void connect(String portName,
                    String otherPortName)

Connects two signals by port name between this module instance and a top-level port. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net).

Parameters:

portName - This module instance's port name to connect.

otherPortName - The top-level port of the the cell instance.

connect

public void connect(String portName,
                    String otherPortName,
                    int busIndex)

Connects two signals by port name between this module instance and a top-level port. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net).

Parameters:

portName - This module instance's port name to connect.

otherPortName - The top-level port of the the cell instance.

busIndex - If the port is multi-bit, specify the index to connect or -1 if single bit bus.

connect

public void connect(String portName,
                    T other,
                    String otherPortName)

Connects two signals by port name between this module instance and another. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net).

Parameters:

portName - This module instance's port name to connect.

other - The other module instance to connect to. If this is null, it will connect it to an existing parent cell port named otherPortName

otherPortName - The port name on the other module instance to connect to or the top-level port of the the cell instance.

connect

public void connect(String portName,
                    T other,
                    String otherPortName,
                    int busIndex)

Connects two signals by port name between this module instance and another. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net).

Parameters:

portName - This module instance's port name to connect.

other - The other module instance to connect to. If this is null, it will connect it to an existing parent cell port named otherPortName

otherPortName - The port name on the other module instance to connect to or the top-level port of the the cell instance.

busIndex - If the port is multi-bit, specify the index to connect or -1 if single bit bus.

connect

public void connect(String portName,
                    int busIndex0,
                    T other,
                    String otherPortName,
                    int busIndex1)

Connects two signals by port name between this module instance and another. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net).

Parameters:

portName - This module instance's port name to connect.

busIndex0 - If the assigned port of this module instance is multi-bit, specify the index to connect or -1 if single bit bus.

other - The other module instance to connect to. If this is null, it will connect it to an existing parent cell port named otherPortName

otherPortName - The port name on the other module instance to connect to or the top-level port of the the cell instance.

busIndex1 - If the port (of the other module instance or the existing parent cell) is multi-bit, specify the index to connect or -1 if single bit bus.

getNewNetName

public String getNewNetName(String portName,
                            int busIndex0,
                            T other,
                            String otherPortName,
                            int busIndex1)

getBoundingBox

public abstract RelocatableTileRectangle getBoundingBox()

getPlacement

public abstract PlacementT getPlacement()

overlaps

public abstract boolean overlaps(T hm)