com.xilinx.rapidwright.design.tools

Enum Edge

Object

Enum<Edge>

com.xilinx.rapidwright.design.tools.Edge

All Implemented Interfaces:

Serializable, Comparable<Edge>

public enum Edge
extends Enum<Edge>

Describes the edge types of rectangles when composed of tiles.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
EXTERNAL
INTERNAL
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST
WEST

Method Summary

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

NORTH

public static final Edge NORTH

EAST

public static final Edge EAST

SOUTH

public static final Edge SOUTH

WEST

public static final Edge WEST

NORTH_EAST

public static final Edge NORTH_EAST

SOUTH_EAST

public static final Edge SOUTH_EAST

SOUTH_WEST

public static final Edge SOUTH_WEST

NORTH_WEST

public static final Edge NORTH_WEST

INTERNAL

public static final Edge INTERNAL

EXTERNAL

public static final Edge EXTERNAL

Method Detail

values

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

Returns:

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

valueOf

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

isEdgeCrossing

public boolean isEdgeCrossing()