com.xilinx.rapidwright.timing

Class TimingEdge

Object

org.jgrapht.graph.DefaultEdge

com.xilinx.rapidwright.timing.TimingEdge

All Implemented Interfaces:

Serializable, Cloneable

public class TimingEdge
extends org.jgrapht.graph.DefaultEdge

Edges within a TimingGraph that encapsulate logic delays, net delays, and debug information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimingEdge(TimingGraph graph, TimingVertex u, TimingVertex v)
TimingEdge(TimingGraph timingGraph, TimingVertex srcPort, TimingVertex dstPort, EDIFNet edifNet, Net net) Constructs a TimingEdge with the expected information for the TimingGraph.
TimingEdge(TimingVertex u, TimingVertex v) Constructs a TimingEdge based only on specifying two vertices.

Method Summary

Modifier and Type	Method and Description
String	delaysInfo()
boolean	equals(Object obj)
float	getDelay() Gets the total delay in ps for this edge.
TimingVertex	getDst() Gets the second vertex of this edge.
EDIFNet	getEdifNet() Gets the logical "EDIFNet" object associated with this edge, if one has been set.
SitePinInst	getFirstPin() For debug, gets the first SitePinInst for this edge.
float	getIntraSiteDelay()
float	getLogicDelay() Gets the logic-related component of the delay in ps for this edge.
Net	getNet() Gets the physical "Net" object associated with this edge.
float	getNetDelay() Gets the net-related component of the delay in ps for this edge.
SitePinInst	getSecondPin() For debug, gets the second SitePinInst for this edge.
TimingVertex	getSrc() Gets the first vertex of this edge.
int	hashCode()
void	setFirstSitePinInst(SitePinInst spi) For debug, sets the first SitePinInst for this edge.
void	setIntraSiteDelay(float intraSiteDelay)
void	setLogicDelay(float logicDelay) Sets the logic-related component of the delay in ps for this edge.
void	setNetDelay(float netDelay) Sets the net-related component of the delay in ps for this edge.
void	setRouteDelay(float routeDelay)
void	setSecondSitePinInst(SitePinInst spi) For debug, sets the second SitePinInst for this edge.
String	toGraphvizDotString() Returns a string representing the edge to help towards printing out a textual dot file for creating a GraphViz dot visualization of the graph.
String	toString() Represents this edge as a String for debug, etc.
String	toStringOnSitePinInsts()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimingEdge

public TimingEdge(TimingVertex u,
                  TimingVertex v)

Constructs a TimingEdge based only on specifying two vertices.

Parameters:

u - First vertex as a TimingVertex.

v - Second vertex as a TimingVertex.

TimingEdge

public TimingEdge(TimingGraph graph,
                  TimingVertex u,
                  TimingVertex v)

TimingEdge

public TimingEdge(TimingGraph timingGraph,
                  TimingVertex srcPort,
                  TimingVertex dstPort,
                  EDIFNet edifNet,
                  Net net)

Constructs a TimingEdge with the expected information for the TimingGraph.

Parameters:

timingGraph - TimingGraph object where this edge will belong.

srcPort - First vertex as a TimingVertex.

dstPort - Second vertex as a TimingVertex.

edifNet - Logical EDIFNet representing this edge. In some cases this is set to null.

net - Physical "Net" representing this edge.

Method Detail

setFirstSitePinInst

public void setFirstSitePinInst(SitePinInst spi)

For debug, sets the first SitePinInst for this edge.

Parameters:

spi - First SitePinInst.

setSecondSitePinInst

public void setSecondSitePinInst(SitePinInst spi)

For debug, sets the second SitePinInst for this edge.

Parameters:

spi - Second SitePinInst.

getFirstPin

public SitePinInst getFirstPin()

For debug, gets the first SitePinInst for this edge.

Returns:

First SitePinInst.

getSecondPin

public SitePinInst getSecondPin()

For debug, gets the second SitePinInst for this edge.

Returns:

Second SitePinInst.

toString

public String toString()

Represents this edge as a String for debug, etc.

Overrides:

toString in class org.jgrapht.graph.DefaultEdge

Returns:

String representing this edge.

toGraphvizDotString

public String toGraphvizDotString()

Returns a string representing the edge to help towards printing out a textual dot file for creating a GraphViz dot visualization of the graph.

Returns:

A string representing this edge for creating a GraphViz dot file

getLogicDelay

public float getLogicDelay()

Gets the logic-related component of the delay in ps for this edge.

Returns:

Logic delay in picoseconds.

getNetDelay

public float getNetDelay()

Gets the net-related component of the delay in ps for this edge.

Returns:

Net delay in picoseconds.

getDelay

public float getDelay()

Gets the total delay in ps for this edge. The total delay is currently the sum of logic delay and net delay components.

Returns:

Total delay in picoseconds.

getIntraSiteDelay

public float getIntraSiteDelay()

setIntraSiteDelay

public void setIntraSiteDelay(float intraSiteDelay)

toStringOnSitePinInsts

public String toStringOnSitePinInsts()

delaysInfo

public String delaysInfo()

setRouteDelay

public void setRouteDelay(float routeDelay)

setNetDelay

public void setNetDelay(float netDelay)

Sets the net-related component of the delay in ps for this edge.

Parameters:

netDelay - Net delay in picoseconds.

setLogicDelay

public void setLogicDelay(float logicDelay)

Sets the logic-related component of the delay in ps for this edge.

Parameters:

logicDelay - Logic delay in picoseconds.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSrc

public TimingVertex getSrc()

Gets the first vertex of this edge.

Returns:

First vertex of type TimingVertex.

getDst

public TimingVertex getDst()

Gets the second vertex of this edge.

Returns:

Second vertex of type TimingVertex.

getNet

public Net getNet()

Gets the physical "Net" object associated with this edge.

Returns:

Physical "Net" for this edge.

getEdifNet

public EDIFNet getEdifNet()

Gets the logical "EDIFNet" object associated with this edge, if one has been set. This returns null if the logical net was not set.

Returns:

Logical EDIFNet for this edge.