com.xilinx.rapidwright.device

Class Wire

Object

com.xilinx.rapidwright.device.Wire

All Implemented Interfaces:

WireInterface, Serializable

public class Wire
extends Object
implements WireInterface, Serializable

This class represents the device object called a wire in Vivado. It is uniquely identified in a device by the tile it belongs to and the specific wire within the tile, referred to by both a name and index that is unique to the tile type. Wire objects are dynamically created as when the device object is loaded, no wire objects are instantiated. Created on: Oct 8, 2015

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Wire(Device dev, String wire) Creates an instance of a wire -- on device load, no wire objects exist.
Wire(Device dev, String tileName, String wireName) Creates an instance of a wire -- on device load, no wire objects exist.
Wire(Tile tile, int wire) Creates an instance of a wire.
Wire(Tile tile, String wireName) Creates an instance of a wire -- on device load, no wire objects exist.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	equals(WireInterface w) Checks equality (based on tile and wire values) between this Wire and another WireInterface
ArrayList<PIP>	getBackwardPIPs() Helper method to get corresponding PIPs that drive this wire.
ArrayList<PIP>	getForwardPIPs() Helper method to get corresponding PIPs driven by this wire
IntentCode	getIntentCode() Gets the intent code associated with this wire.
Node	getNode() Creates the corresponding node to which this wire belongs.
PIPType	getPIPType() If this Wire was created from a PIP, it gets the PIP type from which it was created.
SitePin	getSitePin() Gets the associated site pin with this wire and/or node.
Wire	getStartWire() Will examine the node this wire belongs to and returns the wire that corresponds to the head or start of the node.
Tile	getTile() Get the tile of this wire.
int	getWireIndex() Gets the wire index of the wire in its tile type.
int	hashCode() Produces a hash code based on the tile and wire of the object.
boolean	isConnected() Checks if this wire is connected to a site pin or a PIP.
boolean	isEndPIPWire() Checks if this wire was created from a PIP connection and that it is the end segment of the PIP.
boolean	isRouteThru() Checks if this wire was created from a PIP and participates in a routethru.
boolean	isTied() Checks if this wire is tied to GND or VCC in the tile.
boolean	isTiedToGND() Checks if this wire is tied to GND in the tile.
boolean	isTiedToVCC() Checks if this wire is tied to VCC in the tile.
boolean	matches(String tileName, String wireName) Checks if the given tile and wire names match this Wire object.
void	setTile(Tile tile) Updates the tile for this wire
void	setWire(int wire) Updates the wire index for this wire
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

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

getTileName, getWireName

Constructor Detail

Wire

public Wire(Tile tile,
            int wire)

Creates an instance of a wire.

Parameters:

tile - The tile where the wire resides.

wire - The wire index within the tile type of the tile.

Since:

2018.2.0

Wire

public Wire(Tile tile,
            String wireName)

Creates an instance of a wire -- on device load, no wire objects exist.

Parameters:

tile - The tile where the wire resides.

wireName - The wire name within the tile type of the tile.

Since:

2018.2.0

Wire

public Wire(Device dev,
            String tileName,
            String wireName)

Creates an instance of a wire -- on device load, no wire objects exist.

Parameters:

dev - The device to which the wire belongs.

tileName - The name of the tile.

wireName - The name of the wire within the tile.

Since:

2018.2.0

Wire

public Wire(Device dev,
            String wire)

Creates an instance of a wire -- on device load, no wire objects exist.

Parameters:

dev - The device to which the wire belongs.

wire - The name of the wire ("Tile Name/Wire Name")

Since:

2018.2.0

Method Detail

getTile

public Tile getTile()

Get the tile of this wire. get_tiles -of $this

Vivado Tcl:

get_tiles -of $this

Specified by:

getTile in interface WireInterface

Returns:

the tile

Since:

2018.2.0

getWireIndex

public int getWireIndex()

Gets the wire index of the wire in its tile type.

Vivado Tcl:

get_property ID_IN_TILE_TYPE $this

Specified by:

getWireIndex in interface WireInterface

Returns:

the unique wire index in the tile type

Since:

2018.2.0

getPIPType

public PIPType getPIPType()

If this Wire was created from a PIP, it gets the PIP type from which it was created.

Returns:

Its parent PIP type, or PIPType.NONE if not a PIP or wasn't created from a PIP.

Since:

2018.2.0

isEndPIPWire

public boolean isEndPIPWire()

Checks if this wire was created from a PIP connection and that it is the end segment of the PIP.

Returns:

True if this wire exists as part of the end segment of a PIP, false otherwise.

Since:

2018.2.0

setTile

public void setTile(Tile tile)

Updates the tile for this wire

Parameters:

tile - The new tile

Since:

2018.2.0

setWire

public void setWire(int wire)

Updates the wire index for this wire

Parameters:

wire - The new wire index

Since:

2018.2.0

isRouteThru

public boolean isRouteThru()

Checks if this wire was created from a PIP and participates in a routethru.

Returns:

True if derived from a PIP and uphill wire forms a routethru with this wire, false otherwise.

Since:

2018.2.0

toString

public String toString()

Overrides:

toString in class Object

getIntentCode

public IntentCode getIntentCode()

Gets the intent code associated with this wire.

Vivado Tcl:

get_property INTENT_CODE $this

Specified by:

getIntentCode in interface WireInterface

Returns:

The intent code assigned to this wire.

Since:

2018.2.0

getStartWire

public Wire getStartWire()

Will examine the node this wire belongs to and returns the wire that corresponds to the head or start of the node. Note, if the head is passed, this same object is returned.

Vivado Tcl:

lindex [get_wires -of [get_nodes -of $this]] 0

Returns:

The start wire of the node to which this wire belongs, or it returns this wire if it does not belong to a node.

Since:

2018.2.0

getBackwardPIPs

public ArrayList<PIP> getBackwardPIPs()

Helper method to get corresponding PIPs that drive this wire.

Returns:

List of PIPs that drive this wire.

Since:

2018.2.4

getForwardPIPs

public ArrayList<PIP> getForwardPIPs()

Helper method to get corresponding PIPs driven by this wire

Returns:

List of PIPs driven by this wire

Since:

2018.2.4

matches

public boolean matches(String tileName,
                       String wireName)

Checks if the given tile and wire names match this Wire object.

Parameters:

tileName - Name of the tile to match

wireName - Name of the wire to match

Returns:

True if both tile and wire name match this Wire, false otherwise.

Since:

2018.2.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 Wire 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(Object obj)

Overrides:

equals in class Object

getSitePin

public SitePin getSitePin()

Gets the associated site pin with this wire and/or node.

Vivado Tcl:

get_site_pins -of [get_nodes -of [$this]]

Specified by:

getSitePin in interface WireInterface

Returns:

The site pin connected to this wire (or node), null if none exist.

Since:

2018.2.0

getNode

public Node getNode()

Creates the corresponding node to which this wire belongs.

Returns:

A newly created node object.

Since:

2018.3.0

isConnected

public boolean isConnected()

Checks if this wire is connected to a site pin or a PIP.

Returns:

True if this wire connects ot a site pin or PIP in the tile, false otherwise.

Since:

2024.1.0

isTiedToVCC

public boolean isTiedToVCC()

Checks if this wire is tied to VCC in the tile.

Returns:

True if this wire is tied to VCC, false otherwise.

Since:

2024.1.0

isTiedToGND

public boolean isTiedToGND()

Checks if this wire is tied to GND in the tile.

Returns:

True if this wire is tied to GND, false otherwise.

Since:

2024.1.0

isTied

public boolean isTied()

Checks if this wire is tied to GND or VCC in the tile.

Returns:

True if this wire is tied to GND or VCC, false otherwise.

Since:

2024.1.0