SiteInst

Object
- com.xilinx.rapidwright.design.SiteInst

All Implemented Interfaces:

Serializable, Comparable<SiteInst>
```
public class SiteInst
extends Object
implements Serializable, Comparable<SiteInst>
```
This class represents the instance of a site as configured by the user design. It can be part of a ModuleInst or part of a Design. It differs from the Site class in that it carries configuration data from the user design whereas Site is static and only represents available constructs in the silicon.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String STATIC_SOURCE
Sentinel named SiteInst that is used to provide a static source (such as a configured LUT)

Fields
Modifier and Type	Field and Description
`static String`	`STATIC_SOURCE` Sentinel named SiteInst that is used to provide a static source (such as a configured LUT)

Constructor Summary

Constructors
Constructor and Description
`SiteInst()` Creates a new Instance, everything is empty, false or -1
`SiteInst(String name, Design design, SiteTypeEnum type, Site site)` Creates a new site instance called name of type type and places it on the site site.
`SiteInst(String name, Module module, SiteTypeEnum type, Site site)` Creates a new site instance to be a part of a `Module`.
`SiteInst(String name, SiteTypeEnum type)` Creates a new site instance called name of type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cell`	`addCell(Cell c)` Adds a cell to the instance.
`void`	`addPin(SitePinInst sitePinInst)` Adds a pin to the pin map of this instance and attaches the net to the corresponding site wire.
`void`	`addSitePIP(SitePIP sitePIP)` Turns on the provided SitePIP in this site.
`void`	`addSitePIP(String belName, String inputPin)` Turns on the provided SitePIP in this site.
`int`	`compareTo(SiteInst o)`
`Cell`	`createCell(EDIFHierCellInst inst, BEL bel)` Creates a physical cell from the provided logical hierarchical cell instance and places it on the provided bel in this SiteInst.
`void`	`detachFromModule()` This method will detach and remove all reference of the instance to a module or module instance.
`boolean`	`equals(Object obj)` Checks if this instance is equal to obj.
`String`	`getAlternateSitePinName(String primarySitePinName)` If this site instance is set to an alternate site type, this method will get the corresponding alternate site pin name from the primary site pin name.
`SiteTypeEnum[]`	`getAlternateSiteTypeEnums()` Gets alternate site types (if any) for the current site of this site instance.
`BEL`	`getBEL(String belName)` Gets and returns the named BEL from the site instance.
`BELPin`	`getBELPin(String belName, String pinName)` Gets a bel pin by name
`BEL[]`	`getBELs()` Gets the BELs of this site
`Cell`	`getCell(BEL bel)` Gets the cell at the BEL location in this site.
`Cell`	`getCell(String belName)` Gets a cell by BEL name
`Map<String,Cell>`	`getCellMap()` Gets the map of all cells in this site instance, keyed by BEL name.
`Collection<Cell>`	`getCells()` Gets all cells in this site instance.
`Set<Net>`	`getConnectedNets()` Gets and returns the nets that connect to this instance.
`Design`	`getDesign()` Gets and returns the design which this instance is a part of.
`int`	`getHighestSitePinInputIndex()` Gets and returns the index of the last site pin in this site type (names are ordered with inputs first)
`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).
`ModuleInst`	`getModuleInst()` Gets the module instance this Instance is a member of.
`String`	`getModuleInstName()` Gets the name of the instance of the module this Instance is a member of.
`Module`	`getModuleTemplate()` Gets the module template this instance is a member of
`SiteInst`	`getModuleTemplateInst()` Gets and returns the instance found in the module which this instance implements.
`String`	`getName()` Gets the user name of the instance
`Net`	`getNetFromSiteWire(String siteWireName)` Gets the net assigned to the given site wire.
`Map<Net,List<String>>`	`getNetToSiteWiresMap()` Gets a map of nets in this site instance and the list of site wires they each map to.
`String`	`getPrimarySitePinName(String alternateSitePinName)` For site pins on alternate site type instances, there is a mapping to the primary site type pin name.
`SiteTypeEnum`	`getPrimarySiteTypeEnum()` Gets the primary site type (default type) for the site of this site instance.
`SiteInst`	`getReferenceCopy()` Creates a reference copy of this SiteInst--a deep copy of the SiteInst without this new instance being referenced in the design object.
`Site`	`getSite()` Gets the Site for this instance.
`String`	`getSiteName()` Gets the string that defines the instance location (such as 'SLICE_X0Y0')
`SitePinInst`	`getSitePinInst(String pinName)` This method will get and return the instantiation of the `SitePinInst` class object that represents a used pin on this instance given the pin name.
`Map<String,SitePinInst>`	`getSitePinInstMap()` Gets the pin map for this instance.
`Set<String>`	`getSitePinInstNames()` Gets all the pin names that are currently being used on this instance.
`Collection<SitePinInst>`	`getSitePinInsts()` Gets and returns the set of pins being used on this instance.
`String[]`	`getSitePinNames()` Gets the array of all site pin names for this site type.
`SitePIP`	`getSitePIP(BELPin inputPin)` Gets the site PIP that connects to the BEL input pin provided
`SitePIP`	`getSitePIP(String belName, String inputPin)` Gets the site PIP by the specified BEL and input/output pin names
`SitePIP[]`	`getSitePIPs()` This will get the SitePIPs of the site type this SiteInst instantiates.
`SitePIPStatus`	`getSitePIPStatus(int index)` Determines if the indexed site PIP is enabled or not.
`SitePIPStatus`	`getSitePIPStatus(SitePIP sitePIP)` Determines if the referenced site PIP is enabled or not.
`SiteTypeEnum`	`getSiteTypeEnum()` Gets the type of the site instance (such as "SLICEL" or "SLICEM").
`BELPin[]`	`getSiteWirePins(int siteWireIdx)` Gets the site wire's connected BELPins for the current site type of this site instance.
`BELPin[]`	`getSiteWirePins(String siteWireName)` Gets the site wire's connected BELPins for the current site type of this site instance.
`String[]`	`getSiteWires()` Gets the array of site wire names for the type of this site instance.
`List<String>`	`getSiteWiresFromNet(Net net)` Gets all site wire names occupied by the provided net.
`Map<String,Net>`	`getSiteWireToNetMap()` Gets a map that provides the mapping between a site wire name and its net within a site.
`Tile`	`getTile()` Gets the tile object where this instance resides on the chip
`SitePIP`	`getUsedSitePIP(BEL bel)` This method will return the first used SitePIP of the provided BEL or null if none exists.
`SitePIP`	`getUsedSitePIP(BELPin p)` This method will return the first used SitePIP of the provided BELPin or null if none exists.
`SitePIP`	`getUsedSitePIP(String belName)` This method will return the first used SitePIP of the provided BEL name or null if none exists.
`List<SitePIP>`	`getUsedSitePIPs()` Creates a new list that contains all used sitePIPs that are turned on.
`int`	`hashCode()` Generates a hash code for the instance based on instance name.
`boolean`	`hasUsedSitePIPs()` Checks if this site instance has used site PIPs.
`boolean`	`isAnchor()` A method to determine if this instance corresponds to the anchor instance in a module instance, or is the anchor for a module.
`boolean`	`isMemberOfSameModuleInst(SiteInst inst)` Checks if the instance inst and this instance are members of the same module instance.
`Boolean`	`isPlaced()` Determines if the instance is placed or unplaced
`boolean`	`isSiteLocked()` Checks if this site is locked to its site
`boolean`	`isSitePinInput(String pinName)` Checks if the provided site pin name is an input.
`boolean`	`isSitePinOutput(String pinName)` Checks if the provided site pin name is an output.
`void`	`place(Site site)` Places the site instance at the site specified.
`Cell`	`removeCell(BEL bel)` Removes the cell from the specified BEL in this site instance
`boolean`	`removePin(SitePinInst sitePinInst)` Removes a pin from this instance.
`boolean`	`routeIntraSiteNet(Net net, BELPin src, BELPin snk)` Routes an intra-site net (or the portion of a net that is inside this site).
`void`	`routeSite()` Routes all the nets inside of a site.
`void`	`setDesign(Design design)` Sets the design which this instance is a part of.
`void`	`setModuleInst(ModuleInst instanceModule)` Sets the module instance of this instance (the instance of a module to which this instance belongs).
`void`	`setModuleTemplate(Module instanceModuleTemplate)` Sets the module class this instance implements.
`void`	`setModuleTemplateInst(SiteInst moduleTemplateInstance)` Sets the corresponding instance inside a module template of this instance.
`void`	`setName(String name)` Sets the user name of the instance
`void`	`setSiteLocked(boolean isSiteLocked)` Sets this state of the site as locked or not
`String`	`toString()`
`void`	`trackChanges()`
`void`	`unPlace()` Removes all placement information for the instance.
`boolean`	`unrouteIntraSiteNet(BELPin src, BELPin snk)` Unroutes an intra-site net (or the portion of a net that is inside this site).
`void`	`unrouteSite()` Unroutes the entire site.

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

- Field Detail
  - STATIC_SOURCE
```
public static final String STATIC_SOURCE
```
    Sentinel named SiteInst that is used to provide a static source (such as a configured LUT)
    
    Since:
    
    2021.1.2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SiteInst
```
public SiteInst()
```
    Creates a new Instance, everything is empty, false or -1
    
    Since:
    
    2018.2.0
  - SiteInst
```
public SiteInst(String name,
                SiteTypeEnum type)
```
    Creates a new site instance called name of type.
    
    Parameters:
    
    name - name of the new site instance.
    
    type - The instance type of the new site instance.
    
    Since:
    
    2018.2.0
  - SiteInst
```
public SiteInst(String name,
                Design design,
                SiteTypeEnum type,
                Site site)
```
    Creates a new site instance called name of type type and places it on the site site.
    
    Parameters:
    
    name - name of the new site instance.
    
    type - The instance type of the new instance.
    
    Since:
    
    2018.2.0
  - SiteInst
```
public SiteInst(String name,
                Module module,
                SiteTypeEnum type,
                Site site)
```
    Creates a new site instance to be a part of a Module.
    
    Parameters:
    
    name - Name of the site instance
    
    module - Module to which this site instance will belong
    
    type - The site type of the module instance
    
    site - The site where the site instance would be placed
    
    Since:
    
    2018.2.0
- Method Detail
  - getReferenceCopy
```
public SiteInst getReferenceCopy()
```
    Creates a reference copy of this SiteInst--a deep copy of the SiteInst without this new instance being referenced in the design object.
    
    Returns:
    
    The newly created reference copy of this SiteInst.
    
    Since:
    
    2023.1.3
  - getModuleInstName
```
public String getModuleInstName()
```
    Gets the name of the instance of the module this Instance is a member of.
    
    Returns:
    
    The name of the instance of the module or null if none exists.
    
    Since:
    
    2018.2.0
  - getModuleInst
```
public ModuleInst getModuleInst()
```
    Gets the module instance this Instance is a member of.
    
    Returns:
    
    The module instance or null if none exists
    
    Since:
    
    2018.2.0
  - isAnchor
```
public boolean isAnchor()
```
    A method to determine if this instance corresponds to the anchor instance in a module instance, or is the anchor for a module.
    
    Returns:
    
    True if this instance is the anchor in a module or module instance, false otherwise.
    
    Since:
    
    2018.2.0
  - setModuleInst
```
public void setModuleInst(ModuleInst instanceModule)
```
    Sets the module instance of this instance (the instance of a module to which this instance belongs).
    
    Parameters:
    
    instanceModule - The module instance of this instance.
    
    Since:
    
    2018.2.0
  - isMemberOfSameModuleInst
```
public boolean isMemberOfSameModuleInst(SiteInst inst)
```
    Checks if the instance inst and this instance are members of the same module instance.
    
    Parameters:
    
    inst - The instance to check.
    
    Returns:
    
    True if both instances are members of the same module instance false otherwise.
    
    Since:
    
    2018.2.0
  - getModuleTemplate
```
public Module getModuleTemplate()
```
    Gets the module template this instance is a member of
    
    Returns:
    
    The module template this instance is a member of
    
    Since:
    
    2018.2.0
  - setModuleTemplate
```
public void setModuleTemplate(Module instanceModuleTemplate)
```
    Sets the module class this instance implements.
    
    Parameters:
    
    instanceModuleTemplate - The module which this instance implements.
    
    Since:
    
    2018.2.0
  - setModuleTemplateInst
```
public void setModuleTemplateInst(SiteInst moduleTemplateInstance)
```
    Sets the corresponding instance inside a module template of this instance.
    
    Parameters:
    
    moduleTemplateInstance - The instance in the module to which this instance corresponds.
    
    Since:
    
    2018.2.0
  - getModuleTemplateInst
```
public SiteInst getModuleTemplateInst()
```
    Gets and returns the instance found in the module which this instance implements.
    
    Returns:
    
    The instance found in the module which this instance implements.
    
    Since:
    
    2018.2.0
  - detachFromModule
```
public void detachFromModule()
```
    This method will detach and remove all reference of the instance to a module or module instance.
    
    Since:
    
    2018.2.0
  - getName
```
public String getName()
```
    Gets the user name of the instance
    
    Returns:
    
    The user assigned name of the instance
    
    Since:
    
    2018.2.0
  - getSiteTypeEnum
```
public SiteTypeEnum getSiteTypeEnum()
```
    Gets the type of the site instance (such as "SLICEL" or "SLICEM"). If the site instance type is set (through the constructor SiteInst), then that type will take precedence. If the site instance type is not specified in the constructor, the method will get the default type from its current site.
    
    Returns:
    
    The type of site for this instance or null if the type is not explicitly set or the site instance is unplaced.
    
    Since:
    
    2018.2.0
  - getPrimarySiteTypeEnum
```
public SiteTypeEnum getPrimarySiteTypeEnum()
```
    Gets the primary site type (default type) for the site of this site instance. This is in contrast to other alternate site types (See Site.getAlternateSiteTypeEnums()) that can be applied to this site instance's site. The current site instance may or may not be configured with the primary site type.
    Vivado Tcl:
    get_property SITE_TYPE [get_sites $this]
    Returns: The primary site type for the site of this site instance. Since: 2018.2.1
  getAlternateSiteTypeEnums public SiteTypeEnum[] getAlternateSiteTypeEnums() Gets alternate site types (if any) for the current site of this site instance. This is the same as . Vivado Tcl: get_property ALTERNATE_SITE_TYPES $site Returns: Array of alternate site types for the current site of this site instance. Since: 2018.2.1 isPlaced public Boolean isPlaced() Determines if the instance is placed or unplaced Returns: True if the instance is placed, false otherwise Since: 2018.2.0 getTile public Tile getTile() Gets the tile object where this instance resides on the chip Vivado Tcl: get_tiles -of $site Returns: The tile object where this instance resides Since: 2018.2.0 getSiteName public String getSiteName() Gets the string that defines the instance location (such as 'SLICE_X0Y0') Returns: The name of the site or null if not placed. Since: 2018.2.0 getSite public Site getSite() Gets the Site for this instance. Returns: The Site or null if it is not placed. Since: 2018.2.0 getBEL public BEL getBEL(String belName) Gets and returns the named BEL from the site instance. 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 the BELs of this site Vivado Tcl: get_bels -of_objects [get_sites $site] Returns: The BELs of this site or null if none exist with the provided name Since: 2018.2.2 getBELPin public BELPin getBELPin(String belName, String pinName) Gets a bel pin by name Parameters: belName - Name of the BEL on which the pin resides pinName - The name of the pin on the BEL Returns: The BELPin that matches the names provided or null if it couldn't be found. Since: 2022.1.2 getPrimarySitePinName public String getPrimarySitePinName(String alternateSitePinName) For site pins on alternate site type instances, there is a mapping to the primary site type pin name. This method gets the primary site pin name corresponding to the provided alternate site pin name. Parameters: alternateSitePinName - Sute pin name on a compatible alternate site type. Returns: Corresponding site pin name on the primary site type. Since: 2018.2.2 getAlternateSitePinName public String getAlternateSitePinName(String primarySitePinName) If this site instance is set to an alternate site type, this method will get the corresponding alternate site pin name from the primary site pin name. Parameters: primarySitePinName - Name of the primary site pin. Returns: The corresponding alternate site pin name. Since: 2018.2.2 setDesign public void setDesign(Design design) Sets the design which this instance is a part of. The design should be null if it is a module definition. Parameters: design - the new design of this instance. Since: 2018.2.0 getDesign public Design getDesign() Gets and returns the design which this instance is a part of. Returns: the design this instance is a part of, null if this instance is a member of a module definition. Since: 2018.2.0 setName public void setName(String name) Sets the user name of the instance Parameters: name - The desired name for the instance Since: 2018.2.0 place public void place(Site site) Places the site instance at the site specified. Parameters: site - The site where the instance will reside Since: 2018.2.0 unPlace public void unPlace() Removes all placement information for the instance. Since: 2018.2.0 getConnectedNets public Set<Net> getConnectedNets() Gets and returns the nets that connect to this instance. Returns: the set of nets that connect to this SiteInst Since: 2021.2.2 getInstanceX public int getInstanceX() Gets and returns the integer X value of the instance location (ex: SLICE_X5Y10, it will return 5). 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). 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 addPin public void addPin(SitePinInst sitePinInst) Adds a pin to the pin map of this instance and attaches the net to the corresponding site wire. Parameters: sitePinInst - The pin to add. Since: 2023.1.3 removePin public boolean removePin(SitePinInst sitePinInst) Removes a pin from this instance. Parameters: sitePinInst - The pin to remove. Returns: True if operation completed successfully, false otherwise. Since: 2022.1.3 getSitePinInst public SitePinInst getSitePinInst(String pinName) This method will get and return the instantiation of the SitePinInst class object that represents a used pin on this instance given the pin name. Parameters: pinName - Name of the pin on this instance. Returns: The Pin instantiation with matching pinName. Since: 2018.2.0 getSitePinInstMap public Map<String,SitePinInst> getSitePinInstMap() Gets the pin map for this instance. Returns: Returns the pin map for this instance. Since: 2018.2.0 getSitePinInstNames public Set<String> getSitePinInstNames() Gets all the pin names that are currently being used on this instance. Returns: A set of pin names used on this instance. Since: 2018.2.0 getSitePinInsts public Collection<SitePinInst> getSitePinInsts() Gets and returns the set of pins being used on this instance. Returns: A set of pins being used on this instance. Since: 2018.2.0 hashCode public int hashCode() Generates a hash code for the instance based on instance name. Instance names should be unique throughout a design. Overrides: hashCode in class Object equals public boolean equals(Object obj) Checks if this instance is equal to obj. Checks only instance name to determine equality as instance names should be unique throughout a design. Overrides: equals in class Object toString public String toString() Overrides: toString in class Object addCell public Cell addCell(Cell c) Adds a cell to the instance. Parameters: c - The cell to add. Returns: The previous cell of the same name, or null if it is unique. Since: 2018.2.0 createCell public Cell createCell(EDIFHierCellInst inst, BEL bel) Creates a physical cell from the provided logical hierarchical cell instance and places it on the provided bel in this SiteInst. Parameters: inst - The logical hierarchical cell instance bel - The location of where to place the cell within this SiteInst Returns: The newly created and placed cell or null if the cell could not be placed. Since: 2021.1.1 getCellMap public Map<String,Cell> getCellMap() Gets the map of all cells in this site instance, keyed by BEL name. Returns: a map from BEL names to cell objects Since: 2018.2.0 getCell public Cell getCell(String belName) Gets a cell by BEL name Parameters: belName - The name of the BEL where the cell is placed Returns: The cell, or null if none exists Since: 2018.2.0 getCell public Cell getCell(BEL bel) Gets the cell at the BEL location in this site. Parameters: bel - The BEL in question Returns: The cell placed at the provided BEL, or null if none exists Since: 2018.3.1 compareTo public int compareTo(SiteInst o) Specified by: compareTo in interface Comparable<SiteInst> isSiteLocked public boolean isSiteLocked() Checks if this site is locked to its site Returns: True if the site is locked, false otherwise Since: 2020.1.2 setSiteLocked public void setSiteLocked(boolean isSiteLocked) Sets this state of the site as locked or not Parameters: isSiteLocked - True for a locked site, false for not locked Since: 2020.1.2 getNetToSiteWiresMap public Map<Net,List<String>> getNetToSiteWiresMap() Gets a map of nets in this site instance and the list of site wires they each map to. Returns: A map of nets to a list of site wires it occupies Since: 2022.1.1 getSitePIPs public SitePIP[] getSitePIPs() This will get the SitePIPs of the site type this SiteInst instantiates. This is the complete list of available SitePIPs on the site, not just the ones in use. Returns: The array of all available SitePIPs on the site this SiteInst instantiates. Since: 2020.2.5 getUsedSitePIP public SitePIP getUsedSitePIP(BELPin p) This method will return the first used SitePIP of the provided BELPin or null if none exists. If there is more than one used SitePIP, it will only return the first. Parameters: p - The element pin of interest Returns: The first used SitePIP or null if none are used. Since: 2018.2.0 getUsedSitePIP public SitePIP getUsedSitePIP(String belName) This method will return the first used SitePIP of the provided BEL name or null if none exists. If there is more than one used SitePIP, it will only return the first. Parameters: belName - The name of the element of interest Returns: The first used SitePIP or null if none are used. Since: 2018.2.0 getUsedSitePIP public SitePIP getUsedSitePIP(BEL bel) This method will return the first used SitePIP of the provided BEL or null if none exists. If there is more than one used SitePIP, it will only return the first. Parameters: bel - The element of interest Returns: The first used SitePIP or null if none are used. Since: 2024.1.2 getUsedSitePIPs public List<SitePIP> getUsedSitePIPs() Creates a new list that contains all used sitePIPs that are turned on. Returns: A new list of sitePIP objects that are used in this site instance. Since: 2018.2.0 hasUsedSitePIPs public boolean hasUsedSitePIPs() Checks if this site instance has used site PIPs. Returns: True if at least one site PIP is used Since: 2018.2.0 addSitePIP public void addSitePIP(SitePIP sitePIP) Turns on the provided SitePIP in this site. Vivado Tcl: set_property MANUAL_ROUTING [get_property SITE_TYPE $site] $site;set_property SITE_PIPS "[get_property SITE_PIPS $site] $sitePIP" $site;set_property MANUAL_ROUTING {} $site Parameters: sitePIP - The site PIP to active. Since: 2018.2.0 addSitePIP public void addSitePIP(String belName, String inputPin) Turns on the provided SitePIP in this site. Vivado Tcl: set_property MANUAL_ROUTING [get_property SITE_TYPE $site] $site;set_property SITE_PIPS "[get_property SITE_PIPS $site] ${belName}:${inputPin}" $site;set_property MANUAL_ROUTING {} $site Parameters: belName - Name of the BEL inputPin - Name of the input BEL pin Since: 2018.3.0 getSitePIP public SitePIP getSitePIP(String belName, String inputPin) Gets the site PIP by the specified BEL and input/output pin names Vivado Tcl: get_site_pips -of [get_sites $site] -filter NAME==$site/$belName:$inputPin Parameters: belName - Name of the BEL inputPin - Name of the input pin Returns: The site PIP specified or null if none could be found. Since: 2018.3.0 getSitePIP public SitePIP getSitePIP(BELPin inputPin) Gets the site PIP that connects to the BEL input pin provided Parameters: inputPin - The BEL input pin that starts the site PIP. Returns: The connected site PIP or null if it couldn't be found. Since: 2019.2.1 getSiteWiresFromNet public List<String> getSiteWiresFromNet(Net net) Gets all site wire names occupied by the provided net. Vivado GUI: For each Site Wire in Site; Right click on Site Wire->Select->Net; if {$net == [get_selected]}insert (Site Wire) in set Parameters: net - The net to query Returns: The list of all site wire names occupied by the specified net. Since: 2018.3.2 getNetFromSiteWire public Net getNetFromSiteWire(String siteWireName) Gets the net assigned to the given site wire. Vivado GUI: Right click on Site Wire->Select->Net Parameters: siteWireName - Name of the site wire in the site Returns: The physical net that is routed (possibly partially) on the specified site wire. Since: 2018.2.0 getSiteWireToNetMap public Map<String,Net> getSiteWireToNetMap() Gets a map that provides the mapping between a site wire name and its net within a site. Vivado GUI: For each Site Wire in Site; Right click on Site Wire->Select->Net; insert (Site Wire, Net) in map Returns: The map between site wire names and nets in a site. Since: 2022.1.0 getCells public Collection<Cell> getCells() Gets all cells in this site instance. This also includes the special case cells that are routethrus (see Cell.isRoutethru(), but they are not part of the logical design. Returns: the cells in this site instance Since: 2018.2.0 removeCell public Cell removeCell(BEL bel) Removes the cell from the specified BEL in this site instance Parameters: bel - The BEL where the to be removed cell resides. Returns: The removed cell. Since: 2018.2.0 getSitePIPStatus public SitePIPStatus getSitePIPStatus(SitePIP sitePIP) Determines if the referenced site PIP is enabled or not. Vivado Tcl: set_property MANUAL_ROUTING [get_property SITE_TYPE $site] $site;lsearch -exact [get_property SITE_PIPS $site] $sitePIP;set_property MANUAL_ROUTING {} $site Parameters: sitePIP - The site PIP to query Returns: The status of the site PIP in the design. Since: 2018.2.0 getSitePIPStatus public SitePIPStatus getSitePIPStatus(int index) Determines if the indexed site PIP is enabled or not. Vivado Tcl: set_property MANUAL_ROUTING [get_property SITE_TYPE $site] $site;set sp [lindex [get_site_pips -of $site] $index; lsearch -exact [get_property SITE_PIPS $site] $sp;set_property MANUAL_ROUTING {} $site Parameters: sitePIP - The site PIP to query Returns: The status of the site PIP in the design. Since: 2018.2.0 unrouteSite public void unrouteSite() Unroutes the entire site. Removes all sitePIPs and nets occupying site wires. Since: 2020.1.3 unrouteIntraSiteNet public boolean unrouteIntraSiteNet(BELPin src, BELPin snk) Unroutes an intra-site net (or the portion of a net that is inside this site). Routethru cells are removed where necessary. For certain BEL routethrus which require a static net input (e.g. F7MUX) intra- and relevant inter-site routing along with its input SitePinInst will also be removed. Parameters: src - Start/source of the intra-site net snk - End/sink of the intra-site net Returns: True if unroute was successful, false otherwise Since: 2018.2.4 routeIntraSiteNet public boolean routeIntraSiteNet(Net net, BELPin src, BELPin snk) Routes an intra-site net (or the portion of a net that is inside this site). Maps the net to appropriate site wires. Routethru cells are inserted where necessary. For certain BEL routethrus which require a static net input (e.g. F7MUX) intra-site routing along with its SitePinInst will also be added. Vivado Tcl: route_design -nets $net Parameters: net - The intra-site net to route src - Start/source of the intra-site net snk - End/sink of the intra-site net Returns: True if routing the net was successful, false otherwise. Since: 2018.2.0 routeSite public void routeSite() Routes all the nets inside of a site. This method is not fully guaranteed to route the entire site exactly as Vivado. Vivado Tcl: route_design -nets [get_nets -of $site] Since: 2018.2.0 getSiteWirePins public BELPin[] getSiteWirePins(String siteWireName) Gets the site wire's connected BELPins for the current site type of this site instance. Parameters: siteWireName - Name of the site wire Returns: The array of BELPins connected to the named site wire in this site instances' type. Since: 2020.1.1 getSiteWirePins public BELPin[] getSiteWirePins(int siteWireIdx) Gets the site wire's connected BELPins for the current site type of this site instance. Parameters: siteWireIdx - Index of the site wire within the site type. Returns: The array of BELPins connected to the named site wire in this site instances' type. Since: 2020.1.1 getSiteWires public String[] getSiteWires() Gets the array of site wire names for the type of this site instance. Returns: The list of site wire names for the site type of this site instance. Since: 2020.1.1 getSitePinNames public String[] getSitePinNames() Gets the array of all site pin names for this site type. All inputs are sorted first. Returns: The array of all site pin names for this site type. Since: 2020.1.1 getHighestSitePinInputIndex public int getHighestSitePinInputIndex() Gets and returns the index of the last site pin in this site type (names are ordered with inputs first) Returns: Highest input index that is an input. Since: 2020.1.1 isSitePinInput public boolean isSitePinInput(String pinName) Checks if the provided site pin name is an input. Parameters: pinName - The name of the site pin in question. Returns: True if the site type has a pin of that name and it is an input, false otherwise. Since: 2020.1.1 isSitePinOutput public boolean isSitePinOutput(String pinName) Checks if the provided site pin name is an output. Parameters: pinName - The name of the site pin in question. Returns: True if the site type has a pin of that name and it is an output, false otherwise. Since: 2020.1.1 trackChanges public void trackChanges()

Class SiteInst

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

STATIC_SOURCE

Constructor Detail

SiteInst

SiteInst

SiteInst

SiteInst

Method Detail

getReferenceCopy

getModuleInstName

getModuleInst

isAnchor

setModuleInst

isMemberOfSameModuleInst

getModuleTemplate

setModuleTemplate

setModuleTemplateInst

getModuleTemplateInst

detachFromModule

getName

getSiteTypeEnum

getPrimarySiteTypeEnum

getAlternateSiteTypeEnums

isPlaced

getTile

getSiteName

getSite

getBEL

getBELs

getBELPin

getPrimarySitePinName

getAlternateSitePinName

setDesign

getDesign

setName

place

unPlace

getConnectedNets

getInstanceX

getInstanceY

addPin

removePin

getSitePinInst

getSitePinInstMap

getSitePinInstNames

getSitePinInsts

hashCode

equals

toString

addCell

createCell

getCellMap

getCell

getCell

compareTo

isSiteLocked

setSiteLocked

getNetToSiteWiresMap

getSitePIPs

getUsedSitePIP

getUsedSitePIP

getUsedSitePIP

getUsedSitePIPs

hasUsedSitePIPs

addSitePIP

addSitePIP

getSitePIP

getSitePIP

getSiteWiresFromNet

getNetFromSiteWire

getSiteWireToNetMap

getCells

removeCell

getSitePIPStatus

getSitePIPStatus