SitePinInst

Object
- com.xilinx.rapidwright.design.SitePinInst

All Implemented Interfaces:

Serializable, Cloneable
```
public class SitePinInst
extends Object
implements Serializable, Cloneable
```
This class represents the site pin sources and sinks in a physical net. These are target site pins for inter-site routing nets.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SitePinInst()` Constructor setting things to null and false.
`SitePinInst(boolean isOutputPin, String pinName, SiteInst instance)` Creates a pin from parameters
`SitePinInst(PinType pinType, String pinName, SiteInst instance)` Creates a pin from parameters
`SitePinInst(String pinName, SiteInst instance)` Determines pin direction from site instance type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`detachSiteInst()` Removes any reference to the site instance from this pin and removes the pin from the pin map in the site instance.
`boolean`	`equals(Object obj)` Checks if obj is a pin and if equal to this pin by comparing instance, direction and pinName.
`BELPin`	`getBELPin()` Gets the corresponding BELPin for this site pin.
`Node`	`getConnectedNode()` Creates a new node connected to this site pin.
`int`	`getConnectedWireIndex()` Gets the index of the tile wire connected to this site pin.
`String`	`getModuleInstName()` Gets and returns the module instance name corresponding to the instance of this pin.
`String`	`getName()` Gets and returns the pin name of the pin.
`Net`	`getNet()`
`RouteNode`	`getNodeFromPin()` This will creating a routing node from the pin given.
`RouteNode`	`getNodeFromPin(RouteNode parent, int level)` This will creating a routing node from the pin given.
`int`	`getNumDownhillNodes()` Counts the number of downhill nodes from the node connected to this pin.
`PinType`	`getPinType()` Gets the pin's type
`Port`	`getPort()` Gets the module port that references this pin.
`RouteNode`	`getRouteNode()` Creates and returns a new route node that connects to this pin.
`Site`	`getSite()` Gets the site this pin is placed on.
`Integer`	`getSiteExternalWireIndex()` Gets the external wire on this pin.
`SiteInst`	`getSiteInst()` Gets and returns the instance where this pin resides.
`String`	`getSiteInstName()` Gets and returns the name of the instance where this pin resides.
`String`	`getSitePinName()` Get the concatenated siteName.PinName (ex.
`SiteTypeEnum`	`getSiteTypeEnum()` Gets the site type enum for this pin's site
`List<BELPin>`	`getSiteWireBELPins()` Gets the list of BEL pins connected to this site pin internally.
`Integer`	`getSiteWireIndex()` Gets the site wire index of the wire in the site attached to this site pin.
`String`	`getSiteWireName()` Gets the site wire name of the wire in the site attached to this site pin.
`Tile`	`getTile()` Gets and returns the tile where this pin resides.
`int`	`hashCode()` Generates a hashCode based on the instance, direction and pinName.
`boolean`	`isLUTInputPin()` Checks if this pin connects to a LUT input
`static boolean`	`isLUTInputPin(SiteInst siteInst, String name)` Checks a given site and pin name to see if it is a LUT input pin.
`boolean`	`isOutPin()`
`boolean`	`isPinOnABuf()` Checks if the pin is on a BUF site
`boolean`	`isRouted()` Checks if a site pin flag is marked as routed
`boolean`	`movePin(String newName)` Updates the pin name to a new name within the site.
`void`	`setIsOutputPin(boolean dir)` Sets the direction of the pin.
`void`	`setNet(Net net)`
`void`	`setPinName(String name)` Sets the name of the pin.
`void`	`setPinType(PinType pinType)` Sets the pin's type
`void`	`setPort(Port port)` Sets the module port that references this pin.
`void`	`setRouted(boolean isRouted)` Sets a flag on this pin to mark it as routed
`void`	`setSiteInst(SiteInst instance)` Sets the instance to which this pin belongs.
`void`	`setSiteInst(SiteInst instance, boolean keepRouting)` Sets the instance to which this pin belongs.
`String`	`toString()` Generates a string representation of the pin.

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

- Constructor Detail
  - SitePinInst
```
public SitePinInst()
```
    Constructor setting things to null and false.
    
    Since:
    
    2018.2.0
  - SitePinInst
```
public SitePinInst(boolean isOutputPin,
                   String pinName,
                   SiteInst instance)
```
    Creates a pin from parameters
    
    Parameters:
    
    isOutputPin - Is the new pin an outpin?
    
    pinName - The name of the pin on the instance (internal name)
    
    instance - The instance where the pin resides
    
    Since:
    
    2018.2.0
  - SitePinInst
```
public SitePinInst(String pinName,
                   SiteInst instance)
```
    Determines pin direction from site instance type. Throws a RuntimeException if site instance or its type are null.
    
    Parameters:
    
    pinName - Name of the new site pin
    
    instance - The non-null site instance with a non-null site type
    
    Since:
    
    2018.2.0
  - SitePinInst
```
public SitePinInst(PinType pinType,
                   String pinName,
                   SiteInst instance)
```
    Creates a pin from parameters
    
    Parameters:
    
    pinType - Allows specification of an inout pin
    
    pinName - The name of the pin on the instance (internal name)
    
    instance - The instance where the pin resides
    
    Since:
    
    2018.2.0
- Method Detail
  - isOutPin
```
public boolean isOutPin()
```
    Returns:
    
    True if the pin is an outpin, false otherwise.
    
    Since:
    
    2018.2.0
  - getName
```
public String getName()
```
    Gets and returns the pin name of the pin.
    
    Returns:
    
    The pin name (internal instance pin name)
    
    Since:
    
    2018.2.0
  - getSiteInst
```
public SiteInst getSiteInst()
```
    Gets and returns the instance where this pin resides.
    
    Returns:
    
    The instance where the pin resides.
    
    Since:
    
    2018.2.0
  - getSiteInstName
```
public String getSiteInstName()
```
    Gets and returns the name of the instance where this pin resides.
    
    Returns:
    
    The name of the instance where this pin resides.
    
    Since:
    
    2018.2.0
  - getModuleInstName
```
public String getModuleInstName()
```
    Gets and returns the module instance name corresponding to the instance of this pin.
    
    Returns:
    
    The name of the module instance associated with this pin or null if none exist.
    
    Since:
    
    2018.2.0
  - getTile
```
public Tile getTile()
```
    Gets and returns the tile where this pin resides.
    
    Returns:
    
    The tile where this pin resides.
    
    Since:
    
    2018.2.0
  - setIsOutputPin
```
public void setIsOutputPin(boolean dir)
```
    Sets the direction of the pin.
    
    Parameters:
    
    dir - The direction (true=outpin, false=inpin)
    
    Since:
    
    2018.2.0
  - setPinName
```
public void setPinName(String name)
```
    Sets the name of the pin.
    
    Parameters:
    
    name - The new name of this pin.
    
    Since:
    
    2018.2.0
  - movePin
```
public boolean movePin(String newName)
```
    Updates the pin name to a new name within the site. This updates associated references within the site accordingly for the new pin.
    
    Parameters:
    
    newName - Name of the new pin location.
    
    Returns:
    
    True if the operation completed successfully, false otherwise.
    
    Since:
    
    2018.2.0
  - setSiteInst
```
public void setSiteInst(SiteInst instance)
```
    Sets the instance to which this pin belongs. It will unroute the net connected to this pin.
    
    Parameters:
    
    instance - The instance to which this pin belongs.
    
    Since:
    
    2018.2.0
  - setSiteInst
```
public void setSiteInst(SiteInst instance,
                        boolean keepRouting)
```
    Sets the instance to which this pin belongs. No effect if new instance is the same as the existing one, when one is set.
    
    Parameters:
    
    instance - The new desired instance to associate with the pin.
    
    keepRouting - True will keep the routing on this pin's net.
    
    Since:
    
    2018.2.4
  - isRouted
```
public boolean isRouted()
```
    Checks if a site pin flag is marked as routed
    
    Returns:
    
    True if the flag is marked as routed, false otherwise
    
    Since:
    
    2018.2.0
  - setRouted
```
public void setRouted(boolean isRouted)
```
    Sets a flag on this pin to mark it as routed
    
    Parameters:
    
    isRouted - The desired setting on this pin (true is routed, false is otherwise)
    
    Since:
    
    2018.2.0
  - detachSiteInst
```
public void detachSiteInst()
```
    Removes any reference to the site instance from this pin and removes the pin from the pin map in the site instance.
    
    Since:
    
    2018.2.0
  - setPort
```
public void setPort(Port port)
```
    Sets the module port that references this pin.
    
    Parameters:
    
    port - the port that references this pin.
    
    Since:
    
    2018.2.0
  - getPort
```
public Port getPort()
```
    Gets the module port that references this pin. Null if there is none
    
    Returns:
    
    The port that references this pin.
    
    Since:
    
    2018.2.0
  - setNet
```
public void setNet(Net net)
```
    Parameters:
    
    net - the net to set
    
    Since:
    
    2018.2.0
  - getNet
```
public Net getNet()
```
    Returns:
    
    the net
    
    Since:
    
    2018.2.0
  - getSite
```
public Site getSite()
```
    Gets the site this pin is placed on.
    
    Returns:
    
    The site where this pin resides
    
    Since:
    
    2018.2.0
  - getSitePinName
```
public String getSitePinName()
```
    Get the concatenated siteName.PinName (ex. SLICE_X1Y2.C1) name for the pin. This pin name is unique throughout the device.
    
    Returns:
    
    The site name . pin name
    
    Since:
    
    2018.2.0
  - toString
```
public String toString()
```
    Generates a string representation of the pin.
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Generates a hashCode based on the instance, direction and pinName.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Checks if obj is a pin and if equal to this pin by comparing instance, direction and pinName.
    
    Overrides:
    
    equals in class Object
  - getPinType
```
public PinType getPinType()
```
    Gets the pin's type
    
    Returns:
    
    Type of the pin
    
    Since:
    
    2018.2.0
  - setPinType
```
public void setPinType(PinType pinType)
```
    Sets the pin's type
    
    Parameters:
    
    pinType - Desired pin type
    
    Since:
    
    2018.2.0
  - isPinOnABuf
```
public boolean isPinOnABuf()
```
    Checks if the pin is on a BUF site
    
    Returns:
    
    True if the site is of any type containing "BUF", false otherwise
    
    Since:
    
    2018.2.0
  - getSiteTypeEnum
```
public SiteTypeEnum getSiteTypeEnum()
```
    Gets the site type enum for this pin's site
    
    Returns:
    
    the site type enum for this pin's site
    
    Since:
    
    2018.2.0
  - getBELPin
```
public BELPin getBELPin()
```
    Gets the corresponding BELPin for this site pin. Each Site Pin has a corresponding BEL object of BELClass PORT, see BELClass. This method retrieves the BELPin from the PORT BEL object.
    
    Returns:
    
    The corresponding element pin or null if none otherwise.
    
    Since:
    
    2018.2.0
  - isLUTInputPin
```
public boolean isLUTInputPin()
```
    Checks if this pin connects to a LUT input
    
    Returns:
    
    True if pin connects to a LUT input pin, false otherwise
    
    Since:
    
    2018.2.0
  - isLUTInputPin
```
public static boolean isLUTInputPin(SiteInst siteInst,
                                    String name)
```
    Checks a given site and pin name to see if it is a LUT input pin.
    
    Parameters:
    
    siteInst - The site inst placed on the site to query
    
    name - The pin name to query
    
    Returns:
    
    True if the named site and pin name are a LUT input, false otherwise.
    
    Since:
    
    2018.2.0
  - getConnectedWireIndex
```
public int getConnectedWireIndex()
```
    Gets the index of the tile wire connected to this site pin.
    
    Returns:
    
    the index of the tile wire connected to this site pin.
    
    Since:
    
    2018.2.0
  - getConnectedNode
```
public Node getConnectedNode()
```
    Creates a new node connected to this site pin.
    
    Returns:
    
    The node that connects to this site pin.
    
    Since:
    
    2018.2.0
  - getRouteNode
```
public RouteNode getRouteNode()
```
    Creates and returns a new route node that connects to this pin.
    
    Returns:
    
    A new route node connecting to this pin.
    
    Since:
    
    2018.2.0
  - getNumDownhillNodes
```
public int getNumDownhillNodes()
```
    Counts the number of downhill nodes from the node connected to this pin.
    
    Returns:
    
    The number of downhill nodes from the node connected to this pin.
    
    Since:
    
    2018.2.0
  - getSiteExternalWireIndex
```
public Integer getSiteExternalWireIndex()
```
    Gets the external wire on this pin.
    
    Returns:
    
    The wire index of the internal pin on the site of the pin.
    
    Since:
    
    2018.2.0
  - getNodeFromPin
```
public RouteNode getNodeFromPin()
```
    This will creating a routing node from the pin given.
    
    Returns:
    
    A new node populated with the pin's tile and wire. The parent field is null and level is zero.
    
    Since:
    
    2018.2.0
  - getNodeFromPin
```
public RouteNode getNodeFromPin(RouteNode parent,
                                int level)
```
    This will creating a routing node from the pin given.
    
    Parameters:
    
    parent - The parent node of the created route node
    
    level - The depth level of the created route node
    
    Returns:
    
    A new node populated with the pin's tile and wire. The parent field is null and level is zero.
    
    Since:
    
    2018.2.0
  - getSiteWireIndex
```
public Integer getSiteWireIndex()
```
    Gets the site wire index of the wire in the site attached to this site pin.
    
    Returns:
    
    The index of the site wire within the site or null if none exists.
    
    Since:
    
    2020.1.4
  - getSiteWireName
```
public String getSiteWireName()
```
    Gets the site wire name of the wire in the site attached to this site pin.
    
    Returns:
    
    The name of the site wire within the site or null if none exists.
    
    Since:
    
    2020.1.4
  - getSiteWireBELPins
```
public List<BELPin> getSiteWireBELPins()
```
    Gets the list of BEL pins connected to this site pin internally.
    
    Returns:
    
    The list of BEL pins for this site pin internal to the site.
    
    Since:
    
    2020.1.4

Class SitePinInst

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

SitePinInst

SitePinInst

SitePinInst

SitePinInst

Method Detail

isOutPin

getName

getSiteInst

getSiteInstName

getModuleInstName

getTile

setIsOutputPin

setPinName

movePin

setSiteInst

setSiteInst

isRouted

setRouted

detachSiteInst

setPort

getPort

setNet

getNet

getSite

getSitePinName

toString

hashCode

equals

getPinType

setPinType

isPinOnABuf

getSiteTypeEnum

getBELPin

isLUTInputPin

isLUTInputPin

getConnectedWireIndex

getConnectedNode

getRouteNode

getNumDownhillNodes

getSiteExternalWireIndex

getNodeFromPin

getNodeFromPin

getSiteWireIndex

getSiteWireName

getSiteWireBELPins