Package hec.gfx2d.profilePlot

Class ProfileDataG2dObject

java.lang.Object

java.util.Observable

hec.gfx2d.G2dData

hec.gfx2d.profilePlot.ProfileDataG2dObject

All Implemented Interfaces:

G2dObject, Serializable

public class ProfileDataG2dObject
extends G2dData

The Class ProfileDataG2dObject encapsulates a ProfileDataRecord plotting in a G2dDialog (AnimatedProfileG2dDialog). A ProfileDataRecord contains a series of x-y data arrays for plotting (vertical) profile data with animation.

See Also:

• ProfileDataRecords
• AnimatedProfileG2dDialog
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected WorldRect	_bounds	The WorldRect _bounds.
protected String	_name	The name.
protected String	_parameter	The String _parameter.
protected float[]	_profx	The float array _profx.
protected float[]	_profy	The float array_profy.
protected ProfileDataRecords	_rec	The ProfileDataRecord _rec.
protected String	_runName	The run name.

Fields inherited from class hec.gfx2d.G2dData

_lookup, bounds, lineStyleName, name, xunits, yunits

Fields inherited from interface hec.gfx2d.G2dObject

RESET_DATA, UPDATE_DATA

Constructor Summary

Constructors

Constructor	Description
ProfileDataG2dObject(ProfileDataRecords rec, String runName)	Instantiates a new profile data g2d object.
ProfileDataG2dObject(ProfileDataRecords rec, String runName, int timeStepStart)	Instantiates a new profile data g2d object.

Method Summary

Modifier and Type	Method	Description
WorldRect	getBounds()	Returns the extents of the object in world coordinates.
float[]	getHorizArray()	Gets the horizontal array.
String	getName()	Returns the name of the object.
List	getParameterNames()	Gets the parameter names.
int	getRecordCount()	Gets the record count.
List<Integer>	getTimeList()
String	getTimeStep()	Gets the time step.
float[]	getVertArray()	Gets the vertical values in an array.
String	getXAxisName()	Returns the name of the x axis.
int	getXAxisType()	Returns the name of the x axis.
void	getXData(int istep)	Gets the x data.
int	getXParameterId()
String	getYAxisName()	Returns the name of the y axis.
int	getYAxisType()	Returns the name of the y axis.
void	getYData(int istep, String parameter)	Gets the y data.
int	getYParameterId()
void	load()	Causes the object to load its data into memory.
void	setName(String name)
void	unload()	Causes the object to unload its data from memory.

Methods inherited from class hec.gfx2d.G2dData

addObserver, canSwapXYValues, getCurveCount, getDefaultMaxYValue, getDefaultMinYValue, getGmtOffset, getLineStyleName, getLookup, getUnitSystem, getXValues, getYValues, hasDefaultMaxYValue, hasDefaultMinYValue, setDefaultMaxYValue, setDefaultMinYValue, setGmtOffset, setSwapXYValues, setUnitSystem, setUseDisplayUnits, setXParameterId, setYParameterId, swapXYValues, toString, useDisplayUnits

Methods inherited from class java.util.Observable

clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface hec.gfx2d.G2dObject

getDataZoneId

Field Details

_rec

protected ProfileDataRecords _rec

The ProfileDataRecord _rec.

_profx

protected float[] _profx

The float array _profx.

_profy

protected float[] _profy

The float array_profy.

_bounds

protected WorldRect _bounds

The WorldRect _bounds.

_parameter

protected String _parameter

The String _parameter.

_runName

protected String _runName

The run name.

_name

protected String _name

The name.

Constructor Details

ProfileDataG2dObject

public ProfileDataG2dObject(ProfileDataRecords rec,
 String runName)

Instantiates a new profile data g2d object.

Parameters:

rec - the ProfileDataRecord

runName - the String run name

ProfileDataG2dObject

public ProfileDataG2dObject(ProfileDataRecords rec,
 String runName,
 int timeStepStart)

Instantiates a new profile data g2d object.

Parameters:

rec - the ProfileDataRecord

runName - the String run name

Method Details

getParameterNames

public List getParameterNames()

Gets the parameter names.

Returns:

the List of parameter names

getTimeList

public List<Integer> getTimeList()

getRecordCount

public int getRecordCount()

Gets the record count.

Returns:

the int record count

getHorizArray

public float[] getHorizArray()

Gets the horizontal array.

Returns:

the float[] of horizontal

getVertArray

public float[] getVertArray()

Gets the vertical values in an array.

Returns:

the vertical float values in an array

getYData

public void getYData(int istep,
 String parameter)

Gets the y data.

Parameters:

istep - the time step

parameter - the parameter string

getXData

public void getXData(int istep)

Gets the x data.

Parameters:

istep - the time step

getTimeStep

public String getTimeStep()

Gets the time step.

Returns:

the time step string

getName

public String getName()

Returns the name of the object.

Specified by:

getName in interface G2dObject

Overrides:

getName in class G2dData

Returns:

the name string

setName

public void setName(String name)

Overrides:

setName in class G2dData

getXAxisName

public String getXAxisName()

Returns the name of the x axis.

Returns:

the x axis name

getYAxisName

public String getYAxisName()

Returns the name of the y axis.

Returns:

the y axis name

getXAxisType

public int getXAxisType()

Returns the name of the x axis.

Returns:

the x axis type

getYAxisType

public int getYAxisType()

Returns the name of the y axis.

Returns:

the y axis type

getXParameterId

public int getXParameterId()

Specified by:

getXParameterId in interface G2dObject

Overrides:

getXParameterId in class G2dData

getYParameterId

public int getYParameterId()

Specified by:

getYParameterId in interface G2dObject

Overrides:

getYParameterId in class G2dData

load

public void load()

Causes the object to load its data into memory.

unload

public void unload()

Causes the object to unload its data from memory.

getBounds

public WorldRect getBounds()

Returns the extents of the object in world coordinates.

Specified by:

getBounds in interface G2dObject

Specified by:

getBounds in class G2dData

Returns:

the WorldRect bounds