This controls the drawing of a histogram for a single piece of information. More...

Inheritance diagram for sortie.datavisualizer.HistogramDataRequest:

Public Member Functions
	HistogramDataRequest (String sLabel, boolean bIsFloat, DetailedOutputFileManager oManager, String sGraphName, int iDeadCode)
	Constructor. More...

void	timestepParseFinished (boolean bBatchMode) throws ModelException
	Adds the series to the dataset and makes values per-hectare. More...

void	actionPerformed (ActionEvent oEvent)
	Performs actions for the controls in the Histogram window. More...

float	getBinSize ()
	Gets the bin size for this data request's histogram. More...

boolean	getUseLogarithmicAxis ()
	Gets whether or not to use a logarithmic axis. More...

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

void	addTreeIntData (int iSpecies, int iType, int iCode, int iVal, boolean bBatchMode)
	This will add the integer data, if the data for this chart is an int that matches the data member code. More...

void	addDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal, boolean bBatchMode)
	This will add the integer data, if the data for this chart is an int that matches the data member code. More...

void	addTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
	If the label matches the one given in the constructor, and the data being histogrammed is an int, this captures the values passed. More...

void	getReadyForTimestepParse (int iTimestep, boolean bBatchMode)
	This nulls our dataset and recreates it, and clears all of our data vectors. More...

void	addTreeFloatData (int iSpecies, int iType, int iCode, float fVal, boolean bBatchMode)
	This will add the float data, if the data for this chart is a float that matches the data member code. More...

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

boolean	wantAnyTreeInts ()
	If our data piece that's being graphed is an integer, this returns true. More...

boolean	wantAnyDeadTreeInts ()
	If our data piece that's being graphed is an integer, this returns true. More...

boolean	wantAnyTreeFloats ()
	If our data piece that's being graphed is a float, this returns true. More...

boolean	wantAnyDeadTreeFloats ()
	If our data piece that's being graphed is a float, this returns true. More...

void	addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
	If the label matches the one given in the constructor, and the data being histogrammed is a float, this captures the values passed. 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...

Static Public Member Functions
static JPanel	makeBatchControlsPanel ()
	Makes the control panel to show while in batch mode. More...

Static Public Attributes
static final String	PANEL_NAME = "Histogram Panel"
	The name that is given to the control panel for this data request, which can be used with the named components finder to get access. More...

static final String	NUMBER_BINS_NAME = "Number Bins"
	The name that is given to the text field holding the number of bins in the control panel for this data request. More...

static final String	BIN_SIZE_NAME = "Bin Size"
	The name that is given to the text field holding the size of bins in the control panel for this data request. More...

static final String	INCLUDE_SEEDLINGS_NAME = "Include Seedlings"
	The name that is given to the check box for whether or not to include seedlings in the control panel for this data request. More...

static final String	INCLUDE_SAPLINGS_NAME = "Include Saplings"
	The name that is given to the check box for whether or not to include saplings in the control panel for this data request. More...

static final String	INCLUDE_ADULTS_NAME = "Include Adults"
	The name that is given to the check box for whether or not to include adults in the control panel for this data request. More...

static final String	INCLUDE_SNAGS_NAME = "Include Snags"
	The name that is given to the check box for whether or not to include snags in the control panel for this data request. More...

Protected Member Functions
void	writeChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
	Writes the histogram's data to tab-delimited text. More...

ModelHistogramDataset	updateForVisible (Legend oLegend) throws ModelException
	Copies our dataset and includes only species marked as visible in the legend. More...

void	addSeriesToDataset () throws ModelException
	This will add all series to the dataset. 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...

Protected Attributes
ModelHistogramDataset	m_oDataset
	The dataset that will be graphed. More...

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

Static Private Member Functions
static JPanel	makeTypeShowControls (ActionListener jListener, boolean bShowSeedling, boolean bShowSapling, boolean bShowAdult, boolean bShowSnag)
	Makes the panel with checkboxes for which life history stages to include. More...

Private Attributes
String	m_sLabel
	Data member's label, as it appears in the detailed output file. More...

boolean	m_bIsFloat
	Whether our data member being graphed is a float. More...

boolean	m_bIsInt
	Whether our data member being graphed is an integer. More...

boolean []	mp_bInclude
	Whether to include each tree type. More...

JLabel	m_jMinDatasetValue = new JLabel("")
	Field displaying the minimum value for the dataset. More...

JLabel	m_jMaxDatasetValue = new JLabel("")
	Field displaying the maximum value for the dataset. More...

int [][]	mp_iDataMemberCodes
	The data member codes for this data member - one per species / type. More...

ArrayList< ArrayList< ArrayList< Number > > >	mp_oData
	The data - kept in an array of vectors - one per species, per type. More...

float	m_fPlotAreaInHectares
	Plot area in hectares. More...

float	m_fBinSize
	Size of the histogram bins. More...

float	m_fDatasetMin = java.lang.Float.POSITIVE_INFINITY
	Minimum dataset value. More...

float	m_fDatasetMax = java.lang.Float.NEGATIVE_INFINITY
	Maximum dataset value. More...

NumberFormat	m_jFormat = NumberFormat.getInstance()

int	m_iNumBins
	Number of bins in the histogram. More...

int	m_iDeadCode
	Dead code for trees (including NOTDEAD). More...

boolean	m_bUseLogarithmicAxis
	Whether or not to use a logarithmic axis on the Y. More...

boolean	m_bRecalcBinsOnUpdate
	Whether or not we have to recalculate the bins on chart update (i.e. More...

boolean	m_bShowTotal = true
	Whether or not to display a total bar in each bin. More...

Static Private Attributes
static int	NUMBER_BINS_DEFAULT = 10
	Default value for number of bins. More...

static double	BIN_SIZE_DEFAULT = 0
	Default value for bin size. More...

static boolean	INCLUDE_SEEDLINGS_DEFAULT = true

static boolean	INCLUDE_SAPLINGS_DEFAULT = true

static boolean	INCLUDE_ADULTS_DEFAULT = true

static boolean	INCLUDE_SNAGS_DEFAULT = true

Detailed Description

This controls the drawing of a histogram for a single piece of information.

The label of the data is passed in the constructor. The histogram is defaulted to 10 divisions equally divided between their minimum and maximum values. This can graph either live or dead tree data values.

Copyright: Copyright (c) Charles D. Canham 2012 Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)

Constructor & Destructor Documentation

◆ HistogramDataRequest()

sortie.datavisualizer.HistogramDataRequest.HistogramDataRequest	(	String	sLabel,
		boolean	bIsFloat,
		DetailedOutputFileManager	oManager,
		String	sGraphName,
		int	iDeadCode
	)

Constructor.

Parameters

sLabel	Label of the piece of data, as it would be passed as a data member code.
bIsFloat	Whether this is float data. If this is set to false, integer data is assumed.
oManager	The parent detailed output file manager.
sGraphName	Name of graph string.
iDeadCode	Dead code for trees (including NOTDEAD).

Member Function Documentation

◆ actionPerformed()

void sortie.datavisualizer.HistogramDataRequest.actionPerformed ( ActionEvent oEvent )

Performs actions for the controls in the Histogram window.

Parameters

oEvent Event triggered.

◆ addDeadTreeFloatData()

void sortie.datavisualizer.HistogramDataRequest.addDeadTreeFloatData	(	int	iSpecies,
		int	iType,
		int	iCode,
		int	iDeadCode,
		float	fVal,
		boolean	bBatchMode
	)

Accepts a tree float data member value.

If it matches our code, we'll increment either the count or the total, depending on the chart type.

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.
iDeadCode	Dead code for tree type.
fVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addDeadTreeIntData()

void sortie.datavisualizer.HistogramDataRequest.addDeadTreeIntData	(	int	iSpecies,
		int	iType,
		int	iCode,
		int	iDeadCode,
		int	iVal,
		boolean	bBatchMode
	)

This will add the integer data, if the data for this chart is an int that matches the data member code.

Parameters

iSpecies	Species for this data.
iType	Type for this data. We don't care, other than for matching codes.
iCode	Data member code.
iDeadCode	Dead code for tree type.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addSeriesToDataset()

void sortie.datavisualizer.HistogramDataRequest.addSeriesToDataset ( ) throws ModelException

protected

This will add all series to the dataset.

Exceptions

ModelException Passing through from underlying

◆ addTreeFloatData()

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

This will add the float data, if the data for this chart is a float that matches the data member code.

Parameters

iSpecies	Species for this data.
iType	Type for this data. We don't care, other than for matching codes.
iCode	Data member code.
fVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeFloatDataMemberCode()

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

If the label matches the one given in the constructor, and the data being histogrammed is a float, this captures the values passed.

Parameters

iSpecies	Species for this data member
iType	Type for this data member
sLabel	Data member label.
iCode	Data member code.

◆ addTreeIntData()

void sortie.datavisualizer.HistogramDataRequest.addTreeIntData	(	int	iSpecies,
		int	iType,
		int	iCode,
		int	iVal,
		boolean	bBatchMode
	)

This will add the integer data, if the data for this chart is an int that matches the data member code.

Parameters

iSpecies	Species for this data.
iType	Type for this data. We don't care, other than for matching codes.
iCode	Data member code.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeIntDataMemberCode()

void sortie.datavisualizer.HistogramDataRequest.addTreeIntDataMemberCode	(	int	iSpecies,
		int	iType,
		String	sLabel,
		int	iCode
	)

If the label matches the one given in the constructor, and the data being histogrammed is an int, this captures the values passed.

Parameters

iSpecies	Species for this data member
iType	Type for this data member
sLabel	Data member label.
iCode	Data member code.

◆ extractBatchSetupInfo()

void sortie.datavisualizer.HistogramDataRequest.extractBatchSetupInfo ( ChartInfo oInfo ) throws ModelException

Extracts information needed by the data request from the controls panel displayed to the user.

Parameters

oInfo Object which contains the chart information.

◆ getBinSize()

float sortie.datavisualizer.HistogramDataRequest.getBinSize ( )

Gets the bin size for this data request's histogram.

Returns: The bin size.

◆ getReadyForTimestepParse()

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

This nulls our dataset and recreates it, and clears all of our data vectors.

◆ getUseLogarithmicAxis()

boolean sortie.datavisualizer.HistogramDataRequest.getUseLogarithmicAxis ( )

Gets whether or not to use a logarithmic axis.

Returns: True if a logarithmic axis should be used, or false if a linear axis should be used.

◆ makeBatchControlsPanel()

static JPanel sortie.datavisualizer.HistogramDataRequest.makeBatchControlsPanel ( )

static

Makes the control panel to show while in batch mode.

Returns: Panel with batch controls.

◆ makeTypeShowControls()

static JPanel sortie.datavisualizer.HistogramDataRequest.makeTypeShowControls	(	ActionListener	jListener,
		boolean	bShowSeedling,
		boolean	bShowSapling,
		boolean	bShowAdult,
		boolean	bShowSnag
	)

staticprivate

Makes the panel with checkboxes for which life history stages to include.

Parameters

jListener	Action listener to respond to check events. Can be null.
bShowSeedling	Whether to show seedlings.
bShowSapling	Whether to show saplings.
bShowAdult	Whether to show adults.
bShowSnag	Whether to show snags.

Returns: Controls panel.

◆ timestepParseFinished()

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

Adds the series to the dataset and makes values per-hectare.

Parameters

bBatchMode Whether or not this is batch mode.

◆ updateForVisible()

ModelHistogramDataset sortie.datavisualizer.HistogramDataRequest.updateForVisible ( Legend oLegend ) throws ModelException

protected

Copies our dataset and includes only species marked as visible in the legend.

Parameters

oLegend Legend for this chart.

Returns: The copied dataset.

Exceptions

ModelException Passing through an underlying exception.

◆ wantAnyDeadTreeFloats()

boolean sortie.datavisualizer.HistogramDataRequest.wantAnyDeadTreeFloats ( )

If our data piece that's being graphed is a float, this returns true.

Otherwise, false.

Returns: Whether this object's data piece is a float.

◆ wantAnyDeadTreeInts()

boolean sortie.datavisualizer.HistogramDataRequest.wantAnyDeadTreeInts ( )

If our data piece that's being graphed is an integer, this returns true.

Otherwise, false.

Returns: Whether this object's data piece is an integer.

◆ wantAnyTreeFloats()

boolean sortie.datavisualizer.HistogramDataRequest.wantAnyTreeFloats ( )

If our data piece that's being graphed is a float, this returns true.

Otherwise, false.

Returns: Whether this object's data piece is a float.

◆ wantAnyTreeInts()

boolean sortie.datavisualizer.HistogramDataRequest.wantAnyTreeInts ( )

If our data piece that's being graphed is an integer, this returns true.

Otherwise, false.

Returns: Whether this object's data piece is an integer.

◆ writeChartDataToFile()

void sortie.datavisualizer.HistogramDataRequest.writeChartDataToFile ( java.io.FileWriter jOut ) throws java.io. IOException

protected

Writes the histogram's data to tab-delimited text.

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

◆ BIN_SIZE_DEFAULT

double sortie.datavisualizer.HistogramDataRequest.BIN_SIZE_DEFAULT = 0

staticprivate

Default value for bin size.

◆ BIN_SIZE_NAME

final String sortie.datavisualizer.HistogramDataRequest.BIN_SIZE_NAME = "Bin Size"

static

The name that is given to the text field holding the size of bins in the control panel for this data request.

◆ INCLUDE_ADULTS_DEFAULT

boolean sortie.datavisualizer.HistogramDataRequest.INCLUDE_ADULTS_DEFAULT = true

staticprivate

◆ INCLUDE_ADULTS_NAME

final String sortie.datavisualizer.HistogramDataRequest.INCLUDE_ADULTS_NAME = "Include Adults"

static

The name that is given to the check box for whether or not to include adults in the control panel for this data request.

◆ INCLUDE_SAPLINGS_DEFAULT

boolean sortie.datavisualizer.HistogramDataRequest.INCLUDE_SAPLINGS_DEFAULT = true

staticprivate

◆ INCLUDE_SAPLINGS_NAME

final String sortie.datavisualizer.HistogramDataRequest.INCLUDE_SAPLINGS_NAME = "Include Saplings"

static

The name that is given to the check box for whether or not to include saplings in the control panel for this data request.

◆ INCLUDE_SEEDLINGS_DEFAULT

boolean sortie.datavisualizer.HistogramDataRequest.INCLUDE_SEEDLINGS_DEFAULT = true

staticprivate

◆ INCLUDE_SEEDLINGS_NAME

final String sortie.datavisualizer.HistogramDataRequest.INCLUDE_SEEDLINGS_NAME = "Include Seedlings"

static

The name that is given to the check box for whether or not to include seedlings in the control panel for this data request.

◆ INCLUDE_SNAGS_DEFAULT

boolean sortie.datavisualizer.HistogramDataRequest.INCLUDE_SNAGS_DEFAULT = true

staticprivate

◆ INCLUDE_SNAGS_NAME

final String sortie.datavisualizer.HistogramDataRequest.INCLUDE_SNAGS_NAME = "Include Snags"

static

The name that is given to the check box for whether or not to include snags in the control panel for this data request.

◆ m_bIsFloat

boolean sortie.datavisualizer.HistogramDataRequest.m_bIsFloat

private

Whether our data member being graphed is a float.

◆ m_bIsInt

boolean sortie.datavisualizer.HistogramDataRequest.m_bIsInt

private

Whether our data member being graphed is an integer.

◆ m_bRecalcBinsOnUpdate

boolean sortie.datavisualizer.HistogramDataRequest.m_bRecalcBinsOnUpdate

private

Whether or not we have to recalculate the bins on chart update (i.e.

we are charting an unknown data type without defaults)

◆ m_bShowTotal

boolean sortie.datavisualizer.HistogramDataRequest.m_bShowTotal = true

private

Whether or not to display a total bar in each bin.

◆ m_bUseLogarithmicAxis

boolean sortie.datavisualizer.HistogramDataRequest.m_bUseLogarithmicAxis

private

Whether or not to use a logarithmic axis on the Y.

◆ m_fBinSize

float sortie.datavisualizer.HistogramDataRequest.m_fBinSize

private

Size of the histogram bins.

◆ m_fDatasetMax

float sortie.datavisualizer.HistogramDataRequest.m_fDatasetMax = java.lang.Float.NEGATIVE_INFINITY

private

Maximum dataset value.

◆ m_fDatasetMin

float sortie.datavisualizer.HistogramDataRequest.m_fDatasetMin = java.lang.Float.POSITIVE_INFINITY

private

Minimum dataset value.

◆ m_fPlotAreaInHectares

float sortie.datavisualizer.HistogramDataRequest.m_fPlotAreaInHectares

private

Plot area in hectares.

◆ m_iDeadCode

int sortie.datavisualizer.HistogramDataRequest.m_iDeadCode

private

Dead code for trees (including NOTDEAD).

◆ m_iNumBins

int sortie.datavisualizer.HistogramDataRequest.m_iNumBins

private

Number of bins in the histogram.

◆ m_jFormat

NumberFormat sortie.datavisualizer.HistogramDataRequest.m_jFormat = NumberFormat.getInstance()

private

◆ m_jMaxDatasetValue

JLabel sortie.datavisualizer.HistogramDataRequest.m_jMaxDatasetValue = new JLabel("")

private

Field displaying the maximum value for the dataset.

◆ m_jMinDatasetValue

JLabel sortie.datavisualizer.HistogramDataRequest.m_jMinDatasetValue = new JLabel("")

private

Field displaying the minimum value for the dataset.

◆ m_oDataset

ModelHistogramDataset sortie.datavisualizer.HistogramDataRequest.m_oDataset

protected

The dataset that will be graphed.

◆ m_sLabel

String sortie.datavisualizer.HistogramDataRequest.m_sLabel

private

Data member's label, as it appears in the detailed output file.

◆ mp_bInclude

boolean [] sortie.datavisualizer.HistogramDataRequest.mp_bInclude

private

Whether to include each tree type.

◆ mp_iDataMemberCodes

int [][] sortie.datavisualizer.HistogramDataRequest.mp_iDataMemberCodes

private

The data member codes for this data member - one per species / type.

◆ mp_oData

ArrayList<ArrayList<ArrayList<Number> > > sortie.datavisualizer.HistogramDataRequest.mp_oData

private

The data - kept in an array of vectors - one per species, per type.

◆ NUMBER_BINS_DEFAULT

int sortie.datavisualizer.HistogramDataRequest.NUMBER_BINS_DEFAULT = 10

staticprivate

Default value for number of bins.

◆ NUMBER_BINS_NAME

final String sortie.datavisualizer.HistogramDataRequest.NUMBER_BINS_NAME = "Number Bins"

static

The name that is given to the text field holding the number of bins in the control panel for this data request.

◆ PANEL_NAME

final String sortie.datavisualizer.HistogramDataRequest.PANEL_NAME = "Histogram Panel"

static

The name that is given to the control panel for this data request, which can be used with the named components finder to get access.

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

HistogramDataRequest.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HistogramDataRequest()

Member Function Documentation

◆ actionPerformed()

◆ addDeadTreeFloatData()

◆ addDeadTreeIntData()

◆ addSeriesToDataset()

◆ addTreeFloatData()

◆ addTreeFloatDataMemberCode()

◆ addTreeIntData()

◆ addTreeIntDataMemberCode()

◆ extractBatchSetupInfo()

◆ getBinSize()

◆ getReadyForTimestepParse()

◆ getUseLogarithmicAxis()

◆ makeBatchControlsPanel()

◆ makeTypeShowControls()

◆ timestepParseFinished()

◆ updateForVisible()

◆ wantAnyDeadTreeFloats()

◆ wantAnyDeadTreeInts()

◆ wantAnyTreeFloats()

◆ wantAnyTreeInts()

◆ writeChartDataToFile()

Member Data Documentation

◆ BIN_SIZE_DEFAULT

◆ BIN_SIZE_NAME

◆ INCLUDE_ADULTS_DEFAULT

◆ INCLUDE_ADULTS_NAME

◆ INCLUDE_SAPLINGS_DEFAULT

◆ INCLUDE_SAPLINGS_NAME

◆ INCLUDE_SEEDLINGS_DEFAULT

◆ INCLUDE_SEEDLINGS_NAME

◆ INCLUDE_SNAGS_DEFAULT

◆ INCLUDE_SNAGS_NAME

◆ m_bIsFloat

◆ m_bIsInt

◆ m_bRecalcBinsOnUpdate

◆ m_bShowTotal

◆ m_bUseLogarithmicAxis

◆ m_fBinSize

◆ m_fDatasetMax

◆ m_fDatasetMin

◆ m_fPlotAreaInHectares

◆ m_iDeadCode

◆ m_iNumBins

◆ m_jFormat

◆ m_jMaxDatasetValue

◆ m_jMinDatasetValue

◆ m_oDataset

◆ m_sLabel

◆ mp_bInclude

◆ mp_iDataMemberCodes

◆ mp_oData

◆ NUMBER_BINS_DEFAULT

◆ NUMBER_BINS_NAME

◆ PANEL_NAME