com.xilinx.rapidwright.device

Class Node

Object

com.xilinx.rapidwright.device.Node

All Implemented Interfaces:

WireInterface

Direct Known Subclasses:

RouteNode

public class Node
extends Object
implements WireInterface

This class represents a reference to the notion of a node in Vivado, which is an electrically connected set of Wires that can span tiles. As nodes are a collection of wires, their reference point is a base wire. Created on: Jul 5, 2016

Field Summary

Fields

Modifier and Type	Field and Description
static int	DELAY_ARC
static int	GAP_ARC
static int	LOGICAL_DRIVER_ARC
static int	NULL_ARC
static int	NULL_TILE_ID
static HashMap<Pair<Integer,Integer>,Integer>	offsets
static int	SPECIAL_INVERTING_ARC
static int	STUB_ARC

Constructor Summary

Constructors

Constructor and Description
Node(Node node) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Node obj)
boolean	equals(Object obj)
boolean	equals(WireInterface w) Checks equality (based on tile and wire values) between this node and another WireInterface
List<Node>	getAllDownhillNodes() Creates a list of all downhill (can be driven by this node) nodes.
Collection<Node>	getAllDownhillNodes(Collection<Node> nodes) Creates a list of all downhill (can be driven by this node) nodes.
List<PIP>	getAllDownhillPIPs() Creates a list of all downhill PIPs (PIPs that are driven by this node) from this node.
List<Node>	getAllUphillNodes() Creates a list of all uphill (can drive this node) nodes.
Collection<Node>	getAllUphillNodes(Collection<Node> nodes) Creates a list of all uphill (can drive this node) nodes.
List<PIP>	getAllUphillPIPs() Creates a list of all uphill PIPs (PIPs that drive this node) from this node.
Wire[]	getAllWiresInNode() Creates and array of wire objects that make up this node.
IntentCode	getIntentCode() Gets the IntentCode of this node using the base wire as the lookup.
static Node	getNode(RouteNode routeNode) Getter that builds a node from a RouteNode
static Node	getNode(String nodeName, Device dev) Getter that creates a node from the name of a wire or node as displayed in Vivado (ex: INT_X0Y0/LOGIC_OUTS_R20)
static Node	getNode(Tile tile, int wire) Constructor that creates a node from a specific tile and wire.
static Node	getNode(Tile tile, String wireName) Getter that creates a node from a specific tile and wire.
static Node	getNode(Wire wire) Getter that creates a node from a specific wire.
SitePin	getSitePin() Gets the site pin connected to this node.
Tile	getTile() Gets the tile of the base wire of this node.
int	getWireIndex() Gets the wire index of the base wire of this node.
static Wire[]	getWiresInNode(Tile tile, int wire) Creates an array of wires that correspond to the node of the provided wire reference.
int	hashCode() Produces a hash code based on the tile and wire of the object.
boolean	hasIntentCode(IntentCode intentCode) Checks the IntentCode of this node using the base wire as the lookup.
boolean	isInvalidNode() Checks if a node created with the constructor is invalid.
boolean	isTied() Checks if the node is tied to a static source (GND/VCC).
boolean	isTiedToGnd() Checks if the node is tied to a static '0' or GND.
boolean	isTiedToVcc() Checks if the node is tied to a static '1' or VCC.
String	toString() Gets the Vivado string representation of the node

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xilinx.rapidwright.device.WireInterface

getTileName, getWireName

Field Detail

NULL_TILE_ID

public static final int NULL_TILE_ID

See Also:

Constant Field Values

NULL_ARC

public static final int NULL_ARC

See Also:

Constant Field Values

GAP_ARC

public static final int GAP_ARC

See Also:

Constant Field Values

LOGICAL_DRIVER_ARC

public static final int LOGICAL_DRIVER_ARC

See Also:

Constant Field Values

DELAY_ARC

public static final int DELAY_ARC

See Also:

Constant Field Values

STUB_ARC

public static final int STUB_ARC

See Also:

Constant Field Values

SPECIAL_INVERTING_ARC

public static final int SPECIAL_INVERTING_ARC

See Also:

Constant Field Values

offsets

public static HashMap<Pair<Integer,Integer>,Integer> offsets

Constructor Detail

Node

public Node(Node node)

Copy constructor.

Parameters:

node - Node to copy from

Since:

2023.2.1

Method Detail

getNode

public static Node getNode(Tile tile,
                           int wire)

Constructor that creates a node from a specific tile and wire. The node will identify the base wire for the node and store that reference.

Parameters:

tile - The tile containing the wire of interest.

wire - The specific wire in the referenced tile.

Returns:

The corresponding node or null if it could not be determined

Since:

2020.1.6

getNode

public static Node getNode(Tile tile,
                           String wireName)

Getter that creates a node from a specific tile and wire. The node will identify the base wire for the node and store that reference.

Parameters:

tile - The tile containing the wire of interest.

wireName - The specific wire name in the referenced tile.

Returns:

The corresponding node, or null if it could not be determined

Vivado Tcl:

get_nodes -of [get_wires "$tile/$wireName"]

Since:

2020.1.6

getNode

public static Node getNode(Wire wire)

Getter that creates a node from a specific wire. The node will identify the base wire for the node and store that reference.

Parameters:

w - A wire that belongs to the node to be created.

Returns:

The corresponding node to the provided wire or null if it could not be determined

Vivado Tcl:

get_nodes -of [get_wire $w]

Since:

2020.1.6

getNode

public static Node getNode(String nodeName,
                           Device dev)

Getter that creates a node from the name of a wire or node as displayed in Vivado (ex: INT_X0Y0/LOGIC_OUTS_R20)

Parameters:

nodeName - Name of the node (/).

dev - The device from which to find the node object.

Returns:

The named node or equivalent node based on wire name, or null if it could not be determined.

Since:

2020.1.6

getNode

public static Node getNode(RouteNode routeNode)

Getter that builds a node from a RouteNode

Parameters:

routeNode - The route node to use to create the node

Returns:

The corresponding node of this provide route node, or null if it could not be determined.

Since:

2020.1.6

isInvalidNode

public boolean isInvalidNode()

Checks if a node created with the constructor is invalid. This is to help manage transition away from public Node class constructors.

Returns:

True if this node is invalid, false otherwise.

Since:

2020.1.6

getTile

public Tile getTile()

Gets the tile of the base wire of this node.

Vivado Tcl:

lindex [get_tiles -of $this] 0

Specified by:

getTile in interface WireInterface

Returns:

the tile

Since:

2018.2.0

getWireIndex

public int getWireIndex()

Gets the wire index of the base wire of this node.

Vivado Tcl:

get_property ID_IN_TILE_TYPE [lindex [get_wires -of $this] 0]

Specified by:

getWireIndex in interface WireInterface

Returns:

the wire index

Since:

2023.2.1

getAllWiresInNode

public Wire[] getAllWiresInNode()

Creates and array of wire objects that make up this node.

Vivado Tcl:

get_wires -of $this

Returns:

An array of Wires that belong to this node

Since:

2018.2.0

getWiresInNode

public static Wire[] getWiresInNode(Tile tile,
                                    int wire)

Creates an array of wires that correspond to the node of the provided wire reference.

Vivado Tcl:

get_wires -of [get_nodes -of [get_wires -of [get_tiles $tile] -filter ID_IN_TILE_TYPE==$wire]]

Parameters:

tile - Tile of the reference wire to get

wire - The wire of the reference tile to get

Returns:

A list of wires that combine to make the node. It will include the referenced wire provided as input.

Since:

2018.2.0

getAllDownhillNodes

public List<Node> getAllDownhillNodes()

Creates a list of all downhill (can be driven by this node) nodes.

Vivado Tcl:

get_nodes -downhill -of $this

Returns:

The list of all downhill nodes from this node.

Since:

2018.2.0

getAllDownhillNodes

public Collection<Node> getAllDownhillNodes(Collection<Node> nodes)

Creates a list of all downhill (can be driven by this node) nodes.

Vivado Tcl:

get_nodes -downhill -of $this

Parameters:

nodes - The collection to populate with downhill nodes. This overload of Node.getAllDownhillNodes() is a work around so that callers can pass in a set if they are sensitive to duplicate entries that occur in rare cases.

Returns:

The same nodes collection passed as a parameter now containing all downhill nodes.

Since:

2022.1.4

getAllUphillNodes

public List<Node> getAllUphillNodes()

Creates a list of all uphill (can drive this node) nodes.

Vivado Tcl:

get_nodes -uphill -of $this

Returns:

The list of all uphill nodes from this node.

Since:

2020.1.0

getAllUphillNodes

public Collection<Node> getAllUphillNodes(Collection<Node> nodes)

Creates a list of all uphill (can drive this node) nodes.

Vivado Tcl:

get_nodes -uphill -of $this

Parameters:

nodes - The collection to populate with uphill nodes. This overload of Node.getAllDownhillNodes() is a work around so that callers can pass in a set if they are sensitive to duplicate entries that occur in rare cases.

Returns:

The same nodes collection passed as a parameter now containing all uphill nodes.

Since:

2022.1.4

getAllDownhillPIPs

public List<PIP> getAllDownhillPIPs()

Creates a list of all downhill PIPs (PIPs that are driven by this node) from this node.

Vivado Tcl:

get_pips -downhill -of $this

Returns:

The list of all downhill PIPs for this node.

Since:

2018.2.0

getAllUphillPIPs

public List<PIP> getAllUphillPIPs()

Creates a list of all uphill PIPs (PIPs that drive this node) from this node.

Vivado Tcl:

get_pips -uphill -of $this

Returns:

The list of all uphill PIPs for this node.

Since:

2020.1.0

getSitePin

public SitePin getSitePin()

Gets the site pin connected to this node.

Vivado Tcl:

get_site_pins -of $this

Specified by:

getSitePin in interface WireInterface

Returns:

The site pin connected to this node, or null if there is none.

Since:

2018.2.0

toString

public String toString()

Gets the Vivado string representation of the node

Overrides:

toString in class Object

isTiedToGnd

public boolean isTiedToGnd()

Checks if the node is tied to a static '0' or GND.

Returns:

True if the node is statically tied to GND ('0').

Since:

2019.1.0

isTiedToVcc

public boolean isTiedToVcc()

Checks if the node is tied to a static '1' or VCC.

Returns:

True if the node is statically tied to VCC ('1').

Since:

2019.1.0

isTied

public boolean isTied()

Checks if the node is tied to a static source (GND/VCC).

Returns:

True if the node is statically tied to GND/VCC.

Since:

2019.1.0

hashCode

public int hashCode()

Description copied from interface: WireInterface

Produces a hash code based on the tile and wire of the object.

Specified by:

hashCode in interface WireInterface

Overrides:

hashCode in class Object

Returns:

A hash code derived from the tile and wire.

equals

public boolean equals(WireInterface w)

Checks equality (based on tile and wire values) between this node and another WireInterface

Specified by:

equals in interface WireInterface

Parameters:

w - The other WireInterface object to check against for equality.

Returns:

True if the two objects have the same (base) tile and wire index, false otherwise.

Since:

2023.2.1

equals

public boolean equals(Node obj)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getIntentCode

public IntentCode getIntentCode()

Gets the IntentCode of this node using the base wire as the lookup.

Specified by:

getIntentCode in interface WireInterface

Returns:

The IntentCode of this node, or null if none could be found.

Since:

2020.1.6

hasIntentCode

public boolean hasIntentCode(IntentCode intentCode)

Checks the IntentCode of this node using the base wire as the lookup.

Returns:

True if this node has the

Since:

2020.1.6