com.xilinx.rapidwright.device

Enum PIPType

Object

Enum<PIPType>

com.xilinx.rapidwright.device.PIPType

All Implemented Interfaces:

Serializable, Comparable<PIPType>

public enum PIPType
extends Enum<PIPType>

This type captures the PIP properties shown in a Vivado PIP called "IS_BUFFERED_2_0", "IS_BUFFERED_2_1" and "IS_DIRECTIONAL"

Vivado Tcl:

report_property $pip

Created on: Jun 9, 2015

Enum Constant Summary

Enum Constants

Enum Constant and Description
BI_DIRECTIONAL_BUFFERED20 4.
BI_DIRECTIONAL_BUFFERED21_BUFFERED20 5.
BI_DIRECTIONAL_NOT_BUFFERED20 3.
DIRECTIONAL_BUFFERED21 2.
DIRECTIONAL_NOT_BUFFERED21 1.
NONE 0.

Field Summary

Fields

Modifier and Type	Field and Description
static PIPType[]	values

Method Summary

Modifier and Type	Method and Description
static String	getArrow(PIPType type) Gets the arrow string representation from the PIP type.
static PIPType	getTypeFromArrow(String arrow) Gets the PIP type from the arrow string.
boolean	isBidirectional() Checks if the PIP type is bi-directional
static PIPType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PIPType[]	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

NONE

public static final PIPType NONE

0. Not a PIP

DIRECTIONAL_NOT_BUFFERED21

public static final PIPType DIRECTIONAL_NOT_BUFFERED21

1. ->

DIRECTIONAL_BUFFERED21

public static final PIPType DIRECTIONAL_BUFFERED21

2. ->>

BI_DIRECTIONAL_NOT_BUFFERED20

public static final PIPType BI_DIRECTIONAL_NOT_BUFFERED20

3. <->

BI_DIRECTIONAL_BUFFERED20

public static final PIPType BI_DIRECTIONAL_BUFFERED20

4. <<->

BI_DIRECTIONAL_BUFFERED21_BUFFERED20

public static final PIPType BI_DIRECTIONAL_BUFFERED21_BUFFERED20

5. <<->>

Field Detail

values

public static final PIPType[] values

Method Detail

values

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

Returns:

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

valueOf

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

getArrow

public static String getArrow(PIPType type)

Gets the arrow string representation from the PIP type.

Parameters:

type - The type of interest.

Returns:

The String representation of the PIP type.

Since:

2018.2.0

getTypeFromArrow

public static PIPType getTypeFromArrow(String arrow)

Gets the PIP type from the arrow string. See also @link PIPType.getArrow(PIPType).

Parameters:

arrow - The PIP arrow string of interest

Returns:

The PIP type represented by the arrow string

Since:

2018.2.0

isBidirectional

public boolean isBidirectional()

Checks if the PIP type is bi-directional

Returns:

True if PIP type is bi-directional, false otherwise.

Since:

2018.2.0