Site

Object
- com.xilinx.rapidwright.device.Site

All Implemented Interfaces:

PBlockCorner, Serializable
```
public class Site
extends Object
implements Serializable, PBlockCorner
```
This class represents a site, a logic hierarchy level that is below a tile and generally contains one or more BELs. A common example of a site is a SLICE.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static HashMap<SiteTypeEnum,SiteTypeEnum[]>[] compatibleTypesArray
Keeps track of extra site types on which primitive types can be placed

Fields
Modifier and Type	Field and Description
`static HashMap<SiteTypeEnum,SiteTypeEnum[]>[]`	`compatibleTypesArray` Keeps track of extra site types on which primitive types can be placed

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`SiteTypeEnum[]`	`getAlternateSiteTypeEnums()` Gets the alternate site types compatible with this site.
`BEL`	`getBEL(String name)` Gets and returns the named element type from the site.
`BELPin`	`getBELPin(String name)` Get the BEL pin object from its hierarchical name (i.e.
`BELPin`	`getBELPin(String belName, String pinName)` Get the BEL pin object from its hierarchical name (i.e.
`BELPin[]`	`getBELPins(int siteWireIndex)` For a given site wire index (or ID), gets all connected BEL pins of the site wire.
`BELPin[]`	`getBELPins(String siteWireName)` For a given site wire name, this will return all connected BEL pins of the site wire.
`BEL[]`	`getBELs()` Gets and returns the BELs of this site.
`ClockRegion`	`getClockRegion()` Gets the clock region to which this site belongs.
`Node`	`getConnectedNode(int pinIndex)` Creates and returns the corresponding node that connects to specified site pin provided.
`Node`	`getConnectedNode(String pinName)` Creates and returns the corresponding node that connects to specified site pin provided.
`Site`	`getCorrespondingSite(SiteTypeEnum type, Tile newSiteTile)` A method to get the corresponding primitive site for current in a different tile.
`Device`	`getDevice()` Gets the device this site belongs to.
`int`	`getHighestInputPinIndex()` The largest site pin index that is an input.
`int`	`getInstanceX()` Gets and returns the integer X value of the instance location (ex: SLICE_X5Y10, it will return 5).
`int`	`getInstanceY()` Gets and returns the integer Y value of the instance location (ex: SLICE_X5Y10, it will return 10).
`Tile`	`getIntTile()` Gets the approximate INT tile to which this site connects.
`String`	`getName()` Gets and returns the name of this primitive site (ex: SLICE_X4Y6).
`String`	`getNameSpacePrefix()` Gets a new string representation of the site type's namespace.
`Site`	`getNeighborSite(int dx, int dy)` This will attempt to locate a neighbor site of similar type (pblock-compatible) with the provided X,Y offset.
`int`	`getPinIndex(String pinName)` Gets the site pin index for the named site pin.
`String`	`getPinName(int pinIndex)` Gets the name of the site pin of the provided pin index.
`int`	`getRpmX()` Gets the RPM X coordinate of this site.
`int`	`getRpmY()` Gets the RPM Y coordinate of this site.
`int`	`getSiteIndexInTile()` Gets the index of this site as stored in its parent tile.
`int`	`getSitePinCount()` Gets the total number of site pins on this site (type).
`SitePIP`	`getSitePIP(BELPin input)` Gets the site PIP connecting the two element (BEL) pins provided.
`SitePIP`	`getSitePIP(int index)` Gets the site PIP at the provided index
`int`	`getSitePIPCount()` Gets the number of site PIPs in this site.
`SitePIP[]`	`getSitePIPs()` Gets the array of site PIPs in this site.
`SiteTypeEnum`	`getSiteTypeEnum()` Gets and returns the native type of primitive of this primitive site.
`int`	`getSiteWireCount()` Returns the total number of site wires in this site.
`Integer`	`getSiteWireIndex(String siteWireName)` Looks up the index by name of the site wire within the site.
`String`	`getSiteWireName(int wireIndex)` Gets the site wire name from a site wire index
`String[]`	`getSiteWireNames()` Gets the array of site wire names for this site.
`Tile`	`getTile()` Gets and returns the Tile where this primitive site resides.
`int`	`getTileWireIndexFromPinName(String pinName)` Get the wire index connected to the pin provided.
`String`	`getTileWireNameFromPinName(String pinName)` Gets and returns the wire name of the given pin name.
`int`	`hashCode()`
`boolean`	`hasPin(String pinName)` Checks if the site pin exists on this site.
`boolean`	`isCompatibleSiteType(Site otherSite)` This method gets the type of otherSite and calls the other method public boolean isCompatibleSiteType(SiteTypeEnum otherType); See that method for more information.
`boolean`	`isCompatibleSiteType(SiteTypeEnum otherType)` This method will check if the SiteTypeEnum otherType can be placed at this primitive site.
`boolean`	`isGlobalClkBuffer()` Checks if this site is a global clk buffer (IS_GLOBAL_CLOCK_BUFFER).
`boolean`	`isGlobalClkPad()` Checks if this site is a global clk pad (IS_GLOBAL_CLOCK_PAD).
`boolean`	`isInputPin(int pinIndex)` Checks if the provide site pin index is an input
`boolean`	`isInputPin(String pinName)` Determine if the named site pin is an input
`boolean`	`isOutputPin(int pinIndex)` Checks if the provide site pin index is an output
`boolean`	`isOutputPin(String pinName)` Determine if the named site pin is an output
`boolean`	`isRegionalClkBuffer()` Checks if this site is a regional clk buffer (IS_REGIONAL_CLOCK_BUFFER).
`boolean`	`isRegionalClkPad()` Checks if this site is a regional clk pad (IS_REGIONAL_CLOCK_PAD).
`String`	`toString()`

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - compatibleTypesArray
```
public static HashMap<SiteTypeEnum,SiteTypeEnum[]>[] compatibleTypesArray
```
    Keeps track of extra site types on which primitive types can be placed
    
    Since:
    
    2018.2.0
- Method Detail
  - getName
```
public String getName()
```
    Gets and returns the name of this primitive site (ex: SLICE_X4Y6).
    
    Specified by:
    
    getName in interface PBlockCorner
    
    Returns:
    
    The unique name of this primitive site.
    
    Since:
    
    2018.2.0
  - getNameSpacePrefix
```
public String getNameSpacePrefix()
```
    Gets a new string representation of the site type's namespace. For example SLICEL and SLICEM map to SLICE_. Other types generally just map to their site type name.
    
    Returns:
    
    The site type namespace (includes trailing underscore).
    
    Since:
    
    2018.2.0
  - getDevice
```
public Device getDevice()
```
    Gets the device this site belongs to.
    
    Specified by:
    
    getDevice in interface PBlockCorner
    
    Returns:
    
    The site's parent device.
    
    Since:
    
    2018.2.0
  - getTile
```
public Tile getTile()
```
    Gets and returns the Tile where this primitive site resides.
    
    Returns:
    
    The tile where this primitive site is.
    
    Since:
    
    2018.2.0
  - getTileWireNameFromPinName
```
public String getTileWireNameFromPinName(String pinName)
```
    Gets and returns the wire name of the given pin name.
    
    Parameters:
    
    pinName - Name of the pin on this site.
    
    Returns:
    
    The wire name connected to the pin named pinName, or null if it could not be found.
    
    Since:
    
    2018.2.0
  - getTileWireIndexFromPinName
```
public int getTileWireIndexFromPinName(String pinName)
```
    Get the wire index connected to the pin provided.
    
    Parameters:
    
    pinName - Name of the pin on the site to get its connecting wire.
    
    Returns:
    
    The wire index within the tile that is connected to the pin provided, or -1 if could not be found.
    
    Since:
    
    2018.2.0
  - getConnectedNode
```
public Node getConnectedNode(String pinName)
```
    Creates and returns the corresponding node that connects to specified site pin provided.
    
    Parameters:
    
    pinName - Name of the site pin in question.
    
    Returns:
    
    A new Node object that is the node the connects externally to this site pin, or null if pin name could not be found.
    
    Since:
    
    2018.2.0
  - getConnectedNode
```
public Node getConnectedNode(int pinIndex)
```
    Creates and returns the corresponding node that connects to specified site pin provided.
    
    Parameters:
    
    pinIndex - Index of the pin in the site type that refers to the site pin in question.
    
    Returns:
    
    A new Node object that is the node the connects externally to this site pin. Returns null if pin index is < 0.
    
    Since:
    
    2018.2.0
  - getSiteIndexInTile
```
public int getSiteIndexInTile()
```
    Gets the index of this site as stored in its parent tile.
    
    Returns:
    
    The index of this site among other sites in the tile.
    
    Since:
    
    2018.2.0
  - isGlobalClkPad
```
public boolean isGlobalClkPad()
```
    Checks if this site is a global clk pad (IS_GLOBAL_CLOCK_PAD).
    
    Returns:
    
    True if this is global clock pad, false otherwise
    
    Since:
    
    2020.2
  - isGlobalClkBuffer
```
public boolean isGlobalClkBuffer()
```
    Checks if this site is a global clk buffer (IS_GLOBAL_CLOCK_BUFFER).
    
    Returns:
    
    True if this is global clock buffer, false otherwise
    
    Since:
    
    2020.2
  - isRegionalClkPad
```
public boolean isRegionalClkPad()
```
    Checks if this site is a regional clk pad (IS_REGIONAL_CLOCK_PAD).
    
    Returns:
    
    True if this is regional clock pad, false otherwise
    
    Since:
    
    2020.2
  - isRegionalClkBuffer
```
public boolean isRegionalClkBuffer()
```
    Checks if this site is a regional clk buffer (IS_REGIONAL_CLOCK_BUFFER).
    
    Returns:
    
    True if this is regional clock buffer, false otherwise
    
    Since:
    
    2020.2
  - getSiteTypeEnum
```
public SiteTypeEnum getSiteTypeEnum()
```
    Gets and returns the native type of primitive of this primitive site.
    
    Returns:
    
    the site type
    
    Since:
    
    2018.2.0
  - getAlternateSiteTypeEnums
```
public SiteTypeEnum[] getAlternateSiteTypeEnums()
```
    Gets the alternate site types compatible with this site.
    Vivado Tcl:
    get_property ALTERNATE_SITE_TYPES [get_sites $this]
    Returns: The alternate site types compatible with this site. Since: 2018.2.1
  getBEL public BEL getBEL(String name) Gets and returns the named element type from the site. Vivado Tcl: get_bels -of_objects [get_sites $site] -filter NAME==$site/$name Parameters: name - Name of the element type to get. Returns: The BEL or null if none exists with the given name. Since: 2018.2.0 getBELs public BEL[] getBELs() Gets and returns the BELs of this site. Vivado Tcl: get_bels -of_objects [get_sites $site] Returns: The BELs of this site. Since: 2018.2.2 getInstanceX public int getInstanceX() Gets and returns the integer X value of the instance location (ex: SLICE_X5Y10, it will return 5). Specified by: getInstanceX in interface PBlockCorner Returns: The X integer value of the site name or -1 if this instance is not placed or does not have X/Y coordinates in the site name. Since: 2018.2.0 getInstanceY public int getInstanceY() Gets and returns the integer Y value of the instance location (ex: SLICE_X5Y10, it will return 10). Specified by: getInstanceY in interface PBlockCorner Returns: The Y integer value of the site name or -1 if this instance is not placed or does not have X/Y coordinates in the site name. Since: 2018.2.0 getRpmX public int getRpmX() Gets the RPM X coordinate of this site. Vivado Tcl: get_property RPM_X [get_sites $site] Returns: RPM X Since: 2018.2.0 getRpmY public int getRpmY() Gets the RPM Y coordinate of this site. Vivado Tcl: get_property RPM_Y [get_sites $site] Returns: RPM Y coordinate Since: 2018.2.0 hasPin public boolean hasPin(String pinName) Checks if the site pin exists on this site. Vivado Tcl: [get_site_pins -of [get_sites $site] -filter NAME==$site/$pinName] != "" Parameters: pinName - Name of the site pin to check. Returns: True if this site has the named site pin, false otherwise. Since: 2018.2.0 isCompatibleSiteType public boolean isCompatibleSiteType(SiteTypeEnum otherType) This method will check if the SiteTypeEnum otherType can be placed at this primitive site. Most often only if they are equal can this be true. However there are a few special cases that require extra handling. For example a SLICEL can reside in a SLICEM site but not vice versa. Parameters: otherType - The primitive type to try to place on this site. Returns: True if otherType can be placed at this primitive site, false otherwise. Since: 2018.2.0 getNeighborSite public Site getNeighborSite(int dx, int dy) This will attempt to locate a neighbor site of similar type (pblock-compatible) with the provided X,Y offset. For example, if this method was called on the site SLICE_X2Y2.getNeighborSite(-1,3), it should return the site SLICE_X1Y5, if it exists in the device. Parameters: dx - The X offset of the desired neighbor site. dy - The Y offset of the desired neighbor site. Returns: The neighbor site at the specified offset, or null if it couldn't be found. Since: 2018.2.0 isCompatibleSiteType public boolean isCompatibleSiteType(Site otherSite) This method gets the type of otherSite and calls the other method public boolean isCompatibleSiteType(SiteTypeEnum otherType); See that method for more information. Parameters: otherSite - The other site to see if its type is compatible with this site. Returns: True if compatible, false otherwise. Since: 2018.2.0 toString public String toString() Overrides: toString in class Object hashCode public int hashCode() Overrides: hashCode in class Object equals public boolean equals(Object obj) Overrides: equals in class Object getIntTile public Tile getIntTile() Gets the approximate INT tile to which this site connects. Some site types connect to more than one INT tile, thus the returned INT tile could be arbitrary. Returns: The approximate INT tile connected to this site or null if none could be found. Since: 2018.2.0 getCorrespondingSite public Site getCorrespondingSite(SiteTypeEnum type, Tile newSiteTile) A method to get the corresponding primitive site for current in a different tile. For example in a Virtex 7, there are 2 slices in a CLB tile, when moving a module the current slice must go in the same spot in a new CLB tile Parameters: current - The current primitive site of the instance. newSiteTile - The tile of the new proposed site. Returns: The corresponding site in tile newSite, or null if no corresponding site exists. Since: 2018.2.0 getSiteWireIndex public Integer getSiteWireIndex(String siteWireName) Looks up the index by name of the site wire within the site. Vivado GUI: Site Properties->Site Wires Parameters: siteWireName - Name of the wire in the site. Returns: The index of the site wire in the site or null if none could be found. Since: 2018.3.0 getSiteWireCount public int getSiteWireCount() Returns the total number of site wires in this site. Returns: The number of site wires in this site (based on its site type) Since: 2019.2.2 getSiteWireName public String getSiteWireName(int wireIndex) Gets the site wire name from a site wire index Parameters: wireIndex - The index of the wire in the site (type) Returns: Name of the site wire at the provided index Since: 2019.2.2 getSitePinCount public int getSitePinCount() Gets the total number of site pins on this site (type). Returns: Number of site pins on this site. Since: 2019.2.2 getHighestInputPinIndex public int getHighestInputPinIndex() The largest site pin index that is an input. Site pin indices are ordered by direction, first inputs then outputs. Returns: The largest site pin index on this site. Since: 2019.2.2 isInputPin public boolean isInputPin(int pinIndex) Checks if the provide site pin index is an input Parameters: pinIndex - Index of the site pin in question Returns: True if the provided site pin index is of an input, false otherwise. Since: 2019.2.2 isOutputPin public boolean isOutputPin(int pinIndex) Checks if the provide site pin index is an output Parameters: pinIndex - Index of the site pin in question Returns: True if the provided site pin index is of an input, false otherwise. Since: 2019.2.2 getSitePIPs public SitePIP[] getSitePIPs() Gets the array of site PIPs in this site. Returns: The array of site PIPs in the site. Since: 2019.2.2 getSitePIP public SitePIP getSitePIP(int index) Gets the site PIP at the provided index Parameters: index - The index of the site PIP to retrieve Returns: The site PIP in the site at the provided index. Since: 2019.2.2 getSitePIPCount public int getSitePIPCount() Gets the number of site PIPs in this site. Returns: The number of site PIPs in this site. Since: 2019.2.2 getSiteWireNames public String[] getSiteWireNames() Gets the array of site wire names for this site. Returns: The array of site wire names for this site. Since: 2019.2.2 getBELPins public BELPin[] getBELPins(int siteWireIndex) For a given site wire index (or ID), gets all connected BEL pins of the site wire. Vivado GUI: Site Wire Properties->BEL Pins Parameters: siteWireIndex - Index of the site wire to query. Returns: An array of element pins that connect to the site wire requested. Since: 2018.3.0 getBELPins public BELPin[] getBELPins(String siteWireName) For a given site wire name, this will return all connected BEL pins of the site wire. Vivado GUI: Site Wire Properties->BEL Pins Parameters: siteWireName - Name of the site wire to query. Returns: A list of BEL pins connected to the site wire. Since: 2018.3.0 isOutputPin public boolean isOutputPin(String pinName) Determine if the named site pin is an output Vivado Tcl: [get_property DIRECTION [get_site_pins $site/$pinName]]=="OUT" Parameters: name - The site pin name Returns: True if it exists and is an output, false otherwise Since: 2018.2.0 isInputPin public boolean isInputPin(String pinName) Determine if the named site pin is an input Vivado Tcl: [get_property DIRECTION [get_site_pins $site/$pinName]]=="IN" Parameters: name - The site pin name Returns: True if it exists and is an input, false otherwise Since: 2018.2.0 getPinIndex public int getPinIndex(String pinName) Gets the site pin index for the named site pin. Vivado Tcl: get_property INDEX [get_site_pins -of_objects [get_sites $site] -filter NAME==$site/$pinName] Parameters: pinName - Name of the site pin. Returns: The index of the site pin in the site, or -1 if no such pin exists. Since: 2018.2.0 getPinName public String getPinName(int pinIndex) Gets the name of the site pin of the provided pin index. Vivado Tcl: set n [get_site_pins -of [get_sites $site] -filter INDEX==$pinIndex];string range $n [string last "/" $n]+1 [string length $n] Parameters: pinIndex - Index of the pin within the site. Returns: The name of the pin or -1 if non existent. Since: 2018.2.0 getSitePIP public SitePIP getSitePIP(BELPin input) Gets the site PIP connecting the two element (BEL) pins provided. Vivado Tcl: get_site_pips -of [get_sites $site] -filter {FROM_PIN==$input && TO_PIN==$output} Parameters: input - Input pin of the element. output - Output pin of the element. Returns: The site PIP that connects the specified input to output pins. Since: 2018.3.0 getBELPin public BELPin getBELPin(String name) Get the BEL pin object from its hierarchical name (i.e. BEL/PIN or SITE_PIN) Vivado Tcl: get_bel_pins -of $this -filter NAME==$name Parameters: name - Hierarchical name or site pin name Returns: The BEL pin if it exists, null otherwise. Since: 2018.2.0 getBELPin public BELPin getBELPin(String belName, String pinName) Get the BEL pin object from its hierarchical name (i.e. BEL/PIN or SITE_PIN) Vivado Tcl: get_bel_pins -of $this -filter NAME==$belName/$pinName Parameters: name - Hierarchical name or site pin name Returns: The BEL pin if it exists, null otherwise. Since: 2018.2.0 getClockRegion public ClockRegion getClockRegion() Gets the clock region to which this site belongs. This is the same as getTile().getClockRegion(). Returns: The clock region to which this site belongs. Since: 2021.2.1

Class Site

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

compatibleTypesArray

Method Detail

getName

getNameSpacePrefix

getDevice

getTile

getTileWireNameFromPinName

getTileWireIndexFromPinName

getConnectedNode

getConnectedNode

getSiteIndexInTile

isGlobalClkPad

isGlobalClkBuffer

isRegionalClkPad

isRegionalClkBuffer

getSiteTypeEnum

getAlternateSiteTypeEnums

getBEL

getBELs

getInstanceX

getInstanceY

getRpmX

getRpmY

hasPin

isCompatibleSiteType

getNeighborSite

isCompatibleSiteType

toString

hashCode

equals

getIntTile

getCorrespondingSite

getSiteWireIndex

getSiteWireCount

getSiteWireName

getSitePinCount

getHighestInputPinIndex

isInputPin

isOutputPin

getSitePIPs

getSitePIP

getSitePIPCount

getSiteWireNames

getBELPins

getBELPins

isOutputPin

isInputPin

getPinIndex

getPinName

getSitePIP

getBELPin

getBELPin

getClockRegion