javawrapper.Cell Class Reference

This class holds a set of grid cell coordinates. More...

List of all members.

Public Member Functions

 Cell (int iX, int iY, Plot oPlot) throws ModelException
 Constructor.
 Cell (int iX, int iY, float fXCellLength, float fYCellLength, Plot oPlot) throws ModelException
 Constructor.
int GetX ()
 Gets the X cell coordinate.
int GetY ()
 Gets the Y cell coordinate.

Static Public Member Functions

static Cell[] TransformOldGridCell (int iOldGridCell, float fOldXGridLength, float fOldYGridLength, int iNumOldXGrids, int iNumOldYGrids, Plot oPlot) throws ModelException
 Transforms an old grid cell number into its equivalent new grid cells.

Protected Attributes

float m_fXCellLength
 Length of cell in X direction.
float m_fYCellLength
 Length of cell in Y direction.
int m_iX
 Cell X coordinate.
int m_iY
 Cell Y coordinate.


Detailed Description

This class holds a set of grid cell coordinates.

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)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.Cell.Cell ( int  iX,
int  iY,
Plot  oPlot 
) throws ModelException

Constructor.

Parameters:
iX X cell coordinate
iY Y cell coordinate
oPlot Plot object
Exceptions:
ModelException if the cell coordinates are invalid

javawrapper.Cell.Cell ( int  iX,
int  iY,
float  fXCellLength,
float  fYCellLength,
Plot  oPlot 
) throws ModelException

Constructor.

Parameters:
iX X cell coordinate
iY Y cell coordinate
fXCellLength Cell X length, in m
fYCellLength Cell Y length, in m
oPlot Plot object
Exceptions:
ModelException if the cell coordinates are invalid


Member Function Documentation

int javawrapper.Cell.GetX (  ) 

Gets the X cell coordinate.

Returns:
X cell coordinate.

int javawrapper.Cell.GetY (  ) 

Gets the Y cell coordinate.

Returns:
Y cell coordinate.

static Cell [] javawrapper.Cell.TransformOldGridCell ( int  iOldGridCell,
float  fOldXGridLength,
float  fOldYGridLength,
int  iNumOldXGrids,
int  iNumOldYGrids,
Plot  oPlot 
) throws ModelException [static]

Transforms an old grid cell number into its equivalent new grid cells.

A strict one-to-one areal overlap cannot be guaranteed unless the old and new grid cells are the same size. The list of new cells covers completely all the area of the old cell, with overlap as needed to ensure the original area is completely covered.

Parameters:
iOldGridCell The old grid cell number.
fOldXGridLength The length of X grids, in the old coordinate system.
fOldYGridLength The length of Y grids, in the old coordinate system.
iNumOldXGrids Number of grid cells in the X direction, in the old coordinate system.
iNumOldYGrids Number of grid cells in the Y direction, in the old coordinate system.
oPlot Plot object.
Returns:
An array of Cell objects which covers the original grid cell's area, or null if no equivalent list could be created.
Exceptions:
ModelException Passing through other underlying exceptions.


Member Data Documentation

Length of cell in X direction.

Length of cell in Y direction.

int javawrapper.Cell.m_iX [protected]

Cell X coordinate.

int javawrapper.Cell.m_iY [protected]

Cell Y coordinate.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:37 2011 for SORTIE Java Interface by  doxygen 1.5.6