byucc.jhdl.platforms.util.readback.Xilinx.Virtex2
Class RBLocation

java.lang.Object
  byucc.jhdl.platforms.util.readback.Xilinx.Virtex2.RBLocation

public class RBLocation

extends java.lang.Object

This class is used to keep track of the location of a symbol (flip-flop or RAM) in the readback bitstream. This is mainly used by Virtex2ToJHDLSyms and RBSym objects.

Author:

Paul Graham

Field Summary

int	frame Holds the readback bitstream frame number.
int	frameOffset Holds the readback bitstream frame offset.
int	offset Holds the readback bitstream absolute offset.

Constructor Summary

RBLocation()
Constructs an object, setting the frame and frameOffset to the illegal values of -1

RBLocation(int newFrame, int newFrameOffset)
Deprecated. See RBLocation(int,int,int)

RBLocation(int newOffset, int newFrame, int newFrameOffset)
Constructs an object by directly setting the frame and frame offset based on its parameters.

RBLocation(RBLocation rbloc)
Constructs an object, copying the values of an existing RBLocation object to the new object.

Method Summary

void	setLocation(int newFrame, int newFrameOffset) Deprecated. See setLocation(int,int,int)
void	setLocation(int newOffset, int newFrame, int newFrameOffset) Sets the frame and frame offset based on its parameters.
java.lang.String	toString() Returns a String describing the frame and frame offset for a bit in the readback bitstream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

offset

public int offset

Holds the readback bitstream absolute offset.

frame

public int frame

Holds the readback bitstream frame number.

frameOffset

public int frameOffset

Holds the readback bitstream frame offset.

Constructor Detail

RBLocation

public RBLocation()

Constructs an object, setting the frame and frameOffset to the illegal values of -1

RBLocation

public RBLocation(RBLocation rbloc)

Constructs an object, copying the values of an existing RBLocation object to the new object.

Parameters:

rbloc - The RBLocation object to copy.

RBLocation

public RBLocation(int newFrame,
                  int newFrameOffset)

Deprecated. See RBLocation(int,int,int)

Constructs an object by directly setting the frame and frame offset based on its parameters.

Parameters:

newFrame - An integer representing the frame number for a bit in the readback bitstream.

newFrameOffset - An integer representing the frame offset for a bit in the readback bitstream.

RBLocation

public RBLocation(int newOffset,
                  int newFrame,
                  int newFrameOffset)

Constructs an object by directly setting the frame and frame offset based on its parameters.

Parameters:

newFrame - An integer representing the absolute offset for a bit in the readback bitstream.

newFrameOffset - An integer representing the frame offset for a bit in the readback bitstream.

Method Detail

setLocation

public void setLocation(int newFrame,
                        int newFrameOffset)

Deprecated. See setLocation(int,int,int)

Sets the frame and frame offset based on its parameters.

Parameters:

newFrame - An integer representing the frame number for a bit in the readback bitstream.

newFrameOffset - An integer representing the frame offset for a bit in the readback bitstream.

setLocation

public void setLocation(int newOffset,
                        int newFrame,
                        int newFrameOffset)

Sets the frame and frame offset based on its parameters.

Parameters:

newOffset - An integer representing the absolute offset for a bit in the readback bitstream.

newFrame - An integer representing the frame number for a bit in the readback bitstream.

newFrameOffset - An integer representing the frame offset for a bit in the readback bitstream.

toString

public java.lang.String toString()

Returns a String describing the frame and frame offset for a bit in the readback bitstream.

Returns:

A String describing the frame and frame offset for a bit in the readback bitstream.