sortie.data.funcgroups.Subplot Class Reference

This rolls up a set of cell coordinates into a defined subplot. More...

Public Member Functions
	Subplot (String sName, float fXCellLength, float fYCellLength)
	Constructor. More...
void	addCell (int iX, int iY, Plot oPlot) throws ModelException
	Adds a grid cell to this subplot. More...
void	addCell (Cell oCell)
	Adds a grid cell to this subplot. More...
int	getNumberOfCells ()
	Gets the number of cells in this subplot. More...
String	getSubplotName ()
	Gets the subplot's name. More...
Cell	getCell (int iIndex)
	Gets the cell at a particular index. More...
void	removeCell (int iIndex)
	Removes a cell from the harvest cut range's area. More...

Private Attributes
String	m_sName
	Subplot name. More...
ArrayList< Cell >	mp_oCells = new ArrayList<Cell>(0)
	List of cells that make up the subplot. More...
float	m_fXCellLength
	Cell length in the X direction, in meters. More...
float	m_fYCellLength
	Cell length in the Y direction, in meters. More...

Detailed Description

This rolls up a set of cell coordinates into a defined subplot.

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

Subplot()

sortie.data.funcgroups.Subplot.Subplot	(	String	sName,
		float	fXCellLength,
		float	fYCellLength
	)

Constructor.

Parameters

sName	Name of the subplot
fXCellLength	Cell length in the X direction, in meters.
fYCellLength	Cell length in the Y direction, in meters.

Member Function Documentation

addCell() [1/2]

void sortie.data.funcgroups.Subplot.addCell	(	int	iX,
		int	iY,
		Plot	oPlot
	)		throws ModelException

Adds a grid cell to this subplot.

If it is a duplicate, it is not added.

Parameters

iX	X grid cell coordinate
iY	Y grid cell coordinate
oPlot	Plot object

Exceptions

ModelException

if the grid cell coordinate is invalid

addCell() [2/2]

void sortie.data.funcgroups.Subplot.addCell

(

Cell

oCell

)

Adds a grid cell to this subplot.

If it is a duplicate, it is not added.

Parameters

oCell

Cell to add.

getCell()

Cell sortie.data.funcgroups.Subplot.getCell

(

int

iIndex

)

Gets the cell at a particular index.

If the index is invalid, returns null.

Parameters

iIndex

Index of the cell.

Returns

Cell.

getNumberOfCells()

int sortie.data.funcgroups.Subplot.getNumberOfCells

(

)

Gets the number of cells in this subplot.

Returns

The number of cells.

getSubplotName()

String sortie.data.funcgroups.Subplot.getSubplotName

(

)

Gets the subplot's name.

Returns

The subplot's name.

removeCell()

void sortie.data.funcgroups.Subplot.removeCell

(

int

iIndex

)

Removes a cell from the harvest cut range's area.

Parameters

iIndex

int Cell index. Invalid values are ignored.

Member Data Documentation

m_fXCellLength

float sortie.data.funcgroups.Subplot.m_fXCellLength

private

Cell length in the X direction, in meters.

m_fYCellLength

float sortie.data.funcgroups.Subplot.m_fYCellLength

private

Cell length in the Y direction, in meters.

m_sName

String sortie.data.funcgroups.Subplot.m_sName

private

Subplot name.

mp_oCells

ArrayList<Cell> sortie.data.funcgroups.Subplot.mp_oCells = new ArrayList<Cell>(0)

private

List of cells that make up the subplot.

---

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

• Subplot.java