RouteNode

Object
- com.xilinx.rapidwright.router.RouteNode

All Implemented Interfaces:

Comparable<RouteNode>
```
public class RouteNode
extends Object
implements Comparable<RouteNode>
```
This class represents the basic routing element, a node or wire. A node is described as a wire with a particular name in a particular tile. When routing, it keeps track of the source node by setting the parent variable.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cost` This is the routing cost of using this node in the current route
`int`	`history` This is the combined cost of a node when it is used, and used multiple times
`int`	`level` This is the number of hops from the original source of the route this node is
`RouteNode`	`parent` This is the pointer to a parent node in the route it is a part of
`Tile`	`tile` This is the tile where the node/wire resides
`int`	`wire` This is the enumerated int that represents the name of the wire specified

Constructor Summary

Constructors
Constructor and Description
`RouteNode()` Empty constructor, sets tile and wires to null.
`RouteNode(Node n)`
`RouteNode(SitePinInst p)`
`RouteNode(String nodeName, Device dev)` Convenience constructor that takes the Node name `"<Tile>/<Wire>"` and creates the node.
`RouteNode(Tile tile, int wire)` A quick population constructor, parent is set to null, and the level is 0.
`RouteNode(Tile tile, int wire, RouteNode parent, int level)` A quick population constructor.
`RouteNode(Wire wire, RouteNode parent)` Constructor common for routing expansion

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(RouteNode node)` The priority queue will use strictly the cost to evaluate priority
`RouteNode`	`createNode(Wire w)`
`RouteNode`	`createNode(Wire w, RouteNode parent)`
`static PriorityQueue<RouteNode>`	`createPriorityQueue()` Creates a new priority queue that sorts route nodes based on their lowest cost (see `RouteNode.getCost()`).
`boolean`	`equals(Object obj)`
`ArrayList<Wire>`	`getBackwardConnections()`
`List<PIP>`	`getBackwardPIPs()`
`RouteNode`	`getBaseWire()`
`List<Wire>`	`getConnections()` Gets all the possible connections to leaving this node
`int`	`getCost()` Returns the current cost of this node
`RouteNode`	`getEndNode(PIP p)` Creates a new node representing the end wire of this PIP
`List<PIP>`	`getForwardPIPs()`
`int`	`getHistory()`
`IntentCode`	`getIntentCode()`
`int`	`getLevel()`
`int`	`getManhattanDistance(RouteNode snk)`
`String`	`getName()`
`RouteNode`	`getParent()`
`ArrayList<PIP>`	`getPIPsBackToSource()`
`ArrayList<PIP>`	`getPIPsForwardToSink()`
`RouteNode`	`getStartNode(PIP p)` Creates a new node representing the start wire of this PIP
`Tile`	`getTile()`
`int`	`getWire()`
`List<Wire>`	`getWireConnections()`
`int`	`getWireIndex(String wireName)`
`String`	`getWireName()`
`Wire[]`	`getWiresInNode()`
`int`	`hashCode()`
`boolean`	`matches(String tileName, String wireName)` Quick check to see if the tile/wire combination match this node.
`void`	`setCost(int cost)`
`void`	`setHistory(int history)`
`void`	`setLevel(int level)`
`void`	`setParent(RouteNode parent)`
`void`	`setTile(Tile tile)`
`void`	`setTileAndWire(Tile tile, int wire)` A quick setter method for the tile and wire.
`void`	`setTileAndWire(Wire wire)`
`void`	`setWire(int wire)`
`String`	`toString()`

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

- Field Detail
  - tile
```
public Tile tile
```
    This is the tile where the node/wire resides
  - wire
```
public int wire
```
    This is the enumerated int that represents the name of the wire specified
  - cost
```
public int cost
```
    This is the routing cost of using this node in the current route
  - parent
```
public RouteNode parent
```
    This is the pointer to a parent node in the route it is a part of
  - level
```
public int level
```
    This is the number of hops from the original source of the route this node is
  - history
```
public int history
```
    This is the combined cost of a node when it is used, and used multiple times
- Constructor Detail
  - RouteNode
```
public RouteNode()
```
    Empty constructor, sets tile and wires to null. Sets wire and cost to -1. level and history are set to 0 and isPIP is set to false.
  - RouteNode
```
public RouteNode(Tile tile,
                 int wire)
```
    A quick population constructor, parent is set to null, and the level is 0.
    
    Parameters:
    
    tile - The tile of the new node.
    
    wire - The wire of the new node.
  - RouteNode
```
public RouteNode(Wire wire,
                 RouteNode parent)
```
    Constructor common for routing expansion
    
    Parameters:
    
    wire - Wire object to construct route node from
    
    parent - The parent of the wire in the expanion search
  - RouteNode
```
public RouteNode(Tile tile,
                 int wire,
                 RouteNode parent,
                 int level)
```
    A quick population constructor.
    
    Parameters:
    
    tile - The tile of the new node.
    
    wire - The wire of the new node.
    
    parent - The parent of the new node, or null if none.
    
    level - The number of nodes between this node and the source node.
  - RouteNode
```
public RouteNode(SitePinInst p)
```
  - RouteNode
```
public RouteNode(Node n)
```
  - RouteNode
```
public RouteNode(String nodeName,
                 Device dev)
```
    Convenience constructor that takes the Node name "<Tile>/<Wire>" and creates the node.
    
    Parameters:
    
    nodeName - Name of the node
    
    dev - Device to which the node belongs
- Method Detail
  - setTileAndWire
```
public void setTileAndWire(Tile tile,
                           int wire)
```
    A quick setter method for the tile and wire.
    
    Parameters:
    
    tile - The new tile of the node.
    
    wire - The new wire of the node.
  - setTileAndWire
```
public void setTileAndWire(Wire wire)
```
  - getConnections
```
public List<Wire> getConnections()
```
    Gets all the possible connections to leaving this node
    
    Returns:
    
    The list of all possible connections leaving this node
  - getCost
```
public int getCost()
```
    Returns the current cost of this node
    
    Returns:
    
    The cost of this node
  - getLevel
```
public int getLevel()
```
    Returns:
    
    the number of hops from the source this node is
  - setLevel
```
public void setLevel(int level)
```
    Parameters:
    
    level - the number of hops from the source to this node
  - getTile
```
public Tile getTile()
```
    Returns:
    
    the tile
  - setTile
```
public void setTile(Tile tile)
```
    Parameters:
    
    tile - the tile to set
  - setCost
```
public void setCost(int cost)
```
  - getParent
```
public RouteNode getParent()
```
    Returns:
    
    the parent
  - setParent
```
public void setParent(RouteNode parent)
```
    Parameters:
    
    parent - the parent to set
  - getWire
```
public int getWire()
```
    Returns:
    
    the wire
  - setWire
```
public void setWire(int wire)
```
    Parameters:
    
    wire - the wire to set
  - getHistory
```
public int getHistory()
```
    Returns:
    
    the history
  - setHistory
```
public void setHistory(int history)
```
    Parameters:
    
    history - the history to set
  - getManhattanDistance
```
public int getManhattanDistance(RouteNode snk)
```
  - compareTo
```
public int compareTo(RouteNode node)
```
    The priority queue will use strictly the cost to evaluate priority
    
    Specified by:
    
    compareTo in interface Comparable<RouteNode>
  - matches
```
public boolean matches(String tileName,
                       String wireName)
```
    Quick check to see if the tile/wire combination match this node.
  - 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
  - getName
```
public String getName()
```
  - getWireName
```
public String getWireName()
```
  - getWireIndex
```
public int getWireIndex(String wireName)
```
  - getWireConnections
```
public List<Wire> getWireConnections()
```
  - getBackwardPIPs
```
public List<PIP> getBackwardPIPs()
```
  - getForwardPIPs
```
public List<PIP> getForwardPIPs()
```
  - getIntentCode
```
public IntentCode getIntentCode()
```
  - getBackwardConnections
```
public ArrayList<Wire> getBackwardConnections()
```
    Returns:
  - getBaseWire
```
public RouteNode getBaseWire()
```
  - getPIPsForwardToSink
```
public ArrayList<PIP> getPIPsForwardToSink()
```
  - getPIPsBackToSource
```
public ArrayList<PIP> getPIPsBackToSource()
```
  - getWiresInNode
```
public Wire[] getWiresInNode()
```
  - getStartNode
```
public RouteNode getStartNode(PIP p)
```
    Creates a new node representing the start wire of this PIP
    
    Returns:
  - getEndNode
```
public RouteNode getEndNode(PIP p)
```
    Creates a new node representing the end wire of this PIP
    
    Returns:
  - createNode
```
public RouteNode createNode(Wire w)
```
  - createNode
```
public RouteNode createNode(Wire w,
                            RouteNode parent)
```
  - createPriorityQueue
```
public static PriorityQueue<RouteNode> createPriorityQueue()
```
    Creates a new priority queue that sorts route nodes based on their lowest cost (see RouteNode.getCost()).
    
    Returns:
    
    The newly created priority queue.

Class RouteNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

tile

wire

cost

parent

level

history

Constructor Detail

RouteNode

RouteNode

RouteNode

RouteNode

RouteNode

RouteNode

RouteNode

Method Detail

setTileAndWire

setTileAndWire

getConnections

getCost

getLevel

setLevel

getTile

setTile

setCost

getParent

setParent

getWire

setWire

getHistory

setHistory

getManhattanDistance

compareTo

matches

hashCode

equals

toString

getName

getWireName

getWireIndex

getWireConnections

getBackwardPIPs

getForwardPIPs

getIntentCode

getBackwardConnections

getBaseWire

getPIPsForwardToSink

getPIPsBackToSource

getWiresInNode

getStartNode

getEndNode

createNode

createNode

createPriorityQueue