SORTIE Java Interface  1
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
sortie.data.simpletypes.Cell Class Reference

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

Public Member Functions

float getXCellLength ()
 Get the cell length in the X direction.
 
float getYCellLength ()
 Get the cell length in the Y direction.
 
 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.
 
Object clone ()
 

Protected Attributes

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

Private Member Functions

 Cell (int iX, int iY, float fXCellLength, float fYCellLength)
 Private constructor for cloning.
 

Detailed Description

This class holds a set of grid cell coordinates.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary 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

sortie.data.simpletypes.Cell.Cell ( int  iX,
int  iY,
Plot  oPlot 
) throws ModelException

Constructor.

Parameters
iXX cell coordinate
iYY cell coordinate
oPlotPlot object
Exceptions
ModelExceptionif the cell coordinates are invalid
sortie.data.simpletypes.Cell.Cell ( int  iX,
int  iY,
float  fXCellLength,
float  fYCellLength,
Plot  oPlot 
) throws ModelException

Constructor.

Parameters
iXX cell coordinate
iYY cell coordinate
fXCellLengthCell X length, in m
fYCellLengthCell Y length, in m
oPlotPlot object
Exceptions
ModelExceptionif the cell coordinates are invalid
sortie.data.simpletypes.Cell.Cell ( int  iX,
int  iY,
float  fXCellLength,
float  fYCellLength 
)
private

Private constructor for cloning.

Parameters
iXX cell coordinate
iYY cell coordinate
fXCellLengthCell X length, in m
fYCellLengthCell Y length, in m

Member Function Documentation

Object sortie.data.simpletypes.Cell.clone ( )
int sortie.data.simpletypes.Cell.getX ( )

Gets the X cell coordinate.

Returns
X cell coordinate.
float sortie.data.simpletypes.Cell.getXCellLength ( )

Get the cell length in the X direction.

Returns
Cell length.
int sortie.data.simpletypes.Cell.getY ( )

Gets the Y cell coordinate.

Returns
Y cell coordinate.
float sortie.data.simpletypes.Cell.getYCellLength ( )

Get the cell length in the Y direction.

Returns
Cell length.

Member Data Documentation

float sortie.data.simpletypes.Cell.m_fXCellLength
protected

Length of cell in X direction.

int sortie.data.simpletypes.Cell.m_iX
protected

Cell X coordinate.


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