edu.wisc.ssec.mcidasv.data

Class McIdasFrame

java.lang.Object

edu.wisc.ssec.mcidasv.data.McIdasFrame

public class McIdasFrame
extends Object

Class to hold McIDAS-X frame data sets.

Field Summary

Fields

Modifier and Type	Field and Description
private ColorTable	myColorTable
private int	myElementSize
private FrameDirectory	myFrameDirectory
private int	myFrameNumber frame data
private byte[]	myGraphics
private byte[]	myImage
private int	myLineSize Keep local copies of everything so we don't have to go back over the bridge unless asked to refresh
private McIdasXFrameInfo	myXFrameInfo

Constructor Summary

Constructors

Constructor and Description
McIdasFrame() Empty constructor for XML encoding
McIdasFrame(int frameNumber, McIdasXInfo xInfo) Construct a new McIdasFrame from the given frame number

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) See if this McIdasFrame is equal to the object in question.
ColorTable	getColorTable(boolean refresh) Returns ColorTable used by myXFrameInfo.
int	getElementSize(boolean refresh) Returns element size.
FrameDirectory	getFrameDirectory(boolean refresh) Returns frame directory.
int	getFrameNumber() Returns frame number.
Image	getGIF() Returns image data as GIF.
byte[]	getGraphicsData(boolean refresh) Returns graphics data.
byte[]	getImageData(boolean refresh) Returns image data.
int	getLineSize(boolean refresh) Returns line size.
void	setRefreshData(boolean refresh) Tell myXFrameInfo to refresh the cached data.
String	toString() Get a String representation of this object

Methods inherited from class java.lang.Object

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

Field Detail

myFrameNumber

private int myFrameNumber

frame data

myXFrameInfo

private McIdasXFrameInfo myXFrameInfo

myLineSize

private int myLineSize

Keep local copies of everything so we don't have to go back over the bridge unless asked to refresh

myElementSize

private int myElementSize

myFrameDirectory

private FrameDirectory myFrameDirectory

myColorTable

private ColorTable myColorTable

myImage

private byte[] myImage

myGraphics

private byte[] myGraphics

Constructor Detail

McIdasFrame

public McIdasFrame()

Empty constructor for XML encoding

McIdasFrame

public McIdasFrame(int frameNumber,
                   McIdasXInfo xInfo)

Construct a new McIdasFrame from the given frame number

Parameters:

frameNumber - Frame number.

xInfo - State of McIDAS-X session.

Method Detail

getFrameNumber

public int getFrameNumber()

Returns frame number.

Returns:

myFrameNumber.

setRefreshData

public void setRefreshData(boolean refresh)

Tell myXFrameInfo to refresh the cached data.

Parameters:

refresh - Whether or not to refresh cached data.

getLineSize

public int getLineSize(boolean refresh)

Returns line size.

Parameters:

refresh - Whether or not to refresh myLineSize.

Returns:

myLineSize.

getElementSize

public int getElementSize(boolean refresh)

Returns element size.

Parameters:

refresh - Whether or not myElementSize should be refreshed.

Returns:

myElementSize.

getFrameDirectory

public FrameDirectory getFrameDirectory(boolean refresh)

Returns frame directory.

Parameters:

refresh - Whether or not myFrameDirectory should be refreshed.

Returns:

myFrameDirectory.

getColorTable

public ColorTable getColorTable(boolean refresh)

Returns ColorTable used by myXFrameInfo.

Parameters:

refresh - Whether or not myColorTable should be refreshed.

Returns:

myColorTable.

getImageData

public byte[] getImageData(boolean refresh)

Returns image data.

Parameters:

refresh - Whether or not myImage should be refreshed.

Returns:

myImage.

getGraphicsData

public byte[] getGraphicsData(boolean refresh)

Returns graphics data.

Parameters:

refresh - Whether or not myGraphics should be refreshed.

Returns:

myGraphics.

getGIF

public Image getGIF()

Returns image data as GIF.

Returns:

myXFrameInfo in GIF format.

equals

public boolean equals(Object o)

See if this McIdasFrame is equal to the object in question.

Overrides:

equals in class Object

Parameters:

o - Object in question.

Returns:

true if o is a McIdasFrame and they area equivalent.

toString

public String toString()

Get a String representation of this object

Overrides:

toString in class Object

Returns:

a string representation