com.xilinx.rapidwright.device

Interface WireInterface

All Known Implementing Classes:

NetTools.NodeTree, Node, RouteNode, RouterHelper.NodeWithPrev, VersalClockRouting.NodeWithPrevAndCost, Wire

public interface WireInterface

An interface to enable methods to operate on the common methods of a Wire object as well as a Node object. At their heart, they both specify a Tile and a wire (in the case of a Node it is the base wire).

Since:

2023.2.1

Method Summary

Modifier and Type	Method and Description
boolean	equals(WireInterface w) Checks equality (based on tile and wire values) between this and another WireInterface
IntentCode	getIntentCode() Gets the intent code corresponding to this wire/base wire.
SitePin	getSitePin() Gets the corresponding site pin (if any) to this wire/base wire.
Tile	getTile() Gets the tile corresponding to this wire/base wire.
default String	getTileName() Gets the tile name corresponding to this wire/base wire.
int	getWireIndex() Gets the wire index corresponding to this wire/base wire.
default String	getWireName() Gets the wire name corresponding to this wire/base wire.
int	hashCode() Produces a hash code based on the tile and wire of the object.

Method Detail

getTile

Tile getTile()

Gets the tile corresponding to this wire/base wire.

Returns:

The tile of this wire/base wire.

Since:

2023.2.1

getTileName

default String getTileName()

Gets the tile name corresponding to this wire/base wire.

Returns:

The tile name of this wire/base wire.

Since:

2023.2.1

getWireIndex

int getWireIndex()

Gets the wire index corresponding to this wire/base wire.

Returns:

The wire index of this wire/base wire.

Since:

2023.2.1

getWireName

default String getWireName()

Gets the wire name corresponding to this wire/base wire.

Returns:

The wire name of this wire/base wire.

Since:

2023.2.1

getIntentCode

IntentCode getIntentCode()

Gets the intent code corresponding to this wire/base wire.

Returns:

The intent code of this wire/base wire.

Since:

2023.2.1

getSitePin

SitePin getSitePin()

Gets the corresponding site pin (if any) to this wire/base wire.

Returns:

The site pin connected to this wire/base wire, or null if not present.

Since:

2023.2.1

hashCode

int hashCode()

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

Overrides:

hashCode in class Object

Returns:

A hash code derived from the tile and wire.

Since:

2023.2.1

equals

boolean equals(WireInterface w)

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

Parameters:

w - The other object to check against for equality.

Returns:

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

Since:

2023.2.1