|
SORTIE Java Interface
1
|
This rolls up a set of cell coordinates into a defined subplot. More...
Public Member Functions | |
| Subplot (String sName, float fXCellLength, float fYCellLength) | |
| 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< Cell > | mp_oCells = new Vector<Cell>(0) |
| List of cells that make up the subplot. | |
| float | m_fXCellLength |
| Cell length in the X direction, in meters. | |
| float | m_fYCellLength |
| Cell length in the Y direction, in meters. | |
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
Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)
| sortie.data.funcgroups.Subplot.Subplot | ( | String | sName, |
| float | fXCellLength, | ||
| float | fYCellLength | ||
| ) |
Constructor.
| sName | Name of the subplot |
| fXCellLength | Cell length in the X direction, in meters. |
| fYCellLength | Cell length in the Y direction, in meters. |
| 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.
| iX | X grid cell coordinate |
| iY | Y grid cell coordinate |
| oPlot | Plot object |
| ModelException | if the grid cell coordinate is invalid |
| void sortie.data.funcgroups.Subplot.addCell | ( | Cell | oCell | ) |
Adds a grid cell to this subplot.
If it is a duplicate, it is not added.
| oCell | Cell to add. |
| Cell sortie.data.funcgroups.Subplot.getCell | ( | int | iIndex | ) |
Gets the cell at a particular index.
If the index is invalid, returns null.
| iIndex | Index of the cell. |
| int sortie.data.funcgroups.Subplot.getNumberOfCells | ( | ) |
Gets the number of cells in this subplot.
| String sortie.data.funcgroups.Subplot.getSubplotName | ( | ) |
Gets the subplot's name.
| void sortie.data.funcgroups.Subplot.removeCell | ( | int | iIndex | ) |
Removes a cell from the harvest cut range's area.
| iIndex | int Cell index. Invalid values are ignored. |
|
private |
Cell length in the X direction, in meters.
|
private |
Cell length in the Y direction, in meters.
|
private |
Subplot name.
List of cells that make up the subplot.
1.8.2