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. More...
float	getYCellLength ()
	Get the cell length in the Y direction. More...
	Cell (int iX, int iY, Plot oPlot) throws ModelException
	Constructor. More...
	Cell (int iX, int iY, float fXCellLength, float fYCellLength, Plot oPlot) throws ModelException
	Constructor. More...
int	getX ()
	Gets the X cell coordinate. More...
int	getY ()
	Gets the Y cell coordinate. More...
Object	clone ()

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

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

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

Cell() [1/3]

sortie.data.simpletypes.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

Cell() [2/3]

sortie.data.simpletypes.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

Cell() [3/3]

sortie.data.simpletypes.Cell.Cell ( int  iX, int  iY, float  fXCellLength, float  fYCellLength  )

private

Private constructor for cloning.

Parameters

iX	X cell coordinate
iY	Y cell coordinate
fXCellLength	Cell X length, in m
fYCellLength	Cell Y length, in m

Member Function Documentation

clone()

Object sortie.data.simpletypes.Cell.clone

(

)

getX()

int sortie.data.simpletypes.Cell.getX

(

)

Gets the X cell coordinate.

Returns

X cell coordinate.

getXCellLength()

float sortie.data.simpletypes.Cell.getXCellLength

(

)

Get the cell length in the X direction.

Returns

Cell length.

getY()

int sortie.data.simpletypes.Cell.getY

(

)

Gets the Y cell coordinate.

Returns

Y cell coordinate.

getYCellLength()

float sortie.data.simpletypes.Cell.getYCellLength

(

)

Get the cell length in the Y direction.

Returns

Cell length.

Member Data Documentation

m_fXCellLength

float sortie.data.simpletypes.Cell.m_fXCellLength

protected

Length of cell in X direction.

m_iX

int sortie.data.simpletypes.Cell.m_iX

protected

Cell X coordinate.

---

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

• Cell.java