javawrapper::GridValue Class Reference

Class for holding the data for a single grid cell. More...

Inheritance diagram for javawrapper::GridValue:

javawrapper::DataMemberData List of all members.

Public Member Functions

Cell GetCell ()
 Gets the cell for this object.
void AddPackage (PackageGridValue oPackage)
 Adds a package to this grid cell.
void WriteXML (BufferedWriter oOut) throws java.io.IOException
 Writes this grid's data to XML.

Protected Attributes

Cell m_oCell
 Grid cell.
Vector mp_oPackages = new Vector(0)
 Vector of PackageGridValue objects.

Package Functions

 GridValue (int iX, int iY, int iNumFloats, int iNumInts, int iNumChars, int iNumBools, Plot oPlot) throws ModelException
 Constructor.
 GridValue (int iX, int iY, int iNumFloats, int iNumInts, int iNumChars, int iNumBools, float fLengthXCells, float fLengthYCells, Plot oPlot) throws ModelException
 Constructor.

Detailed Description

Class for holding the data for a single grid cell.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Constructor & Destructor Documentation

javawrapper::GridValue::GridValue int  iX,
int  iY,
int  iNumFloats,
int  iNumInts,
int  iNumChars,
int  iNumBools,
Plot  oPlot
throws ModelException [inline, package]
 

Constructor.

Parameters:
iX X cell coordinate.
iY Y cell coordinate.
iNumFloats Number of float data members.
iNumInts Number of integer data members.
iNumChars Number of char data members.
iNumBools Number of bool data members.
oPlot Plot object.
Exceptions:
ModelException if cell coordinates are invalid.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

javawrapper::GridValue::GridValue int  iX,
int  iY,
int  iNumFloats,
int  iNumInts,
int  iNumChars,
int  iNumBools,
float  fLengthXCells,
float  fLengthYCells,
Plot  oPlot
throws ModelException [inline, package]
 

Constructor.

Parameters:
iX X cell coordinate.
iY Y cell coordinate.
iNumFloats Number of float data members.
iNumInts Number of integer data members.
iNumChars Number of char data members.
iNumBools Number of bool data members.
fLengthXCells Length of cell in X direction.
fLengthYCells Length of cell in Y direction.
oPlot Plot object.
Exceptions:
ModelException if cell coordinates are invalid.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

void javawrapper::GridValue::AddPackage PackageGridValue  oPackage  )  [inline]
 

Adds a package to this grid cell.

Parameters:
oPackage Package to add.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Cell javawrapper::GridValue::GetCell  )  [inline]
 

Gets the cell for this object.

Returns:
Cell object.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::GridValue::WriteXML BufferedWriter  oOut  )  throws java.io.IOException [inline]
 

Writes this grid's data to XML.

Parameters:
oOut File to write to.
Exceptions:
java.io.IOException if there is a problem writing to file.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:39 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO