com.xilinx.rapidwright.bitstream

Enum BlockType

Object

Enum<BlockType>

com.xilinx.rapidwright.bitstream.BlockType

All Implemented Interfaces:

Serializable, Comparable<BlockType>

public enum BlockType
extends Enum<BlockType>

Enumeration of the configuration block types as specified in the Frame Address Register fields.

Since:

2020.2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRAM_CONTENT
CLB
CLB_CFG
RESERVED_3
RESERVED_4
RESERVED_5
RESERVED_6
RESERVED_7

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPICAL_BLOCK_TYPE_COUNT Most bitstreams will have a typical block type count of this amount
static BlockType[]	values A static final (cached) copy of values()

Method Summary

Modifier and Type	Method and Description
int	getBlockTypeEncoding() Gets the integer block type value (as stored in the Frame Address Register) of this block type.
static BlockType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlockType[]	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

CLB

public static final BlockType CLB

BRAM_CONTENT

public static final BlockType BRAM_CONTENT

CLB_CFG

public static final BlockType CLB_CFG

RESERVED_3

public static final BlockType RESERVED_3

RESERVED_4

public static final BlockType RESERVED_4

RESERVED_5

public static final BlockType RESERVED_5

RESERVED_6

public static final BlockType RESERVED_6

RESERVED_7

public static final BlockType RESERVED_7

Field Detail

values

public static final BlockType[] values

A static final (cached) copy of values()

Since:

2021.2.2

TYPICAL_BLOCK_TYPE_COUNT

public static final int TYPICAL_BLOCK_TYPE_COUNT

Most bitstreams will have a typical block type count of this amount

Since:

2020.2.1

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getBlockTypeEncoding

public int getBlockTypeEncoding()

Gets the integer block type value (as stored in the Frame Address Register) of this block type.

Returns:

The integer value of this block type.

Since:

2020.2.1