com.xilinx.rapidwright.design

Class Port

Object

com.xilinx.rapidwright.design.Port

All Implemented Interfaces:

Serializable, Cloneable

public class Port
extends Object
implements Serializable, Cloneable

This class represents the ports used to define the interfaces of modules. They consist of a unique name and the SitePinInst to which they are connected.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Port() Default constructor, everything is null.
Port(String name)
Port(String name, boolean isOutputPort, String initialPassThruPinName) Special constructor when creating a port that has a pass-thru connection
Port(String name, Collection<SitePinInst> sitePinInsts)
Port(String name, SitePinInst sitePinInst)

Method Summary

Modifier and Type	Method and Description
void	addPassThruPortName(String portName)
void	addSitePinInst(SitePinInst sitePinInst)
boolean	equals(Object obj) Checks if this and obj are equal ports by comparing port name, instance name and pin name.
RelocatableTileRectangle	getBoundingBox()
String	getName() Gets and returns the name of the port.
Net	getNet()
Tile	getPartitionPinLoc()
List<String>	getPassThruPortNames()
SiteInst	getSingleSiteInst()
String	getSingleSiteInstName() Gets and returns the instance name.
SitePinInst	getSingleSitePinInst() Convenience method for ports with at most one SitePinInst.
String	getSingleSitePinInstName() Gets the pin name of the instance where the port resides.
Set<SitePinInst>	getSitePinInsts()
PortType	getType()
float	getWorstCasePortDelay()
int	hashCode() Generates hashCode for this port based on instance name, port name, and pin name.
boolean	isOutPort() Simply looks at the pin of the port to determine its direction.
void	removeSitePinInst(SitePinInst p)
void	setName(String name) Sets the name of the port.
void	setOutputPort(boolean isOutputPort)
void	setPartitionPinLoc(Tile partitionPinLoc)
void	setPassThruPortNames(ArrayList<String> passThruPinNames)
void	setType(PortType type)
void	setWorstCasePortDelay(float worstCasePortDelay)
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Port

public Port()

Default constructor, everything is null.

Port

public Port(String name,
            SitePinInst sitePinInst)

Parameters:

name - Name of the port.

sitePinInst - Pin which the port references

Port

public Port(String name,
            Collection<SitePinInst> sitePinInsts)

Parameters:

name - Name of the port.

sitePinInsts - Pins which the port references

Port

public Port(String name,
            boolean isOutputPort,
            String initialPassThruPinName)

Special constructor when creating a port that has a pass-thru connection

Parameters:

name - Name of the port on the module

isOutputPort - Flag denoting if this port is an output or input

initialPassThruPinName - The name of the pass-thru port this port connects to

Port

public Port(String name)

Parameters:

name - Name of the port.

Method Detail

getName

public String getName()

Gets and returns the name of the port.

Returns:

The name of the port.

setName

public void setName(String name)

Sets the name of the port.

Parameters:

name - The new name of the port.

getSingleSiteInstName

public String getSingleSiteInstName()

Gets and returns the instance name.

Returns:

The name of the instance where this port resides.

getSingleSitePinInstName

public String getSingleSitePinInstName()

Gets the pin name of the instance where the port resides.

Returns:

The pin name of the port.

addSitePinInst

public void addSitePinInst(SitePinInst sitePinInst)

Parameters:

sitePinInst - the pin to add

getSingleSitePinInst

public SitePinInst getSingleSitePinInst()

Convenience method for ports with at most one SitePinInst. Get the single SitePinInst associated with this Port or null if there are none. Throws if there are multiple.

Returns:

the pin

getSitePinInsts

public Set<SitePinInst> getSitePinInsts()

getSingleSiteInst

public SiteInst getSingleSiteInst()

Returns:

the instance

isOutPort

public boolean isOutPort()

Simply looks at the pin of the port to determine its direction.

Returns:

True if this port is an output, false otherwise.

setOutputPort

public void setOutputPort(boolean isOutputPort)

Parameters:

isOutputPort - the isOutputPort to set

getPassThruPortNames

public List<String> getPassThruPortNames()

Returns:

the passThruPortNames

setPassThruPortNames

public void setPassThruPortNames(ArrayList<String> passThruPinNames)

Parameters:

passThruPinNames - the passThruPinNames to set

addPassThruPortName

public void addPassThruPortName(String portName)

getPartitionPinLoc

public Tile getPartitionPinLoc()

setPartitionPinLoc

public void setPartitionPinLoc(Tile partitionPinLoc)

getWorstCasePortDelay

public float getWorstCasePortDelay()

Returns:

the worstCasePortDelay

setWorstCasePortDelay

public void setWorstCasePortDelay(float worstCasePortDelay)

Parameters:

worstCasePortDelay - the worstCasePortDelay to set

hashCode

public int hashCode()

Generates hashCode for this port based on instance name, port name, and pin name.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Checks if this and obj are equal ports by comparing port name, instance name and pin name.

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getType

public PortType getType()

Returns:

the type

setType

public void setType(PortType type)

Parameters:

type - the type to set

getNet

public Net getNet()

removeSitePinInst

public void removeSitePinInst(SitePinInst p)

getBoundingBox

public RelocatableTileRectangle getBoundingBox()