javawrapper.Subplot Class Reference

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

List of all members.

Public Member Functions

 Subplot (String sName)
 Constructor.
void AddCell (int iX, int iY, Plot oPlot) throws ModelException
 Adds a grid cell to this subplot.
void AddCell (Cell oCell)
 Adds a grid cell to this subplot.
int GetNumberOfCells ()
 Gets the number of cells in this subplot.
String GetSubplotName ()
 Gets the subplot's name.
Cell GetCell (int iIndex)
 Gets the cell at a particular index.
void RemoveCell (int iIndex)
 Removes a cell from the harvest cut range's area.

Private Attributes

String m_sName
 Subplot name.
Vector< Cellmp_oCells = new Vector<Cell>(0)
 List of cells that make up the subplot.


Detailed Description

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

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.Subplot.Subplot ( String  sName  ) 

Constructor.

Parameters:
sName Name of the subplot


Member Function Documentation

void javawrapper.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

void javawrapper.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.

int javawrapper.Subplot.GetNumberOfCells (  ) 

Gets the number of cells in this subplot.

Returns:
The number of cells.

String javawrapper.Subplot.GetSubplotName (  ) 

Gets the subplot's name.

Returns:
The subplot's name.

Cell javawrapper.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.

void javawrapper.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

String javawrapper.Subplot.m_sName [private]

Subplot name.

Vector<Cell> javawrapper.Subplot.mp_oCells = new Vector<Cell>(0) [private]

List of cells that make up the subplot.


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

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