RouterDirective

Object
- Enum<RouterDirective>
- - com.xilinx.rapidwright.util.RouterDirective

All Implemented Interfaces:

Serializable, Comparable<RouterDirective>
```
public enum RouterDirective
extends Enum<RouterDirective>
```
These are the directives found as options to 'route_design -directive', Created on: Mar 20, 2018

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdvancedSkewModeling` Uses more accurate skew modeling throughout all routing stages which may improve design performance on higher-skew clock networks.
`AggressiveExplore` Directs the router to further expand its exploration of critical path routes while maintaining original timing budgets.
`AlternateCLBRouting` (UltraScale only) Chooses alternate routing algorithms that require extra runtime but may help resolve routing congestion.
`Default` Run route_design with default settings.
`Explore` Causes the Vivado router to explore different critical path routes based on timing, after an initial route.
`HigherDelayCost` Adjusts the router`s internal cost functions to emphasize delay over iterations, allowing a trade-off of runtime for better performance.
`MoreGlobalIterations` Uses detailed timing analysis throughout all stages instead of just the final stages, and will run more global iterations even when timing improves only slightly.
`NoTimingRelaxation` Prevents the router from relaxing timing to complete routing.
`Quick` Absolute fastest runtime, non-timing-driven, performs the minimum required routing for a legal design.
`RuntimeOptimized` Run fewest iterations, trade higher design performance for faster runtime.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static RouterDirective`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RouterDirective[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - Explore
```
public static final RouterDirective Explore
```
    Causes the Vivado router to explore different critical path routes based on timing, after an initial route.
  - AggressiveExplore
```
public static final RouterDirective AggressiveExplore
```
    Directs the router to further expand its exploration of critical path routes while maintaining original timing budgets. The router runtime might be significantly higher compared to the Explore directive as the router uses more aggressive optimization thresholds to attempt to meet timing constraints.
  - NoTimingRelaxation
```
public static final RouterDirective NoTimingRelaxation
```
    Prevents the router from relaxing timing to complete routing. If the router has difficulty meeting timing, it will run longer to try to meet the original timing constraints.
  - MoreGlobalIterations
```
public static final RouterDirective MoreGlobalIterations
```
    Uses detailed timing analysis throughout all stages instead of just the final stages, and will run more global iterations even when timing improves only slightly.
  - HigherDelayCost
```
public static final RouterDirective HigherDelayCost
```
    Adjusts the router`s internal cost functions to emphasize delay over iterations, allowing a trade-off of runtime for better performance.
  - AdvancedSkewModeling
```
public static final RouterDirective AdvancedSkewModeling
```
    Uses more accurate skew modeling throughout all routing stages which may improve design performance on higher-skew clock networks.
  - AlternateCLBRouting
```
public static final RouterDirective AlternateCLBRouting
```
    (UltraScale only) Chooses alternate routing algorithms that require extra runtime but may help resolve routing congestion.
  - RuntimeOptimized
```
public static final RouterDirective RuntimeOptimized
```
    Run fewest iterations, trade higher design performance for faster runtime.
  - Quick
```
public static final RouterDirective Quick
```
    Absolute fastest runtime, non-timing-driven, performs the minimum required routing for a legal design.
  - Default
```
public static final RouterDirective Default
```
    Run route_design with default settings.
- Method Detail
  - values
```
public static RouterDirective[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RouterDirective c : RouterDirective.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RouterDirective valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum RouterDirective

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

Explore

AggressiveExplore

NoTimingRelaxation

MoreGlobalIterations

HigherDelayCost

AdvancedSkewModeling

AlternateCLBRouting

RuntimeOptimized

Quick

Default

Method Detail

values

valueOf