PartitionPin

Object
- com.xilinx.rapidwright.design.PartitionPin

```
public class PartitionPin
extends Object
```
Represents a routing interface point that can be attached to a logical port or pin of a cell. A partition pin is mapped to a specific node (described by its base wire) in the fabric.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`IS_FIXED_INDEX`
`static int`	`IS_FIXED_MASK`
`static int`	`IS_WIRE_FIXED_INDEX`
`static int`	`IS_WIRE_FIXED_MASK`
`static int`	`WIRE_MASK`
`static int`	`WIRE_WIDTH`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getInstanceName()` Gets the instance name upon which this partition pin resides
`String`	`getLibCellName()` Gets the library cell name of the pin
`Node`	`getNode()` Gets the node assigned to this partition pin
`String`	`getTerminalName()` Gets the name of the port or pin
`Tile`	`getTile()` Gets the tile of the wire/node associated with this partition pin
`String`	`getTileName()` Gets the tile name of the wire/node associated with this partition pin
`int`	`getWireIndex()` Gets the wire index assigned to this partition pin
`String`	`getWireName()` Gets the wire name assigned to this partition pin.
`boolean`	`isFixed()` Checks if this partition pin is fixed to a specific tile
`boolean`	`isPort()` Checks if this partition pin belongs to a top port on the design
`boolean`	`isWireFixed()` Checks if this partition pin is fixed to a specific wire
`void`	`setIsFixed(boolean isFixed)` Sets the partition pin as fixed within a tile
`void`	`setIsWireFixed(boolean isWireFixed)` Sets the partition pin as fixed to a specific wire in a tile
`void`	`setNode(Node node)` Sets this partition pin to a specific node
`String`	`toString()` Gets a string representation of this partition pin

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

- Field Detail
  - IS_FIXED_INDEX
```
public static final int IS_FIXED_INDEX
```
    See Also:
    
    Constant Field Values
  - IS_FIXED_MASK
```
public static final int IS_FIXED_MASK
```
    See Also:
    
    Constant Field Values
  - IS_WIRE_FIXED_INDEX
```
public static final int IS_WIRE_FIXED_INDEX
```
    See Also:
    
    Constant Field Values
  - IS_WIRE_FIXED_MASK
```
public static final int IS_WIRE_FIXED_MASK
```
    See Also:
    
    Constant Field Values
  - WIRE_WIDTH
```
public static final int WIRE_WIDTH
```
    See Also:
    
    Constant Field Values
  - WIRE_MASK
```
public static final int WIRE_MASK
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getTile
```
public Tile getTile()
```
    Gets the tile of the wire/node associated with this partition pin
    
    Returns:
    
    the tile
    
    Since:
    
    2022.1.3
  - getTileName
```
public String getTileName()
```
    Gets the tile name of the wire/node associated with this partition pin
    
    Returns:
    
    The name of the assigned tile
    
    Since:
    
    2022.1.3
  - setNode
```
public void setNode(Node node)
```
    Sets this partition pin to a specific node
    
    Parameters:
    
    node - The node to attach to this partition pin
    
    Since:
    
    2022.1.3
  - getNode
```
public Node getNode()
```
    Gets the node assigned to this partition pin
    
    Returns:
    
    The node based on the tile and wire assigned, or null if no node exists
    
    Since:
    
    2022.1.3
  - getWireIndex
```
public int getWireIndex()
```
    Gets the wire index assigned to this partition pin
    
    Returns:
    
    The wire index within the tile
    
    Since:
    
    2022.1.3
  - getWireName
```
public String getWireName()
```
    Gets the wire name assigned to this partition pin.
    
    Returns:
    
    The wire name or null if none is assigned
    
    Since:
    
    2022.1.3
  - setIsFixed
```
public void setIsFixed(boolean isFixed)
```
    Sets the partition pin as fixed within a tile
    
    Parameters:
    
    isFixed - True to fix pin, false to unfix
    
    Since:
    
    2022.1.3
  - setIsWireFixed
```
public void setIsWireFixed(boolean isWireFixed)
```
    Sets the partition pin as fixed to a specific wire in a tile
    
    Parameters:
    
    isWireFixed - True to fix pin to the specific wire
    
    Since:
    
    2022.1.3
  - isFixed
```
public boolean isFixed()
```
    Checks if this partition pin is fixed to a specific tile
    
    Returns:
    
    True if fixed, false otherwise
    
    Since:
    
    2022.1.3
  - isWireFixed
```
public boolean isWireFixed()
```
    Checks if this partition pin is fixed to a specific wire
    
    Returns:
    
    True if wire is fixed, false othewise
    
    Since:
    
    2022.1.3
  - getInstanceName
```
public String getInstanceName()
```
    Gets the instance name upon which this partition pin resides
    
    Returns:
    
    Hierarchical instance name of this partition pin
    
    Since:
    
    2022.1.3
  - isPort
```
public boolean isPort()
```
    Checks if this partition pin belongs to a top port on the design
    
    Returns:
    
    True if it is a top cell port, false otherwise
    
    Since:
    
    2022.1.3
  - getTerminalName
```
public String getTerminalName()
```
    Gets the name of the port or pin
    
    Returns:
    
    the terminalName The name of the port or pin
    
    Since:
    
    2022.1.3
  - getLibCellName
```
public String getLibCellName()
```
    Gets the library cell name of the pin
    
    Returns:
    
    The cell name (or type) upon which this pin resides (null if port)
    
    Since:
    
    2022.1.3
  - toString
```
public String toString()
```
    Gets a string representation of this partition pin
    
    Overrides:
    
    toString in class Object
    
    Since:
    
    2022.1.3

Class PartitionPin

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

IS_FIXED_INDEX

IS_FIXED_MASK

IS_WIRE_FIXED_INDEX

IS_WIRE_FIXED_MASK

WIRE_WIDTH

WIRE_MASK

Method Detail

getTile

getTileName

setNode

getNode

getWireIndex

getWireName

setIsFixed

setIsWireFixed

isFixed

isWireFixed

getInstanceName

isPort

getTerminalName

getLibCellName

toString