TimingVertex

Object
- com.xilinx.rapidwright.timing.TimingVertex

```
public class TimingVertex
extends Object
```
A TimingVertex represents a node within the TimingGraph. It encapsulates slack, arrival time, required time, and whether it represents a pin on a flip flop.

Constructor Summary

Constructors
Constructor and Description
`TimingVertex(String name)` Creates a vertex for insertion into the TimingGraph.
`TimingVertex(String name, boolean isFlopInput)` Create a timing vertex for insertion into the timing graph

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object o)` Implements the comparable object interface so that Vertices can be compared.
`boolean`	`equals(Object o)` Implements the comparable object interface so that vertices can be compared.
`float`	`getArrivalTime()` Gets the arrival time stored at this vertex.
`String`	`getClockName()` This will be used in a future release to get the name of the clock associated with this vertex.
`boolean`	`getFlopInput()` This is used for checking if the vertex represents on input to a flip flop.
`boolean`	`getFlopOutput()` This is used for checking if the vertex represents an output from a flip flop.
`String`	`getName()` Gets the name of the vertex.
`TimingVertex`	`getPrev()`
`float`	`getRequiredTime()` Gets the required time stored at this vertex.
`Float`	`getSlack()` Gets the slack stored at this vertex.
`int`	`hashCode()` This method is used when storing TimingVertices in HashTables and HashMaps.
`void`	`resetArrivalTime()`
`void`	`resetRequiredTime()`
`void`	`setArrivalTime(float arrivalTime)` Sets the arrival time stored at this vertex.
`void`	`setClockName(String clockName)` This will be used in a future release to set the name of the clock associated with this vertex.
`void`	`setFlopInput()` This is used for setting that the vertex represents an input to a flip flop.
`void`	`setFlopOutput()` This is used for setting that the vertex represents an output from a flip flop.
`void`	`setMaxArrivalTime(float arrivalTime)` Sets the arrival time stored at this vertex WHEN the new arrival time is larger than the current.
`void`	`setMaxArrivalTime(float arrivalTime, TimingVertex prev)`
`void`	`setMinRequiredTime(float requiredTime)`
`void`	`setPrev(TimingVertex prev)`
`void`	`setRequiredTime(float requiredTime)` Sets the required time stored at this vertex.
`void`	`setSlack(float slack)` Sets the slack value stored at this vertex.
`String`	`toString()` Returns a String representation of this object.

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

- Constructor Detail
  - TimingVertex
```
public TimingVertex(String name)
```
    Creates a vertex for insertion into the TimingGraph.
    
    Parameters:
    
    name - Name is typically the hierarchical logical name of an input or output pin. In some cases this timing library is using the EDIFPortInst name for the name. This is noteworthy because the EDIFPortInst name may contain square brackets on pins that are indexed slices of a bus (for example some pins on CARRY8 have indices). The physical name for pins do not contain square brackets.
  - TimingVertex
```
public TimingVertex(String name,
                    boolean isFlopInput)
```
    Create a timing vertex for insertion into the timing graph
    
    Parameters:
    
    name - - name is the cell name of an input or output pin
    
    isFlopInput - - to indicate if it is an input or output
- Method Detail
  - toString
```
public String toString()
```
    Returns a String representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation, which is the name.
  - compareTo
```
public int compareTo(Object o)
```
    Implements the comparable object interface so that Vertices can be compared. This comparison is based on the name.
    
    Parameters:
    
    o - Object to be compared to.
    
    Returns:
    
    Result of comparing the name if both objects are of TimingVertex type.
  - equals
```
public boolean equals(Object o)
```
    Implements the comparable object interface so that vertices can be compared. This checks whether the names of two objects are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - Object to be compared to.
    
    Returns:
    
    Result of comparing the name if both objects are of TimingVertex type for equality.
  - hashCode
```
public int hashCode()
```
    This method is used when storing TimingVertices in HashTables and HashMaps. This method returns a hashed representation based on the name.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    Returns a hash code based on the name.
  - setSlack
```
public void setSlack(float slack)
```
    Sets the slack value stored at this vertex.
    
    Parameters:
    
    slack - Slack in picoseconds.
  - setRequiredTime
```
public void setRequiredTime(float requiredTime)
```
    Sets the required time stored at this vertex.
    
    Parameters:
    
    requiredTime - Required time in picoseconds.
  - setMinRequiredTime
```
public void setMinRequiredTime(float requiredTime)
```
  - setMaxArrivalTime
```
public void setMaxArrivalTime(float arrivalTime)
```
    Sets the arrival time stored at this vertex WHEN the new arrival time is larger than the current.
    
    Parameters:
    
    arrivalTime - Arrival time in picoseconds. This is the sum of delay edges leading to this vertex
  - setMaxArrivalTime
```
public void setMaxArrivalTime(float arrivalTime,
                              TimingVertex prev)
```
  - resetRequiredTime
```
public void resetRequiredTime()
```
  - resetArrivalTime
```
public void resetArrivalTime()
```
  - setArrivalTime
```
public void setArrivalTime(float arrivalTime)
```
    Sets the arrival time stored at this vertex.
    
    Parameters:
    
    arrivalTime - Arrival time in picoseconds. This is the sum of delay edges leading to this vertex.
  - getSlack
```
public Float getSlack()
```
    Gets the slack stored at this vertex.
    
    Returns:
    
    Slack value in picoseconds.
  - getArrivalTime
```
public float getArrivalTime()
```
    Gets the arrival time stored at this vertex.
    
    Returns:
    
    Arrival time in picoseconds.
  - getRequiredTime
```
public float getRequiredTime()
```
    Gets the required time stored at this vertex.
    
    Returns:
    
    Required time in picoseconds.
  - getName
```
public String getName()
```
    Gets the name of the vertex.
    
    Returns:
    
    Name of the vertex.
  - getClockName
```
public String getClockName()
```
    This will be used in a future release to get the name of the clock associated with this vertex.
    
    Returns:
    
    Clock name.
  - setClockName
```
public void setClockName(String clockName)
```
    This will be used in a future release to set the name of the clock associated with this vertex.
    
    Parameters:
    
    clockName - Clock name.
  - getFlopInput
```
public boolean getFlopInput()
```
    This is used for checking if the vertex represents on input to a flip flop.
    
    Returns:
    
    Boolean indication of whether this is an input to a flip flop.
  - getFlopOutput
```
public boolean getFlopOutput()
```
    This is used for checking if the vertex represents an output from a flip flop.
    
    Returns:
    
    Boolean indication of whether this is an output from a flip flop.
  - setFlopInput
```
public void setFlopInput()
```
    This is used for setting that the vertex represents an input to a flip flop.
  - setFlopOutput
```
public void setFlopOutput()
```
    This is used for setting that the vertex represents an output from a flip flop.
  - getPrev
```
public TimingVertex getPrev()
```
  - setPrev
```
public void setPrev(TimingVertex prev)
```

Class TimingVertex

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

TimingVertex

TimingVertex

Method Detail

toString

compareTo

equals

hashCode

setSlack

setRequiredTime

setMinRequiredTime

setMaxArrivalTime

setMaxArrivalTime

resetRequiredTime

resetArrivalTime

setArrivalTime

getSlack

getArrivalTime

getRequiredTime

getName

getClockName

setClockName

getFlopInput

getFlopOutput

setFlopInput

setFlopOutput

getPrev

setPrev