com.xilinx.rapidwright.bitstream

Enum PacketType

Object

Enum<PacketType>

com.xilinx.rapidwright.bitstream.PacketType

All Implemented Interfaces:

Serializable, Comparable<PacketType>

public enum PacketType
extends Enum<PacketType>

Enumeration of the packet type field as specified in the frame address register field.

Since:

2020.2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE
RESERVED
TWO

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE1_WORD_COUNT_MASK Packet Type 1 Word Count [10:0]
static int	TYPE2_WORD_COUNT_MASK Packet Type 2 Word Count [26:0]
static PacketType[]	values A static final (cached) copy of values()

Method Summary

Modifier and Type	Method and Description
int	getHeaderValue() Gets the packet header representation for this packet type
int	getMaxNumWords() Gets the maximum number of words that can exist in the payload of this packet type.
static PacketType	getPacketType(int header) Gets the packet type from a 32-bit packet header
int	getWordCountMask() Gets the bit mask for the word count field for packets of this type.
static PacketType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PacketType[]	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

ONE

public static final PacketType ONE

TWO

public static final PacketType TWO

RESERVED

public static final PacketType RESERVED

Field Detail

TYPE1_WORD_COUNT_MASK

public static int TYPE1_WORD_COUNT_MASK

Packet Type 1 Word Count [10:0]

Since:

2020.2.1

TYPE2_WORD_COUNT_MASK

public static int TYPE2_WORD_COUNT_MASK

Packet Type 2 Word Count [26:0]

Since:

2020.2.1

values

public static final PacketType[] values

A static final (cached) copy of values()

Since:

2021.2.2

Method Detail

values

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

Returns:

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

valueOf

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

getMaxNumWords

public int getMaxNumWords()

Gets the maximum number of words that can exist in the payload of this packet type.

Returns:

Max number of 32-bit words that can fit in a packet of this type.

Since:

2020.2.1

getWordCountMask

public int getWordCountMask()

Gets the bit mask for the word count field for packets of this type.

Returns:

Bit mask of the word count field.

Since:

2020.2.1

getPacketType

public static PacketType getPacketType(int header)

Gets the packet type from a 32-bit packet header

Parameters:

header - The packet header of interest

Returns:

The packet type based on the provided header.

Since:

2020.2.1

getHeaderValue

public int getHeaderValue()

Gets the packet header representation for this packet type

Returns:

The packet header representation for this packet type

Since:

2020.2.1