com.xilinx.rapidwright.device

Enum SitePIPStatus

Object

Enum<SitePIPStatus>

com.xilinx.rapidwright.device.SitePIPStatus

All Implemented Interfaces:

Serializable, Comparable<SitePIPStatus>

public enum SitePIPStatus
extends Enum<SitePIPStatus>

Different modes for site PIPs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF
OFF_FIXED
ON
ON_FIXED

Field Summary

Fields

Modifier and Type	Field and Description
static SitePIPStatus[]	values

Method Summary

Modifier and Type	Method and Description
boolean	isFixed() Status marks PIP as fixed?
boolean	isUsed() Status marks PIP as used?
static SitePIPStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static SitePIPStatus[]	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

OFF

public static final SitePIPStatus OFF

ON

public static final SitePIPStatus ON

OFF_FIXED

public static final SitePIPStatus OFF_FIXED

ON_FIXED

public static final SitePIPStatus ON_FIXED

Field Detail

values

public static final SitePIPStatus[] values

Method Detail

values

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

Returns:

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

valueOf

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

isUsed

public boolean isUsed()

Status marks PIP as used?

Returns:

True if this status marks PIP as used, false otherwise.

Since:

2018.2.0

isFixed

public boolean isFixed()

Status marks PIP as fixed?

Returns:

True if status marks PIP as fixed, false otherwise.

Since:

2018.2.0