Writes an overview table for a detailed output file (basal area and density for each life history stage). More...

Inheritance diagram for sortie.datavisualizer.OverviewTableDataRequest:

Public Member Functions
	OverviewTableDataRequest (DetailedOutputFileManager oManager, String sChartName)
	Constructor. More...

void	timestepParseFinished (boolean bBatchMode) throws ModelException
	Creates a table dataset out of the accumulated data and puts it in mp_oTables. More...

void	getReadyForTimestepParse (int iTimestep, boolean bBatchMode)
	Sets all the values in the data collection arrays back to 0. More...

boolean	wantAnyTreeFloats ()
	This wants diameter values for all trees. More...

void	addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
	Accepts a tree float data member code. More...

void	addTreeFloatData (int iSpecies, int iType, int iCode, float fVal, boolean bBatchMode)
	Accepts a tree float data member value. More...

Public Member Functions inherited from sortie.datavisualizer.DataRequest
	DataRequest (String sChartName, DetailedOutputFileManager oManager)
	Constructor. More...

void	setCurrentTimestep (int iTimestep)
	Sets the current time step. More...

void	actionPerformed (java.awt.event.ActionEvent oEvent)
	If passed the order to write chart data, does it. More...

void	extractBatchSetupInfo (ChartInfo oInfo) throws ModelException
	Extracts information needed by the data request from the controls panel displayed to the user. More...

boolean	isFileWritingExternallyManaged ()
	Gets whether or not file writing is externally managed for this data request or whether it takes care of everything itself. More...

void	getReadyForTimestepParse (int iTimestep, boolean bBatchMode) throws ModelException
	This will be called for all open data requests just before time step parsing begins. More...

void	timestepParseFinished (boolean bBatchMode) throws ModelException
	This will be called for all open data requests after time step parsing is completed. More...

void	outputFileParseFinished (boolean bBatchMode)
	This will be called for all open data requests after output file parsing is completed. More...

void	saveChartDataToFile (boolean bJustCurrTS)
	Writes a chart's data to a file. More...

String	getChartName ()
	Get the name of the chart. More...

JInternalFrame	getChart ()
	Get the chart frame. More...

boolean	wantAnyTreeFloats ()
	Whether or not this object wants any tree float data members. More...

boolean	wantAnyTreeInts ()
	Whether or not this object wants any tree int data members. More...

boolean	wantAnyTreeChars ()
	Whether or not this object wants any tree char data members. More...

boolean	wantAnyTreeBools ()
	Whether or not this object wants any tree bool data members. More...

boolean	wantAnyDeadTreeFloats ()
	Whether or not this object wants any dead tree float data members. More...

boolean	wantAnyDeadTreeInts ()
	Whether or not this object wants any dead tree int data members. More...

boolean	wantAnyDeadTreeChars ()
	Whether or not this object wants any dead tree char data members. More...

boolean	wantAnyDeadTreeBools ()
	Whether or not this object wants any dead tree bool data members. More...

boolean	wantAnyGridFloats ()
	Whether or not this object wants any grid float data members. More...

boolean	wantAnyGridInts ()
	Whether or not this object wants any grid int data members. More...

boolean	wantAnyGridChars ()
	Whether or not this object wants any grid char data members. More...

boolean	wantAnyGridBools ()
	Whether or not this object wants any grid bool data members. More...

boolean	wantAnyGridPackageFloats ()
	Whether or not this object wants any grid package float data members. More...

boolean	wantAnyGridPackageInts ()
	Whether or not this object wants any grid package int data members. More...

boolean	wantAnyGridPackageChars ()
	Whether or not this object wants any grid package char data members. More...

boolean	wantAnyGridPackageBools ()
	Whether or not this object wants any grid package bool data members. More...

void	addTreeFloatData (int iSpecies, int iType, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree float data from the parser. More...

void	addTreeIntData (int iSpecies, int iType, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree int data from the parser. More...

void	addTreeCharData (int iSpecies, int iType, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree char data from the parser. More...

void	addTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of tree bool data from the parser. More...

void	addDeadTreeFloatData (int iSpecies, int iType, int iCode, int iDeadCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree float data from the parser. More...

void	addDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree int data from the parser. More...

void	addDeadTreeCharData (int iSpecies, int iType, int iCode, int iDeadCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree char data from the parser. More...

void	addDeadTreeBoolData (int iSpecies, int iType, int iCode, int iDeadCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of dead tree bool data from the parser. More...

void	addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid float data from the parser. More...

void	addGridIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid int data from the parser. More...

void	addGridCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid char data from the parser. More...

void	addGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid bool data from the parser. More...

void	addGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package float data from the parser. More...

void	addGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package int data from the parser. More...

void	addGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package char data from the parser. More...

void	addGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal, boolean bBatchMode) throws SAXException
	Accepts a piece of grid package bool data from the parser. More...

void	endPackage () throws SAXException
	Announces a package has ended. More...

void	endTree (boolean bBatchMode) throws SAXException
	Announces a tree record has ended. More...

void	addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree float data member code for future reference when passed float data members. More...

void	addTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree int data member code for future reference when passed int data members. More...

void	addTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree char data member code for future reference when passed char data members. More...

void	addTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
	Accepts a tree bool data member code for future reference when passed bool data members. More...

void	addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid float data member code for future reference when passed float data members. More...

void	addGridIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid int data member code for future reference when passed int data members. More...

void	addGridCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid char data member code for future reference when passed char data members. More...

void	addGridBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid bool data member code for future reference when passed bool data members. More...

void	addGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package float data member code for future reference when passed float data members. More...

void	addGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package int data member code for future reference when passed int data members. More...

void	addGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package char data member code for future reference when passed char data members. More...

void	addGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
	Accepts a grid package bool data member code for future reference when passed bool data members. More...

Protected Member Functions
void	writeChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException, ModelException
	Saves the data in the current table as a tab-delimited text file. More...

Protected Member Functions inherited from sortie.datavisualizer.DataRequest
abstract void	writeChartDataToFile (java.io.FileWriter jOut) throws java.io.IOException, ModelException
	Child classes override this to write the data behind their chart to tab-delimited text. More...

Private Attributes
String [][][]	mp_sTables
	Array of datasets for tables. More...

float [][]	mp_fABA
	Basal area data. More...

int [][]	mp_iADN
	Absolute density data. More...

int [][]	mp_iDbhCode
	Holds the data codes for diameter (diam10 or DBH). More...

float	m_fPlotAreaInHectares
	Area of the plot, in hectares. More...

int	m_iNumSpecies
	Number of total species. More...

Additional Inherited Members
Protected Attributes inherited from sortie.datavisualizer.DataRequest
String	m_sBatchFilename = ""
	File name for batch data extraction. More...

int	m_iCurrentTimestep
	Current time step being parsed. More...

boolean	m_bShowOneTimestep = true
	Whether this chart shows one timestep at a time (true) or all timesteps (false). More...

boolean	m_bExternallyManageWriting = true
	Whether or not this data request gets its file writing managed externally. More...

ModelInternalFrame	m_oChartFrame
	Chart for this request. More...

String	m_sChartName
	Name string of chart. More...

Detailed Description

Writes an overview table for a detailed output file (basal area and density for each life history stage).

The tabulation of density and basal area data is based on the diameter value for each tree life history stage (that is, diameter at 10 cm for seedlings and DBH for everything else). For density, the number of diameter values encountered is counted; for basal area, the individual basal areas calculated from DBH are totaled. All values are displayed in per hectare units.

Technically, density data could be extracted from any tree data member, since counting up the total is all that is required. I didn't do it that way because I'm a little lazy, and I'll wait for a hue and cry from the users before unnecessarily complicating my code.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

Edit history:
---------------—
August 4, 2004: Created (LEM)
September 9, 2011: Updated for batch mode use (LEM)

Constructor & Destructor Documentation

◆ OverviewTableDataRequest()

sortie.datavisualizer.OverviewTableDataRequest.OverviewTableDataRequest	(	DetailedOutputFileManager	oManager,
		String	sChartName
	)

Constructor.

Declares all the arrays.

Parameters

oManager	Parent detailed output file manager
sChartName	Name of the table being drawn.

Member Function Documentation

◆ addTreeFloatData()

void sortie.datavisualizer.OverviewTableDataRequest.addTreeFloatData	(	int	iSpecies,
		int	iType,
		int	iCode,
		float	fVal,
		boolean	bBatchMode
	)

Accepts a tree float data member value.

If it matches our code, we'll increment the density count and the basal area total, if it's bigger than a seedling.

Parameters

iSpecies	Species of the tree from which this value came.
iType	Type of the tree from which this value came.
iCode	Data member code of this value.
fVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeFloatDataMemberCode()

void sortie.datavisualizer.OverviewTableDataRequest.addTreeFloatDataMemberCode	(	int	iSpecies,
		int	iType,
		String	sLabel,
		int	iCode
	)

Accepts a tree float data member code.

We're looking for diam10 for seedlings, and DBH for all other tree types supported.

Parameters

iSpecies	The species for which this is a data member.
iType	The tree type for which this is a data member.
sLabel	The label of the data member.
iCode	The data member code.

◆ getReadyForTimestepParse()

void sortie.datavisualizer.OverviewTableDataRequest.getReadyForTimestepParse	(	int	iTimestep,
		boolean	bBatchMode
	)

Sets all the values in the data collection arrays back to 0.

◆ timestepParseFinished()

void sortie.datavisualizer.OverviewTableDataRequest.timestepParseFinished ( boolean bBatchMode ) throws ModelException

Creates a table dataset out of the accumulated data and puts it in mp_oTables.

The four primary arrays within the overall array are ready to pass to the table constructor.

◆ wantAnyTreeFloats()

boolean sortie.datavisualizer.OverviewTableDataRequest.wantAnyTreeFloats ( )

This wants diameter values for all trees.

Returns: boolean Set to true.

◆ writeChartDataToFile()

void sortie.datavisualizer.OverviewTableDataRequest.writeChartDataToFile ( java.io.FileWriter jOut ) throws java.io. IOException, ModelException

protected

Saves the data in the current table as a tab-delimited text file.

Parameters

jOut	java.io.FileWriter The file to write to.

Exceptions

java.io.IOException if there's a problem writing the file.

Member Data Documentation

◆ m_fPlotAreaInHectares

float sortie.datavisualizer.OverviewTableDataRequest.m_fPlotAreaInHectares

private

Area of the plot, in hectares.

◆ m_iNumSpecies

int sortie.datavisualizer.OverviewTableDataRequest.m_iNumSpecies

private

Number of total species.

◆ mp_fABA

float [][] sortie.datavisualizer.OverviewTableDataRequest.mp_fABA

private

Basal area data.

Array indexes are #1 - type and #2 - species.

◆ mp_iADN

int [][] sortie.datavisualizer.OverviewTableDataRequest.mp_iADN

private

Absolute density data.

Array indexes are #1 - type and #2 - species.

◆ mp_iDbhCode

int [][] sortie.datavisualizer.OverviewTableDataRequest.mp_iDbhCode

private

Holds the data codes for diameter (diam10 or DBH).

Array indexes are #1 - type and #2 - species.

◆ mp_sTables

String [][][] sortie.datavisualizer.OverviewTableDataRequest.mp_sTables

private

Array of datasets for tables.

Index 0 is the seedling dataset, 1 is the sapling dataset, 2 is the adult dataset, and 3 is the snag dataset.

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

OverviewTableDataRequest.java

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OverviewTableDataRequest()

Member Function Documentation

◆ addTreeFloatData()

◆ addTreeFloatDataMemberCode()

◆ getReadyForTimestepParse()

◆ timestepParseFinished()

◆ wantAnyTreeFloats()

◆ writeChartDataToFile()

Member Data Documentation

◆ m_fPlotAreaInHectares

◆ m_iNumSpecies

◆ mp_fABA

◆ mp_iADN

◆ mp_iDbhCode

◆ mp_sTables