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.


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)


Constructor & Destructor Documentation

javawrapper::Subplot::Subplot ( String  sName  )  [inline]

Constructor.

Parameters:
sName Name of the subplot

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

void javawrapper::Subplot::AddCell ( int  iX,
int  iY,
Plot  oPlot 
) throws ModelException [inline]

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

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Subplot::AddCell ( Cell  oCell  )  [inline]

Adds a grid cell to this subplot.

If it is a duplicate, it is not added.

Parameters:
oCell Cell to add.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

int javawrapper::Subplot::GetNumberOfCells (  )  [inline]

Gets the number of cells in this subplot.

Returns:
The number of cells.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

String javawrapper::Subplot::GetSubplotName (  )  [inline]

Gets the subplot's name.

Returns:
The subplot's name.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Cell javawrapper::Subplot::GetCell ( int  iIndex  )  [inline]

Gets the cell at a particular index.

If the index is invalid, returns null.

Parameters:
iIndex Index of the cell.
Returns:
Cell.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Subplot::RemoveCell ( int  iIndex  )  [inline]

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

Parameters:
iIndex int Cell index. Invalid values are ignored.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:55 2007 for SORTIE Java Interface by  doxygen 1.5.2