com.xilinx.rapidwright.device

Class PackagePin

Object

com.xilinx.rapidwright.device.PackagePin

public class PackagePin
extends Object

Holds data for a package pin and its mapping to a specific site/bel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BEL	getBEL() Gets the BEL associated with this package pin.
PackagePin	getDiffPairPin() Gets the differential paired pin with this package pin.
String	getIOBAliasName() Gets the IOB alias site name (IOB_X#Y#) for this package pin
IOBank	getIOBank() Gets the IOBank (if exists) to which this package pin belongs.
Integer	getMaxDelay() Gets the maximum delay on this package pin in picoseconds.
Integer	getMinDelay() Gets the minimum delay on this package pin in picoseconds.
String	getName() Get's the package pin name (e.g.
Package	getPackage() Gets the package this pin belongs to.
String	getPinFunction() Get's the type of the site connected to this package pin
Site	getSite() Get's the site connected to this package pin
String	getSiteType() Deprecated.
SiteTypeEnum	getSiteTypeEnum() Gets the SiteTypeEnum associated with this package pin's BEL.
int	hashCode()
boolean	isDifferential() Checks if this package pin uses differential signaling.
boolean	isGeneralPurpose() Checks if the pin is general purpose
boolean	isGlobalClk() Checks if the pin is a global clock
boolean	isLowCap() Checks if the pin is low capacitance
boolean	isVref() Checks if the pin is Vref
boolean	isVrn() Checks if the pin is Vrn
boolean	isVrp() Checks if the pin is Vrp
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Get's the package pin name (e.g. AE13)

Vivado Tcl:

get_property NAME $this

Returns:

Name of the package pin.

Since:

2018.2.0

getSite

public Site getSite()

Get's the site connected to this package pin

Vivado Tcl:

get_sites -of $this

Returns:

The site to which this package pin connects.

Since:

2018.2.0

getPinFunction

public String getPinFunction()

Get's the type of the site connected to this package pin

Vivado Tcl:

get_property PIN_FUNC [get_sites -of $this]

Returns:

Name of the site type

Since:

2018.2.0

getSiteType

public String getSiteType()

Deprecated.

Get's the type of the site connected to this package pin

Vivado Tcl:

get_property PIN_FUNC [get_sites -of $this]

Returns:

Name of the site type

Since:

2018.2.0

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

getBEL

public BEL getBEL()

Gets the BEL associated with this package pin.

Returns:

The BEL associated with this package pin, or null if none exists.

Since:

2020.2.0

getSiteTypeEnum

public SiteTypeEnum getSiteTypeEnum()

Gets the SiteTypeEnum associated with this package pin's BEL.

Returns:

The SiteTypeEnum associated with this package pin BEL, or null if none exists.

Since:

2020.2.0

getMinDelay

public Integer getMinDelay()

Gets the minimum delay on this package pin in picoseconds.

Returns:

The minimum delay in picoseconds or null if not available.

Since:

2020.2.0

getMaxDelay

public Integer getMaxDelay()

Gets the maximum delay on this package pin in picoseconds.

Returns:

The maximum delay in picoseconds or null if not available.

Since:

2020.2.0

getIOBAliasName

public String getIOBAliasName()

Gets the IOB alias site name (IOB_X#Y#) for this package pin

Returns:

The IOB alias name for this package pin.

Since:

2020.2.0

getDiffPairPin

public PackagePin getDiffPairPin()

Gets the differential paired pin with this package pin.

Returns:

The paired differential package pin for this pin or null if this pin is non-differential.

Since:

2020.2.0

isDifferential

public boolean isDifferential()

Checks if this package pin uses differential signaling.

Returns:

True if this package pin uses differential signaling, false otherwise.

Since:

2020.2.0

getPackage

public Package getPackage()

Gets the package this pin belongs to.

Returns:

The package to which this pin belongs.

Since:

2020.2.0

isGeneralPurpose

public boolean isGeneralPurpose()

Checks if the pin is general purpose

Vivado Tcl:

get_property IS_GENERAL_PURPOSE [get_sites -of $this]

Returns:

True if this pin is general purpose, false otherwise

Since:

2020.2.0

isGlobalClk

public boolean isGlobalClk()

Checks if the pin is a global clock

Vivado Tcl:

get_property IS_GLOBAL_CLK [get_sites -of $this]

Returns:

True if this pin is a global clock, false otherwise

Since:

2020.2.0

isLowCap

public boolean isLowCap()

Checks if the pin is low capacitance

Vivado Tcl:

get_property IS_LOW_CAP [get_sites -of $this]

Returns:

True if this pin is low capacitance, false otherwise

Since:

2020.2.0

isVrn

public boolean isVrn()

Checks if the pin is Vrn

Vivado Tcl:

get_property IS_VRN [get_sites -of $this]

Returns:

True if this pin is Vrn, false otherwise

Since:

2020.2.0

isVrp

public boolean isVrp()

Checks if the pin is Vrp

Vivado Tcl:

get_property IS_VRP [get_sites -of $this]

Returns:

True if this pin is Vrn, false otherwise

Since:

2020.2.0

isVref

public boolean isVref()

Checks if the pin is Vref

Vivado Tcl:

get_property IS_VREF [get_sites -of $this]

Returns:

True if this pin is Vref, false otherwise

Since:

2020.2.0

getIOBank

public IOBank getIOBank()

Gets the IOBank (if exists) to which this package pin belongs.

Returns:

The parent IOBank, or null if this package pin does not belong to an IOBank

Since:

2020.2.4