com.xilinx.rapidwright.router

Enum VTreeType

Object

Enum<VTreeType>

com.xilinx.rapidwright.router.VTreeType

All Implemented Interfaces:

Serializable, Comparable<VTreeType>

public enum VTreeType
extends Enum<VTreeType>

USER_CLOCK_VTREE_TYPE values supported by Vivado for Versal clock routing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BALANCED
INTER_SLR
INTRA_SLR

Method Summary

Modifier and Type	Method and Description
static VTreeType	fromKeyBits(int keyBits)
static VTreeType	fromVivadoName(String name)
int	getKeyBits()
String	getVivadoName()
static VTreeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static VTreeType[]	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

BALANCED

public static final VTreeType BALANCED

INTER_SLR

public static final VTreeType INTER_SLR

INTRA_SLR

public static final VTreeType INTRA_SLR

Method Detail

values

public static VTreeType[] 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 (VTreeType c : VTreeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VTreeType 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

getVivadoName

public String getVivadoName()

getKeyBits

public int getKeyBits()

fromVivadoName

public static VTreeType fromVivadoName(String name)

fromKeyBits

public static VTreeType fromKeyBits(int keyBits)