TimingGroup

Object
- com.xilinx.rapidwright.timing.TimingGroup

All Implemented Interfaces:

Comparable<TimingGroup>
```
public class TimingGroup
extends Object
implements Comparable<TimingGroup>
```
A TimingGroup is our main hardware abstraction proposed by our FPT'19 paper: a TimingGroup abstracts over a set of connected PIPs, Nodes, and pins in order to create a coarser grain unit for which we calculate the delay.

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`cost`
`int`	`d` Term "D" that is used within the delay calculation
`float`	`delay`
`int`	`dist` This is the distance of the TimingGroup corresponding to its wire length type.
`static TimingGroup[]`	`EMPTY_ARRAY` Memoized static array for use by Collection.toArray() or similar
`int`	`sameSpotCounter`

Constructor Summary

Constructors
Constructor and Description
`TimingGroup(SitePinInst startPin, TimingModel timingModel)` Constructor used for Router example to create a TimingGroup, starting at a given SitePinInst.
`TimingGroup(TimingModel timingModel)` Default constructor used by the TimingModel to create a TimingGroup.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Node n, IntentCode c)` Used for adding a node into a TimingGroup.
`void`	`add(PIP p)` Used for adding a PIP into a TimingGroup.
`int`	`compareTo(TimingGroup tg)` This object implements the comparable object interface so that TimingGroup objects may be compared.
`void`	`computeTypes()` Computes the TimingGroup GroupDelayType for this group.
`GroupDelayType`	`getDelayType()`
`TimingDirection`	`getDirection()`
`Node`	`getLastNode()` Gets the last node in the timing group
`PIP`	`getLastPIP()`
`TimingGroup[]`	`getNextTimingGroups()` Method used by the Router example to get the downhill TimingGroups from a given TimingGroup.
`Node`	`getNode(int i)` Gets the node in the timing group at the specified index
`List<Node>`	`getNodes()` Gets the list of nodes in the timing group.
`IntentCode`	`getNodeType(int i)`
`List<IntentCode>`	`getNodeTypes()`
`PIP`	`getPIP(int i)`
`List<PIP>`	`getPIPs()`
`GroupWireDirection`	`getWireDirection()`
`boolean`	`hasPinFeed()`
`boolean`	`hasPIPs()` Returns whether this TimingGroup contains any PIPs.
`boolean`	`isFinalGroup()`
`boolean`	`isInitialGroup()`
`void`	`setFinalGroup(boolean value)`
`void`	`setInitialGroup(boolean value)`
`String`	`toString()` Returns a String representation of this object that may be useful for debugging.

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

- Field Detail
  - d
```
public int d
```
    Term "D" that is used within the delay calculation
  - dist
```
public int dist
```
    This is the distance of the TimingGroup corresponding to its wire length type.
  - delay
```
public float delay
```
  - cost
```
public float cost
```
  - sameSpotCounter
```
public int sameSpotCounter
```
  - EMPTY_ARRAY
```
public static final TimingGroup[] EMPTY_ARRAY
```
    Memoized static array for use by Collection.toArray() or similar
- Constructor Detail
  - TimingGroup
```
public TimingGroup(TimingModel timingModel)
```
    Default constructor used by the TimingModel to create a TimingGroup.
    
    Parameters:
    
    timingModel - Reference to the TimingModel.
  - TimingGroup
```
public TimingGroup(SitePinInst startPin,
                   TimingModel timingModel)
```
    Constructor used for Router example to create a TimingGroup, starting at a given SitePinInst.
    
    Parameters:
    
    startPin - Starting SitePinInst for the TimingGroup.
    
    timingModel - Reference to the current TimingModel.
- Method Detail
  - getNextTimingGroups
```
public TimingGroup[] getNextTimingGroups()
```
    Method used by the Router example to get the downhill TimingGroups from a given TimingGroup. For example a user may create a TimingGroup at a given SitePinInst using that constructor, and then request the possible downhill TimingGroups using this method. The resulting array of TimingGroups can easily be filtered using the "filter" method within TimingModel.
    
    Returns:
    
    Array of downhill/adjacent TimingGroups from the current TimingGroup
  - add
```
public void add(Node n,
                IntentCode c)
```
    Used for adding a node into a TimingGroup.
    
    Parameters:
    
    n - Node to be added.
    
    c - IntentCode is the Vivado-assigned Type for the given node.
  - add
```
public void add(PIP p)
```
    Used for adding a PIP into a TimingGroup.
    
    Parameters:
    
    p - PIP to be added.
  - toString
```
public String toString()
```
    Returns a String representation of this object that may be useful for debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation.
  - computeTypes
```
public void computeTypes()
```
    Computes the TimingGroup GroupDelayType for this group.
  - compareTo
```
public int compareTo(TimingGroup tg)
```
    This object implements the comparable object interface so that TimingGroup objects may be compared. For example, this is used in the example Router to compare TimingGroups based on delay cost in picoseconds.
    
    Specified by:
    
    compareTo in interface Comparable<TimingGroup>
    
    Parameters:
    
    tg - Second TimingGroup to compare this object to.
    
    Returns:
    
    Returns -1 if this object has lower cost, 0 if the costs are the same, and 1 if this object has higher cost.
  - hasPIPs
```
public boolean hasPIPs()
```
    Returns whether this TimingGroup contains any PIPs.
    
    Returns:
    
    Boolean indication of whether this object contains any PIPs.
  - getNodes
```
public List<Node> getNodes()
```
    Gets the list of nodes in the timing group.
    
    Returns:
    
    The list of nodes in the timing group
  - getNode
```
public Node getNode(int i)
```
    Gets the node in the timing group at the specified index
    
    Parameters:
    
    i - Index of the node to get.
    
    Returns:
    
    Node at the index i of this timing group
  - getLastNode
```
public Node getLastNode()
```
    Gets the last node in the timing group
    
    Returns:
    
    The last node in the timing group
  - getPIPs
```
public List<PIP> getPIPs()
```
  - getPIP
```
public PIP getPIP(int i)
```
  - getLastPIP
```
public PIP getLastPIP()
```
  - getNodeTypes
```
public List<IntentCode> getNodeTypes()
```
  - getNodeType
```
public IntentCode getNodeType(int i)
```
  - getDelayType
```
public GroupDelayType getDelayType()
```
  - getWireDirection
```
public GroupWireDirection getWireDirection()
```
  - getDirection
```
public TimingDirection getDirection()
```
  - isInitialGroup
```
public boolean isInitialGroup()
```
  - isFinalGroup
```
public boolean isFinalGroup()
```
  - setInitialGroup
```
public void setInitialGroup(boolean value)
```
  - setFinalGroup
```
public void setFinalGroup(boolean value)
```
  - hasPinFeed
```
public boolean hasPinFeed()
```

Class TimingGroup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

d

dist

delay

cost

sameSpotCounter

EMPTY_ARRAY

Constructor Detail

TimingGroup

TimingGroup

Method Detail

getNextTimingGroups

add

add

toString

computeTypes

compareTo

hasPIPs

getNodes

getNode

getLastNode

getPIPs

getPIP

getLastPIP

getNodeTypes

getNodeType

getDelayType

getWireDirection

getDirection

isInitialGroup

isFinalGroup

setInitialGroup

setFinalGroup

hasPinFeed