RWRouteConfig

Object
- com.xilinx.rapidwright.rwroute.RWRouteConfig

```
public class RWRouteConfig
extends Object
```
A collection of customizable parameters for a RWRoute Object or a TimingAndWirelengthReport Object. Modifications of default parameter values can be done by adding corresponding options with values to the arguments. Each option (i.e. one of the parameters) name must start with two dashes. Values of parameters do not need dashes.

Constructor Summary

Constructors
Constructor and Description

RWRouteConfig(String[] arguments)
Constructs a Configuration Object

Constructors
Constructor and Description
`RWRouteConfig(String[] arguments)` Constructs a Configuration Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`short`	`getBoundingBoxExtensionX()` Gets the initial bounding box extension range in the horizontal direction.
`short`	`getBoundingBoxExtensionY()` Gets the initial bounding box extension range in the vertical direction.
`String`	`getClkRouteTiming()` Sets the clock enable net timing data file.
`float`	`getCriticalityExponent()` Gets the criticality exponent that is used in calculating connections' criticalities to spread the criticalities of less critical connections and more critical connections apart.
`String`	`getDspTimingDataFolder()` Gets the DSP timing data folder that contains DSP timing data files for the current design to be routed.
`boolean`	`getExportOutOfContext()` Gets the flag indicating if the design returned after routing should be marked out of context.
`short`	`getExtensionXIncrement()` Gets the extension increment that connections' bounding boxes should be enlarged by horizontally.
`short`	`getExtensionYIncrement()` Gets the extension increment that connections' bounding boxes should be enlarged by vertically.
`float`	`getHistoricalCongestionFactor()` Gets the historical congestion cost penalty factor.
`float`	`getHusActivateThreshold()` Gets the threshold (number of congested connections at the end of the routing iteration divided by total number of connections to be routed) below which HUS will be activated Default: 0.4
`float`	`getHusAlpha()` Gets the value of alpha in the hybrid updating strategy (HUS) Default: 1.1
`float`	`getHusBeta()` Gets the value of beta in the hybrid updating strategy (HUS) Default: 2.0
`float`	`getHusInitialCongestedThreshold()` Gets the threshold (number of overused nodes at the end of routing iteration 1 divided by total number of connections to be routed) above which a design is congested enough to consider HUS Default: 0.5
`float`	`getInitialPresentCongestionFactor()` Gets the initial present congestion cost penalty factor.
`short`	`getMaxIterations()` Gets the allowed maximum number of routing iterations.
`float`	`getMaxPresentCongestionFactor()` Gets the max present congestion factor that should prevent accuracy loss.
`float`	`getMinRerouteCriticality()` Gets the criticality threshold for re-routing critical connections.
`float`	`getPessimismA()` Gets the critical path delay pessimism factor a.
`short`	`getPessimismB()` Gets critical path delay factor b.
`float`	`getPresentCongestionMultiplier()` Gets the present congestion factor multiplier.
`short`	`getReroutePercentage()` Gets the maximum percentage of critical connections that should be re-routed.
`float`	`getShareExponent()` Gets the sharing exponent that discourages resource sharing for timing-driven routing of critical connections.
`float`	`getTimingMultiplier()` Gets the timing-driven weighting factor multiplier.
`float`	`getTimingWeight()` Gets the timing-driven weighting factor used in the cost function.
`float`	`getWirelengthWeight()` Gets the wirelength-driven weighting factor used in the cost function.
`boolean`	`isEnlargeBoundingBox()` Checks if the bounding boxes of connections would be expanded during routing.
`boolean`	`isHus()` Checks if the hybrid updating strategy (HUS) is enabled.
`boolean`	`isInvertGndToVccForLutInputs()` Gets the flag indicating if GND to VCC inversion for LUT inputs is enabled.
`boolean`	`isLutPinSwapping()` Gets the flag indicating if LUT pin swapping is enabled.
`boolean`	`isLutRoutethru()` Gets the flag indicating if LUT routethrus are enabled.
`boolean`	`isMaskNodesCrossRCLK()` Checks if nodes cross RCLK are masked.
`boolean`	`isPrintConnectionSpan()` Gets printConnectionSpan value.
`boolean`	`isTimingDriven()` Checks if the router should run in the timing-driven mode.
`boolean`	`isUseBoundingBox()` Checks if the routing bounding box constraint is used.
`boolean`	`isUseUTurnNodes()` Checks if U-turn nodes at the device boundaries are considered to be used.
`boolean`	`isVerbose()` Checks if verbose is enabled.
`void`	`setBoundingBoxExtensionX(short boundingBoxExtensionX)` Sets the initial bounding box extension range in the horizontal direction.
`void`	`setBoundingBoxExtensionY(short boundingBoxExtensionY)` Sets the initial bounding box extension range in the vertical direction.
`void`	`setClkRouteTiming(String clkRouteTiming)` Sets the clock enable net timing data file.
`void`	`setCriticalityExponent(float criticalityExponent)` Sets the criticality exponent that is used in calculating connections' criticalities to spread the criticalities of less critical connections and more critical connections apart.
`void`	`setDspTimingDataFolder(String dspTimingDataFolder)` Sets the DSP timing data folder that contains DSP timing data files for the current design to be routed.
`void`	`setEnlargeBoundingBox(boolean enlargeBoundingBox)` Sets enlargeBoundingBox.
`void`	`setExportDesignOutOfContext(boolean exportOutOfContext)` Sets a flag indicating the design should be exported as out of context.
`void`	`setExtensionXIncrement(short extensionXIncrement)` Sets the extension increment that connections' bounding boxes should be enlarged by horizontally.
`void`	`setExtensionYIncrement(short extensionYIncrement)` Sets the extension increment that connections' bounding boxes should be enlarged by vertically.
`void`	`setHistoricalCongestionFactor(float historicalCongestionFactor)` Sets the historical congestion cost penalty factor.
`void`	`setHus(boolean hus)` Sets whether hybrid updating strategy (HUS) is enabled.
`void`	`setHusActivateThreshold(float husActivateThreshold)` Sets the threshold (number of congested connections at the end of the routing iteration divided by total number of connections to be routed) below which HUS will be activated Default: 0.4
`void`	`setHusAlpha(float husAlpha)` Sets the value of alpha in the hybrid updating strategy (HUS) Default: 1.1
`void`	`setHusBeta(float husBeta)` Sets the value of beta in the hybrid updating strategy (HUS) Default: 2.0
`void`	`setHusInitialCongestedThreshold(float husInitialCongestedThreshold)` Sets the threshold (number of overused nodes at the end of routing iteration 1 divided by total number of connections to be routed) above which a design is congested enough to consider HUS Default: 0.5
`void`	`setInitialPresentCongestionFactor(float initialPresentCongestionFactor)` Sets the initial present congestion cost penalty factor.
`void`	`setInvertGndToVccForLutInputs(boolean invertGndToVccForLutInputs)` Sets the flag for enabling GND to VCC inversion for LUT inputs.
`void`	`setLutPinSwapping(boolean lutPinSwapping)` Sets a flag indicating LUT pins can be swapped.
`void`	`setLutRoutethru(boolean lutRoutethru)` Sets a flag indicating LUT routethrus will be considered.
`void`	`setMaskNodesCrossRCLK(boolean maskNodesCrossRCLK)` Sets maskNodesCrossRCLK.
`void`	`setMaxIterations(short maxIterations)` Sets the maximum number of routing iterations.
`void`	`setMinRerouteCriticality(float minRerouteCriticality)` Sets the criticality threshold for re-routing critical connections.
`void`	`setPessimismA(float pessimismA)` Sets the critical path delay pessimism factor a.
`void`	`setPessimismB(short pessimismB)` Sets critical path delay pessimism factor b.
`void`	`setPresentCongestionMultiplier(float presentCongestionMultiplier)` Sets the present congestion factor multiplier.
`void`	`setPrintConnectionSpan(boolean printConnectionSpan)` Sets printConnectionSpan.
`void`	`setReroutePercentage(short reroutePercentage)` Sets the maximum percentage of critical connections that should be re-routed.
`void`	`setShareExponent(float shareExponent)` Sets the sharing exponent that discourages resource sharing for timing-driven routing of critical connections.
`void`	`setTimingDriven(boolean timingDriven)` Sets timingDriven.
`void`	`setTimingMultiplier(float timingMultiplier)` Sets the multiplier for timingWeight.
`void`	`setTimingWeight(float timingWeight)` Sets the timing-driven weighting factor used in the cost function.
`void`	`setUseBoundingBox(boolean useBoundingBox)` Sets if the router should route connections with the routing bounding box constraint.
`void`	`setUseUTurnNodes(boolean useUTurnNodes)` Sets useUTurnNodes.
`void`	`setVerbose(boolean verbose)` Sets verbose.
`void`	`setWirelengthWeight(float wirelengthWeight)` Sets the wirelength-driven weighting factor used in the cost function.
`String`	`toString()`

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

- Constructor Detail
  - RWRouteConfig
```
public RWRouteConfig(String[] arguments)
```
    Constructs a Configuration Object
- Method Detail
  - getMaxIterations
```
public short getMaxIterations()
```
    Gets the allowed maximum number of routing iterations. Default: 100
    
    Returns:
    
    The allowed maximum number of routing iterations.
  - setMaxIterations
```
public void setMaxIterations(short maxIterations)
```
    Sets the maximum number of routing iterations. Default: 100. 100 iterations should be enough for most routing cases. Otherwise, it is not promising that a design can be successfully routed. To modify the value, please use "--maxIterations" option, e.g. "--maxIterations 60".
    
    Parameters:
    
    maxIterations - The maximum number of routing iterations.
  - isUseBoundingBox
```
public boolean isUseBoundingBox()
```
    Checks if the routing bounding box constraint is used. Default: true. To disable the bounding box constraint, please add "--noBoundingBox" to the arguments.
    
    Returns:
    
    true, if the routing bounding box constraint is used.
  - setUseBoundingBox
```
public void setUseBoundingBox(boolean useBoundingBox)
```
    Sets if the router should route connections with the routing bounding box constraint. Default: true. To disable the bounding box constraint, please add "--noBoundingBox" option to the arguments.
    
    Parameters:
    
    useBoundingBox - true to let the router use the bounding box constraint to route connections.
  - getBoundingBoxExtensionX
```
public short getBoundingBoxExtensionX()
```
    Gets the initial bounding box extension range in the horizontal direction. Default: 3. Can be modified by using use "--boundingBoxExtensionX" option, e.g. "--boundingBoxExtensionX 5".
    
    Returns:
    
    The bounding box extension range in the horizontal direction.
  - setBoundingBoxExtensionX
```
public void setBoundingBoxExtensionX(short boundingBoxExtensionX)
```
    Sets the initial bounding box extension range in the horizontal direction. Default: 3. Can be modified by using use "--boundingBoxExtensionX" option, e.g. "--boundingBoxExtensionX 5".
    
    Parameters:
    
    boundingBoxExtensionX -
  - getBoundingBoxExtensionY
```
public short getBoundingBoxExtensionY()
```
    Gets the initial bounding box extension range in the vertical direction. Default: 15. Can be modified by using use "--boundingBoxExtensionY" option, e.g. "--boundingBoxExtensionY 5".
    
    Returns:
    
    The bounding box extension range in the vertical direction.
  - setBoundingBoxExtensionY
```
public void setBoundingBoxExtensionY(short boundingBoxExtensionY)
```
    Sets the initial bounding box extension range in the vertical direction. Default: 15. Can be modified by using use "--boundingBoxExtensionY" option, e.g. "--boundingBoxExtensionY 5".
    
    Parameters:
    
    boundingBoxExtensionY -
  - isEnlargeBoundingBox
```
public boolean isEnlargeBoundingBox()
```
    Checks if the bounding boxes of connections would be expanded during routing. Enlarging bounding boxes of connections helps resolve routability problems for some scenarios, such as partial routing and very congested placement of designs. Default: false for full routing, true for partial routing. To enable enlarging bounding boxes, please add "--enlargeBoundingBox" to the arguments.
    
    Returns:
    
    true, if enlarging bounding boxes of connections is allowed.
  - setEnlargeBoundingBox
```
public void setEnlargeBoundingBox(boolean enlargeBoundingBox)
```
    Sets enlargeBoundingBox. Enlarging bounding boxes of connections helps resolve routability problems for some scenarios, such as partial routing and very congested designs. Default: false for full routing, true for partial routing. To enable enlarging bounding boxes, please add "--enlargeBoundingBox" to the arguments.
    
    Parameters:
    
    enlargeBoundingBox - A flag to indicate if connections' bounding boxes are allowed to be enlarged for routing.
  - getExtensionYIncrement
```
public short getExtensionYIncrement()
```
    Gets the extension increment that connections' bounding boxes should be enlarged by vertically. Default: 2. Can be modified by using "--extensionYIncrement" option, e.g. "--extensionYIncrement 3".
    
    Returns:
    
    The number of INT Tiles that connections' bounding boxes should be enlarged by vertically.
  - setExtensionYIncrement
```
public void setExtensionYIncrement(short extensionYIncrement)
```
    Sets the extension increment that connections' bounding boxes should be enlarged by vertically. Default: 2. Can be modified by using "--extensionYIncrement" option, e.g. "--extensionYIncrement 3".
    
    Parameters:
    
    extensionYIncrement - The number of INT Tiles that connections' bounding boxes should be enlarged by vertically.
  - getExtensionXIncrement
```
public short getExtensionXIncrement()
```
    Gets the extension increment that connections' bounding boxes should be enlarged by horizontally. Default: 1. Can be modified by using "--extensionXIncrement" option, e.g. "--extensionXIncrement 2".
    
    Returns:
    
    The number of INT Tiles that connections' bounding boxes should be enlarged by horizontally.
  - setExtensionXIncrement
```
public void setExtensionXIncrement(short extensionXIncrement)
```
    Sets the extension increment that connections' bounding boxes should be enlarged by horizontally. Default: 1. Can be modified by using "--extensionXIncrement" option, e.g. "--extensionXIncrement 2".
    
    Parameters:
    
    extensionXIncrement - The number of INT Tiles that connections' bounding boxes should be enlarged by horizontally.
  - getWirelengthWeight
```
public float getWirelengthWeight()
```
    Gets the wirelength-driven weighting factor used in the cost function. It should be within [0, 1]. The greater it is, the faster the router will run, at the cost of a greater total wirelength. Default: 0.8. Can be modified by using "--wirelengthWeight", e.g. "--wirelengthWeight 0.7".
    
    Returns:
    
    The wirelength-driven weighting factor used in the cost function
  - setWirelengthWeight
```
public void setWirelengthWeight(float wirelengthWeight)
```
    Sets the wirelength-driven weighting factor used in the cost function. It should be within [0, 1]. The greater it is, the faster the router will run, at the cost of a greater total wirelength. Default: 0.8. Can be modified by using "--wirelengthWeight", e.g. "--wirelengthWeight 0.7".
    
    Parameters:
    
    wirelengthWeight - The wirelength-driven weighting factor used in the cost function
  - getTimingWeight
```
public float getTimingWeight()
```
    Gets the timing-driven weighting factor used in the cost function. It should be within [0, 1]. The greater it is, the faster the router will run, at the cost of a greater critical path delay. Default: 0.35. Can be modified by using "--timingWeight" option, e.g. "--timingWeight 0.4".
    
    Returns:
    
    The timing-driven weighting factor used in the cost function
  - setTimingWeight
```
public void setTimingWeight(float timingWeight)
```
    Sets the timing-driven weighting factor used in the cost function. It should be within [0, 1]. The greater it is, the faster the router will run, at the cost of a greater critical path delay. Default: 0.35. Can be modified by using "--timingWeight" option, e.g. "--timingWeight 0.4".
    
    Parameters:
    
    timingWeight - The timing-driven weighting factor used in the cost function.
  - getTimingMultiplier
```
public float getTimingMultiplier()
```
    Gets the timing-driven weighting factor multiplier. Default: 1. Can be modified by using "--timingMultiplier" option, e.g. "--timingMultiplier 1.02".
    
    Returns:
    
    The timing-driven weighting factor multiplier.
  - setTimingMultiplier
```
public void setTimingMultiplier(float timingMultiplier)
```
    Sets the multiplier for timingWeight. This is an experimental feature for future adaptive timingWeight. The idea is to have less timingWeight in early routing iterations for faster runtime and put more weight on the timing cost in late iterations for better timing performance. Currently, the default timingMultiplier is 1. Can be modified by using "--timingMultiplier" option, e.g. "--timingMultiplier 1.02".
    
    Parameters:
    
    timingMultiplier - A multiplier greater than 1 to increase timingWeight along routing iterations.
  - getShareExponent
```
public float getShareExponent()
```
    Gets the sharing exponent that discourages resource sharing for timing-driven routing of critical connections. It is no less than 0. Default: 2. Can be modified by using "--shareExponent" option, e.g. "--shareExponent 4".
    
    Returns:
    
    The sharing exponent that discourages resource sharing for timing-driven routing of critical connections.
  - setShareExponent
```
public void setShareExponent(float shareExponent)
```
    Sets the sharing exponent that discourages resource sharing for timing-driven routing of critical connections. It is no less than 0. Default: 2. Can be modified by using "--shareExponent" option, e.g. "--shareExponent 4".
    
    Parameters:
    
    shareExponent - The sharing exponent that discourages resource sharing for timing-driven routing of critical connections.
  - getCriticalityExponent
```
public float getCriticalityExponent()
```
    Gets the criticality exponent that is used in calculating connections' criticalities to spread the criticalities of less critical connections and more critical connections apart. It should be greater than 1. Default: 3. Can be modified by using "--criticalityExponent" option, e.g. "--criticalityExponent 5".
    
    Returns:
    
    The criticality exponent.
  - setCriticalityExponent
```
public void setCriticalityExponent(float criticalityExponent)
```
    Sets the criticality exponent that is used in calculating connections' criticalities to spread the criticalities of less critical connections and more critical connections apart. It should be greater than 1. Default: 3. Can be modified by using "--criticalityExponent" option, e.g. "--criticalityExponent 5".
    
    Parameters:
    
    criticalityExponent -
  - getMinRerouteCriticality
```
public float getMinRerouteCriticality()
```
    Gets the criticality threshold for re-routing critical connections. It should be within (0.5, 0.99). A greater value means less critical connections to be ripped up and re-routed. Default: 0.85. Can be modified by using "--minRerouteCriticality" option, e.g. "--minRerouteCriticality 0.9".
    
    Returns:
  - setMinRerouteCriticality
```
public void setMinRerouteCriticality(float minRerouteCriticality)
```
    Sets the criticality threshold for re-routing critical connections. It should be within (0.5, 0.99). A greater value means less critical connections to be ripped up and re-routed. Default: 0.85. Can be modified by using "--minRerouteCriticality" option, e.g. "--minRerouteCriticality 0.9".
    
    Parameters:
    
    minRerouteCriticality -
  - getReroutePercentage
```
public short getReroutePercentage()
```
    Gets the maximum percentage of critical connections that should be re-routed. It should be greater than 0. Default: 3. Can be modified by using "--reroutePercentage" option, e.g. "--reroutePercentage 5".
    
    Returns:
  - setReroutePercentage
```
public void setReroutePercentage(short reroutePercentage)
```
    Sets the maximum percentage of critical connections that should be re-routed. It should be greater than 0. Default: 3. Can be modified by using "--reroutePercentage" option, e.g. "--reroutePercentage 5".
    
    Parameters:
    
    reroutePercentage -
  - getInitialPresentCongestionFactor
```
public float getInitialPresentCongestionFactor()
```
    Gets the initial present congestion cost penalty factor. It should be greater than 0. Default: 0.5. Can be modified by using "--initialPresentCongestionFactor" option, e.g. "--initialPresentCongestionFactor 1".
    
    Returns:
    
    The initial present congestion cost penalty factor.
  - setInitialPresentCongestionFactor
```
public void setInitialPresentCongestionFactor(float initialPresentCongestionFactor)
```
    Sets the initial present congestion cost penalty factor. It should be greater than 0. Default: 0.5. Can be modified by using "--initialPresentCongestionFactor" option, e.g. "--initialPresentCongestionFactor 1".
    
    Parameters:
    
    initialPresentCongestionFactor - The value to set.
  - getPresentCongestionMultiplier
```
public float getPresentCongestionMultiplier()
```
    Gets the present congestion factor multiplier. It should be greater than 1. Default: 2. Can be modified by using "--presentCongestionMultiplier" option, e.g. "--presentCongestionMultiplier 3".
    
    Returns:
  - setPresentCongestionMultiplier
```
public void setPresentCongestionMultiplier(float presentCongestionMultiplier)
```
    Sets the present congestion factor multiplier. It should be greater than 1. Default: 2. Can be modified by using "--presentCongestionMultiplier" option, e.g. "--presentCongestionMultiplier 3".
    
    Parameters:
    
    presentCongestionMultiplier -
  - getMaxPresentCongestionFactor
```
public float getMaxPresentCongestionFactor()
```
    Gets the max present congestion factor that should prevent accuracy loss. This value is computed by RWRouteConfig.setWirelengthWeight(float).
    
    Returns:
  - getHistoricalCongestionFactor
```
public float getHistoricalCongestionFactor()
```
    Gets the historical congestion cost penalty factor. It should be greater than 0. Default: 1. Can be modified by using "--historicalCongestionFactor" option, e.g. "--historicalCongestionFactor 2".
    
    Returns:
  - setHistoricalCongestionFactor
```
public void setHistoricalCongestionFactor(float historicalCongestionFactor)
```
    Sets the historical congestion cost penalty factor. It should be greater than 0. Default: 1. Can be modified by using "--historicalCongestionFactor" option, e.g. "--historicalCongestionFactor 2".
    
    Parameters:
    
    historicalCongestionFactor -
  - isTimingDriven
```
public boolean isTimingDriven()
```
    Checks if the router should run in the timing-driven mode. Default: true. For wirelength-driven routing only, please use "--nonTimingDriven" option to disable timing-driven routing.
    
    Returns:
    
    true, if the router runs in the timing-driven mode.
  - setTimingDriven
```
public void setTimingDriven(boolean timingDriven)
```
    Sets timingDriven. Default: true. For wirelength-driven routing only, please use "--nonTimingDriven" option to disable timing-driven routing.
    
    Parameters:
    
    timingDriven -
  - getDspTimingDataFolder
```
public String getDspTimingDataFolder()
```
    Gets the DSP timing data folder that contains DSP timing data files for the current design to be routed. They are used for timing-driven routing of designs with DSPs. They can be generated by running Vivado with the Tcl script provided under $RAPIDWRIGHT_PATH/tcl/rwroute. Default: null.
    
    Returns:
  - setDspTimingDataFolder
```
public void setDspTimingDataFolder(String dspTimingDataFolder)
```
    Sets the DSP timing data folder that contains DSP timing data files for the current design to be routed. They are used for more accurate delay calculation during timing-driven routing of designs with DSPs. They can be generated by running Vivado with the Tcl script provided under $RAPIDWRIGHT_PATH/tcl/rwroute. Default: null. Can be specified by using "--dspTimingDataFolder" option, e.g. "--dspTimingDataFolder $RAPIDWRIGHT_PATH/DSPTimingFilesOfDesign/". Without DSP timing files supplied, the router still continues timing-aware routing. Yet there could be unexpected delay optimism.
    
    Parameters:
    
    dspTimingDataFolder - The directory that contains DSP timing data files for the current design to be routed.
  - getClkRouteTiming
```
public String getClkRouteTiming()
```
    Sets the clock enable net timing data file. The file can be generated by running Vivado with the Tcl script provided under $RAPIDWRIGHT_PATH/tcl/rwroute. Default: null. Can be modified by using "--clkRouteTiming" option, e.g. "--clkRouteTiming $RAPIDWRIGHT_PATH/ceroute.txt".
    
    Returns:
  - setClkRouteTiming
```
public void setClkRouteTiming(String clkRouteTiming)
```
    Sets the clock enable net timing data file. The file can be generated by running Vivado with the Tcl script provided under $RAPIDWRIGHT_PATH/tcl/rwroute. Default: null. Can be modified by using "--clkRouteTiming" option, e.g. "--clkRouteTiming $RAPIDWRIGHT_PATH/clkroute.txt".
    
    Parameters:
    
    clkRouteTiming -
  - getPessimismA
```
public float getPessimismA()
```
    Gets the critical path delay pessimism factor a. It should be greater than 0.99. Default: 1.03. Can be modified by using "--pessimismA" option, e.g. "--pessimismA 1.05".
    
    Returns:
    
    pessimismA
  - setPessimismA
```
public void setPessimismA(float pessimismA)
```
    Sets the critical path delay pessimism factor a. It should be greater than 0.99. Default: 1.03. Can be modified by using "--pessimismA" option, e.g. "--pessimismA 1.05".
    
    Parameters:
    
    pessimismA -
  - getPessimismB
```
public short getPessimismB()
```
    Gets critical path delay factor b. It should be greater than 0. Default: 100. Can be modified by using "--pessimismB" option, e.g. "--pessimismB 50".
    
    Returns:
    
    pessimismB
  - getExportOutOfContext
```
public boolean getExportOutOfContext()
```
    Gets the flag indicating if the design returned after routing should be marked out of context. Default: false.
    
    Returns:
    
    True if the flag is set, false otherwise.
  - isLutPinSwapping
```
public boolean isLutPinSwapping()
```
    Gets the flag indicating if LUT pin swapping is enabled. Default: false.
    
    Returns:
    
    True if the flag is set, false otherwise.
  - isLutRoutethru
```
public boolean isLutRoutethru()
```
    Gets the flag indicating if LUT routethrus are enabled. Default: false.
    
    Returns:
    
    True if the flag is set, false otherwise.
  - isInvertGndToVccForLutInputs
```
public boolean isInvertGndToVccForLutInputs()
```
    Gets the flag indicating if GND to VCC inversion for LUT inputs is enabled. Default: true.
    
    Returns:
    
    True if the flag is set, false otherwise.
  - setPessimismB
```
public void setPessimismB(short pessimismB)
```
    Sets critical path delay pessimism factor b. It should be greater than 0. Default: 100. Can be modified by using "--pessimismB" option, e.g. "--pessimismB 50".
    
    Parameters:
    
    pessimismB -
  - isMaskNodesCrossRCLK
```
public boolean isMaskNodesCrossRCLK()
```
    Checks if nodes cross RCLK are masked. If should be set to true for full timing-driven routing to avoid delay optimism and false for partial timing-driven routing for routability. Default: false. Can be modified by adding "--maskNodesCrossRCLK" to the arguments.
    
    Returns:
    
    true, if nodes cross RCLK are masked
  - setMaskNodesCrossRCLK
```
public void setMaskNodesCrossRCLK(boolean maskNodesCrossRCLK)
```
    Sets maskNodesCrossRCLK. If should be set to true for full timing-driven routing to avoid delay optimism and false for partial timing-driven routing for routability. Default: false. Can be modified by adding "--maskNodesCrossRCLK" to the arguments.
    
    Parameters:
    
    maskNodesCrossRCLK - A flag to indicate if masking nodes cross RCLK.
  - isUseUTurnNodes
```
public boolean isUseUTurnNodes()
```
    Checks if U-turn nodes at the device boundaries are considered to be used. If the design is placed near the device boundaries, U-turn nodes should be considered to be used. Otherwise, there could be routability problems. Default: false. Can be modified by adding "--useUTurnNodes" to the arguments.
    
    Returns:
    
    true, if U-turn nodes are considered to be used
  - setUseUTurnNodes
```
public void setUseUTurnNodes(boolean useUTurnNodes)
```
    Sets useUTurnNodes. If the design is placed near the device boundaries, U-turn nodes should be considered to be used. Otherwise, there could be routability problems. Default: false. Can be modified by adding "--useUTurnNodes" to the arguments.
    
    Parameters:
    
    useUTurnNodes - A flag to indicate if U-turn nodes are considered to be used for routing.
  - isVerbose
```
public boolean isVerbose()
```
    Checks if verbose is enabled. If enabled, there will be more info in the routing log file regarding design netlist, routing statistics, and timing report. Default: false. Can be modified by adding "--verbose" to the arguments.
    
    Returns:
    
    true, if verbose is enabled.
  - isPrintConnectionSpan
```
public boolean isPrintConnectionSpan()
```
    Gets printConnectionSpan value. The router calculates connection span statistics during the initialization. Default: false.
    
    Returns:
  - setPrintConnectionSpan
```
public void setPrintConnectionSpan(boolean printConnectionSpan)
```
    Sets printConnectionSpan. The router calculates connection span statistics during the initialization. Default: false.
    
    Parameters:
    
    printConnectionSpan - true, to print out connection span statistics.
  - setExportDesignOutOfContext
```
public void setExportDesignOutOfContext(boolean exportOutOfContext)
```
    Sets a flag indicating the design should be exported as out of context. Default: false.
    
    Parameters:
    
    exportOutOfContext - true to export design as out of context.
  - setLutPinSwapping
```
public void setLutPinSwapping(boolean lutPinSwapping)
```
    Sets a flag indicating LUT pins can be swapped. Default: false.
    
    Parameters:
    
    lutPinSwapping - true to enable LUT pin swapping.
  - setLutRoutethru
```
public void setLutRoutethru(boolean lutRoutethru)
```
    Sets a flag indicating LUT routethrus will be considered. Default: false.
    
    Parameters:
    
    lutRoutethru - true to enable LUT pin swapping.
  - setInvertGndToVccForLutInputs
```
public void setInvertGndToVccForLutInputs(boolean invertGndToVccForLutInputs)
```
    Sets the flag for enabling GND to VCC inversion for LUT inputs. Default: true.
    
    Parameters:
    
    invertGndToVccForLutInputs - true to enableGND to VCC inversion for LUT inputs.
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Sets verbose. If true, there will be more info in the routing log file regarding design netlist, routing statistics, and timing report. Default: false. Can be modified by adding "--verbose" to the arguments.
    
    Parameters:
    
    verbose - true to print more info in the routing log file.
  - isHus
```
public boolean isHus()
```
    Checks if the hybrid updating strategy (HUS) is enabled. HUS will, once its user-configurable thresholds are met, slow down the growth of present costs of used nodes and instead increases the growth of overused nodes' historical costs. Default: false.
  - setHus
```
public void setHus(boolean hus)
```
    Sets whether hybrid updating strategy (HUS) is enabled. HUS will, once its user-configurable thresholds are met, slow down the growth of present costs of used nodes and instead increases the growth of overused nodes' historical costs. Default: false.
    
    Parameters:
    
    hus - true to enable the hybrid updating strategy (HUS)
  - getHusAlpha
```
public float getHusAlpha()
```
    Gets the value of alpha in the hybrid updating strategy (HUS) Default: 1.1
    
    Returns:
    
    the value of alpha in the hybrid updating strategy (HUS)
  - setHusAlpha
```
public void setHusAlpha(float husAlpha)
```
    Sets the value of alpha in the hybrid updating strategy (HUS) Default: 1.1
    
    Parameters:
    
    husAlpha - the value of alpha in the hybrid updating strategy (HUS)
  - getHusBeta
```
public float getHusBeta()
```
    Gets the value of beta in the hybrid updating strategy (HUS) Default: 2.0
    
    Returns:
    
    the value of beta in the hybrid updating strategy (HUS)
  - setHusBeta
```
public void setHusBeta(float husBeta)
```
    Sets the value of beta in the hybrid updating strategy (HUS) Default: 2.0
    
    Parameters:
    
    husBeta - the value of beta in the hybrid updating strategy (HUS)
  - getHusInitialCongestedThreshold
```
public float getHusInitialCongestedThreshold()
```
    Gets the threshold (number of overused nodes at the end of routing iteration 1 divided by total number of connections to be routed) above which a design is congested enough to consider HUS Default: 0.5
    
    Returns:
    
    the threshold for determining whether a design is congested enough to consider HUS
  - setHusInitialCongestedThreshold
```
public void setHusInitialCongestedThreshold(float husInitialCongestedThreshold)
```
    Sets the threshold (number of overused nodes at the end of routing iteration 1 divided by total number of connections to be routed) above which a design is congested enough to consider HUS Default: 0.5
    
    Parameters:
    
    husInitialCongestedThreshold - the threshold for determining whether a design is congested enough to consider HUS
  - getHusActivateThreshold
```
public float getHusActivateThreshold()
```
    Gets the threshold (number of congested connections at the end of the routing iteration divided by total number of connections to be routed) below which HUS will be activated Default: 0.4
    
    Returns:
    
    the threshold for determining whether to activate HUS
  - setHusActivateThreshold
```
public void setHusActivateThreshold(float husActivateThreshold)
```
    Sets the threshold (number of congested connections at the end of the routing iteration divided by total number of connections to be routed) below which HUS will be activated Default: 0.4
    
    Parameters:
    
    husActivateThreshold - the threshold for determining whether to activate HUS
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RWRouteConfig

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

RWRouteConfig

Method Detail

getMaxIterations

setMaxIterations

isUseBoundingBox

setUseBoundingBox

getBoundingBoxExtensionX

setBoundingBoxExtensionX

getBoundingBoxExtensionY

setBoundingBoxExtensionY

isEnlargeBoundingBox

setEnlargeBoundingBox

getExtensionYIncrement

setExtensionYIncrement

getExtensionXIncrement

setExtensionXIncrement

getWirelengthWeight

setWirelengthWeight

getTimingWeight

setTimingWeight

getTimingMultiplier

setTimingMultiplier

getShareExponent

setShareExponent

getCriticalityExponent

setCriticalityExponent

getMinRerouteCriticality

setMinRerouteCriticality

getReroutePercentage

setReroutePercentage

getInitialPresentCongestionFactor

setInitialPresentCongestionFactor

getPresentCongestionMultiplier

setPresentCongestionMultiplier

getMaxPresentCongestionFactor

getHistoricalCongestionFactor

setHistoricalCongestionFactor

isTimingDriven

setTimingDriven

getDspTimingDataFolder

setDspTimingDataFolder

getClkRouteTiming

setClkRouteTiming

getPessimismA

setPessimismA

getPessimismB

getExportOutOfContext

isLutPinSwapping

isLutRoutethru

isInvertGndToVccForLutInputs

setPessimismB

isMaskNodesCrossRCLK

setMaskNodesCrossRCLK

isUseUTurnNodes

setUseUTurnNodes

isVerbose

isPrintConnectionSpan

setPrintConnectionSpan

setExportDesignOutOfContext

setLutPinSwapping

setLutRoutethru

setInvertGndToVccForLutInputs

setVerbose

isHus

setHus

getHusAlpha

setHusAlpha

getHusBeta

setHusBeta

getHusInitialCongestedThreshold

setHusInitialCongestedThreshold

getHusActivateThreshold

setHusActivateThreshold

toString