com.xilinx.rapidwright.device

Class SitePin

Object

com.xilinx.rapidwright.device.SitePin

public class SitePin
extends Object

A light-weight object to allow references to a site and pin Created on: Jul 5, 2016

Constructor Summary

Constructors

Constructor and Description
SitePin(Site site, String pinName) SitePin constructor from site object and pin name

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BELPin	getBELPin() Gets the corresponding BELPin for this site pin
BELPin	getBELPin(SiteTypeEnum type) Gets the corresponding BELPin for this site pin using the site type provided.
String	getPinName() Gets the site pin name
Site	getSite() Gets the site
Tile	getTile() Gets the tile where the site pin resides.
int	hashCode()
boolean	isInput() Checks if the direction of the pin is an input
void	setPinName(String pinName)
void	setSite(Site site)
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SitePin

public SitePin(Site site,
               String pinName)

SitePin constructor from site object and pin name

Vivado Tcl:

get_site_pins $site/$pinName

Parameters:

site - The site

pinName - The name of the site pin

Since:

2018.2.0

Method Detail

getSite

public Site getSite()

Gets the site

Vivado Tcl:

get_sites -of $this

Returns:

the site

Since:

2018.2.0

setSite

public void setSite(Site site)

Parameters:

site - the site to set

Since:

2018.2.0

getPinName

public String getPinName()

Gets the site pin name

Vivado Tcl:

set n [get_property NAME $this]; string range $n [string last "/" $n]+1 [string length $n]

Returns:

the pinName

Since:

2018.2.0

setPinName

public void setPinName(String pinName)

Parameters:

pinName - the pinName to set

Since:

2018.2.0

isInput

public boolean isInput()

Checks if the direction of the pin is an input

Vivado Tcl:

set n [get_property NAME $this]; string range $n [string last "/" $n]+1 [string length $n]

Returns:

True if pin is an input, false otherwise

Since:

2018.2.0

getBELPin

public BELPin getBELPin()

Gets the corresponding BELPin for this site pin

Vivado GUI:

Select Site Wire of Site Pin->BEL Pins

Returns:

The corresponding element pin.

Since:

2018.2.0

getBELPin

public BELPin getBELPin(SiteTypeEnum type)

Gets the corresponding BELPin for this site pin using the site type provided.

Vivado GUI:

Select Site Wire of Site Pin->BEL Pins

Returns:

The corresponding element pin or null if the provided type is not supported.

Since:

2018.2.0

getTile

public Tile getTile()

Gets the tile where the site pin resides.

Vivado Tcl:

get_tiles -of $this

Returns:

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