com.xilinx.rapidwright.bitstream

Class BitLocation

Object

com.xilinx.rapidwright.bitstream.BitLocation

public class BitLocation
extends Object

Stores the unique information to identify a configuration bit location.

Since:

2020.2.1

Constructor Summary

Constructors

Constructor and Description
BitLocation(int frameIdx, int bitIdx) Constructs a new bit location - an object that will uniquely identify a bit within a configuration block.
BitLocation(int frameIdx, int bitIdx, boolean isInverted) Constructs a new bit location - an object that will uniquely identify a bit within a configuration block.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks if this is equal to another bit location, bit index, frame index and the inverted flag must all be equal to get true.
int	getBitIdx() Gets the bit index (index within the configuration frame)
int	getFrameIdx() Gets the frame index (index of the frame within the configuration Block)
int	hashCode() Provides a hash composed of the bit index, frame index and inverted flag.
boolean	isInverted() Checks if the inverted flag is set
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BitLocation

public BitLocation(int frameIdx,
                   int bitIdx)

Constructs a new bit location - an object that will uniquely identify a bit within a configuration block.

Parameters:

frameIdx - Index of the frame within a block

bitIdx - Index of the bit within the frame

Since:

2020.2.1

BitLocation

public BitLocation(int frameIdx,
                   int bitIdx,
                   boolean isInverted)

Constructs a new bit location - an object that will uniquely identify a bit within a configuration block.

Parameters:

frameIdx - Index of the frame within a block

bitIdx - Index of the bit within the frame

isInverted - Flag indicating if the bit is inverted

Since:

2020.2.1

Method Detail

getFrameIdx

public int getFrameIdx()

Gets the frame index (index of the frame within the configuration Block)

Returns:

Frame index

Since:

2020.2.1

getBitIdx

public int getBitIdx()

Gets the bit index (index within the configuration frame)

Returns:

Bit index

Since:

2020.2.1

isInverted

public boolean isInverted()

Checks if the inverted flag is set

Returns:

True if the bit referenced is inverted, false otherwise.

Since:

2020.2.1

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Provides a hash composed of the bit index, frame index and inverted flag.

Overrides:

hashCode in class Object

Since:

2023.1.3

equals

public boolean equals(Object obj)

Checks if this is equal to another bit location, bit index, frame index and the inverted flag must all be equal to get true.

Overrides:

equals in class Object

Since:

2023.1.3