com.xilinx.rapidwright.timing

Enum GroupDistance

Object

Enum<GroupDistance>

com.xilinx.rapidwright.timing.GroupDistance

All Implemented Interfaces:

Serializable, Comparable<GroupDistance>

public enum GroupDistance
extends Enum<GroupDistance>

Example distance categories that we created to describe some example filtering options for TimingGroups.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAR
MID
NEAR
SAME

Method Summary

Modifier and Type	Method and Description
static GroupDistance	valueOf(String name) Returns the enum constant of this type with the specified name.
static GroupDistance[]	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

SAME

public static final GroupDistance SAME

NEAR

public static final GroupDistance NEAR

MID

public static final GroupDistance MID

FAR

public static final GroupDistance FAR

Method Detail

values

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

Returns:

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

valueOf

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