This class is used by the DetailedOutputFileManager class to manage open requests for data. More...

Inheritance diagram for sortie.datavisualizer.DataRequest:

Public Member Functions
	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
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
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

This class is used by the DetailedOutputFileManager class to manage open requests for data.

Each DataRequest object represents the data needed to make one chart. This base class rejects all data in its non-abstract data members. Override the ones necessary to get and process required information.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
December 10, 2004: Added the writing of data behind charts (LEM)
March 20, 2006: Added package support (LEM)
March 3, 2011: Added dead tree support (LEM)
June 27, 2011: Changed format to allow batch output (LEM)

Constructor & Destructor Documentation

◆ DataRequest()

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

Constructor.

Parameters

sChartName	Name of chart to display.
oManager	Managing file manager.

Member Function Documentation

◆ actionPerformed()

void sortie.datavisualizer.DataRequest.actionPerformed ( java.awt.event.ActionEvent oEvent )

If passed the order to write chart data, does it.

Parameters

oEvent ActionEvent Event to process.

◆ addDeadTreeBoolData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

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 this tree.
bVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addDeadTreeCharData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

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 this tree.
sVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addDeadTreeFloatData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

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

◆ addDeadTreeIntData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

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 this tree.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridBoolData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
bVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridBoolDataMemberCode()

void sortie.datavisualizer.DataRequest.addGridBoolDataMemberCode	(	String	sGridName,
		String	sLabel,
		int	iCode
	)		throws SAXException

Accepts a grid bool data member code for future reference when passed bool data members.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridCharData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
sVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridCharDataMemberCode()

void sortie.datavisualizer.DataRequest.addGridCharDataMemberCode	(	String	sGridName,
		String	sLabel,
		int	iCode
	)		throws SAXException

Accepts a grid char data member code for future reference when passed char data members.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridFloatData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell 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.

◆ addGridFloatDataMemberCode()

void sortie.datavisualizer.DataRequest.addGridFloatDataMemberCode	(	String	sGridName,
		String	sLabel,
		int	iCode
	)		throws SAXException

Accepts a grid float data member code for future reference when passed float data members.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridIntData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridIntDataMemberCode()

void sortie.datavisualizer.DataRequest.addGridIntDataMemberCode	(	String	sGridName,
		String	sLabel,
		int	iCode
	)		throws SAXException

Accepts a grid int data member code for future reference when passed int data members.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridPackageBoolData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
bVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridPackageBoolDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridPackageCharData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
sVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridPackageCharDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridPackageFloatData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell 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.

◆ addGridPackageFloatDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addGridPackageIntData()

void sortie.datavisualizer.DataRequest.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.

If this particular piece is not wanted, do nothing.

Parameters

sGridName	Name of the grid for this data
iX	X number of the cell from which this value came
iY	Y number of the cell from which this value came
iCode	Data member code of this value.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addGridPackageIntDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

Parameters

sGridName	Name of the grid
sLabel	The label of the data member.
iCode	The data member code.

◆ addTreeBoolData()

void sortie.datavisualizer.DataRequest.addTreeBoolData	(	int	iSpecies,
		int	iType,
		int	iCode,
		boolean	bVal,
		boolean	bBatchMode
	)		throws SAXException

Accepts a piece of tree bool data from the parser.

If this particular piece is not wanted, do nothing.

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.
bVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeBoolDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

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.

◆ addTreeCharData()

void sortie.datavisualizer.DataRequest.addTreeCharData	(	int	iSpecies,
		int	iType,
		int	iCode,
		String	sVal,
		boolean	bBatchMode
	)		throws SAXException

Accepts a piece of tree char data from the parser.

If this particular piece is not wanted, do nothing.

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.
sVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeCharDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

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.

◆ addTreeFloatData()

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

Accepts a piece of tree float data from the parser.

If this particular piece is not wanted, do nothing.

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

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.

◆ addTreeIntData()

void sortie.datavisualizer.DataRequest.addTreeIntData	(	int	iSpecies,
		int	iType,
		int	iCode,
		int	iVal,
		boolean	bBatchMode
	)		throws SAXException

Accepts a piece of tree int data from the parser.

If this particular piece is not wanted, do nothing.

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.
iVal	Value.
bBatchMode	Whether not this is in the context of the batch utility.

◆ addTreeIntDataMemberCode()

void sortie.datavisualizer.DataRequest.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.

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.

◆ endPackage()

void sortie.datavisualizer.DataRequest.endPackage ( ) throws SAXException

Announces a package has ended.

Data requests can do whatever they want with this information, including nothing.

◆ endTree()

void sortie.datavisualizer.DataRequest.endTree ( boolean bBatchMode ) throws SAXException

Announces a tree record has ended.

Data requests can do whatever they want with this information, including nothing.

◆ extractBatchSetupInfo()

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

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

This can be overridden, but the super class function must be called as well.

Parameters

oInfo Object which contains the chart information.

◆ getChart()

JInternalFrame sortie.datavisualizer.DataRequest.getChart ( )

Get the chart frame.

◆ getChartName()

String sortie.datavisualizer.DataRequest.getChartName ( )

Get the name of the chart.

Returns: Chart name.

◆ getReadyForTimestepParse()

void sortie.datavisualizer.DataRequest.getReadyForTimestepParse	(	int	iTimestep,
		boolean	bBatchMode
	)		throws ModelException

This will be called for all open data requests just before time step parsing begins.

Parameters

iTimestep	Timestep to parse.
bBatchMode	Whether or not this is in the context of batch extraction mode.

◆ isFileWritingExternallyManaged()

boolean sortie.datavisualizer.DataRequest.isFileWritingExternallyManaged ( )

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

Returns: Whether file writing is externally managed.

◆ outputFileParseFinished()

void sortie.datavisualizer.DataRequest.outputFileParseFinished ( boolean bBatchMode )

This will be called for all open data requests after output file parsing is completed.

Parameters

bBatchMode Whether or not this is in the context of batch extraction mode.

◆ saveChartDataToFile()

void sortie.datavisualizer.DataRequest.saveChartDataToFile ( boolean bJustCurrTS )

Writes a chart's data to a file.

This can write data for only the current timestep or the whole run.

Parameters

bJustCurrTS If true, writes for only the current timestep. If false, writes for the whole run.

◆ setCurrentTimestep()

void sortie.datavisualizer.DataRequest.setCurrentTimestep ( int iTimestep )

Sets the current time step.

Parameters

iTimestep Timestep to set.

◆ timestepParseFinished()

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

This will be called for all open data requests after time step parsing is completed.

Parameters

bBatchMode Whether or not this is in the context of batch extraction mode.

◆ wantAnyDeadTreeBools()

boolean sortie.datavisualizer.DataRequest.wantAnyDeadTreeBools ( )

Whether or not this object wants any dead tree bool data members.

Returns: True if bool data members are desired, false if not.

◆ wantAnyDeadTreeChars()

boolean sortie.datavisualizer.DataRequest.wantAnyDeadTreeChars ( )

Whether or not this object wants any dead tree char data members.

Returns: True if char data members are desired, false if not.

◆ wantAnyDeadTreeFloats()

boolean sortie.datavisualizer.DataRequest.wantAnyDeadTreeFloats ( )

Whether or not this object wants any dead tree float data members.

Returns: True if float data members are desired, false if not.

◆ wantAnyDeadTreeInts()

boolean sortie.datavisualizer.DataRequest.wantAnyDeadTreeInts ( )

Whether or not this object wants any dead tree int data members.

Returns: True if int data members are desired, false if not.

◆ wantAnyGridBools()

boolean sortie.datavisualizer.DataRequest.wantAnyGridBools ( )

Whether or not this object wants any grid bool data members.

Returns: True if bool data members are desired, false if not.

◆ wantAnyGridChars()

boolean sortie.datavisualizer.DataRequest.wantAnyGridChars ( )

Whether or not this object wants any grid char data members.

Returns: True if char data members are desired, false if not.

◆ wantAnyGridFloats()

boolean sortie.datavisualizer.DataRequest.wantAnyGridFloats ( )

Whether or not this object wants any grid float data members.

Returns: True if float data members are desired, false if not.

◆ wantAnyGridInts()

boolean sortie.datavisualizer.DataRequest.wantAnyGridInts ( )

Whether or not this object wants any grid int data members.

Returns: True if int data members are desired, false if not.

◆ wantAnyGridPackageBools()

boolean sortie.datavisualizer.DataRequest.wantAnyGridPackageBools ( )

Whether or not this object wants any grid package bool data members.

Returns: True if bool data members are desired, false if not.

◆ wantAnyGridPackageChars()

boolean sortie.datavisualizer.DataRequest.wantAnyGridPackageChars ( )

Whether or not this object wants any grid package char data members.

Returns: True if char data members are desired, false if not.

◆ wantAnyGridPackageFloats()

boolean sortie.datavisualizer.DataRequest.wantAnyGridPackageFloats ( )

Whether or not this object wants any grid package float data members.

Returns: True if float data members are desired, false if not.

◆ wantAnyGridPackageInts()

boolean sortie.datavisualizer.DataRequest.wantAnyGridPackageInts ( )

Whether or not this object wants any grid package int data members.

Returns: True if int data members are desired, false if not.

◆ wantAnyTreeBools()

boolean sortie.datavisualizer.DataRequest.wantAnyTreeBools ( )

Whether or not this object wants any tree bool data members.

Returns: True if bool data members are desired, false if not.

◆ wantAnyTreeChars()

boolean sortie.datavisualizer.DataRequest.wantAnyTreeChars ( )

Whether or not this object wants any tree char data members.

Returns: True if char data members are desired, false if not.

◆ wantAnyTreeFloats()

boolean sortie.datavisualizer.DataRequest.wantAnyTreeFloats ( )

Whether or not this object wants any tree float data members.

Returns: True if float data members are desired, false if not.

◆ wantAnyTreeInts()

boolean sortie.datavisualizer.DataRequest.wantAnyTreeInts ( )

Whether or not this object wants any tree int data members.

Returns: True if int data members are desired, false if not.

◆ writeChartDataToFile()

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

abstractprotected

Child classes override this to write the data behind their chart to tab-delimited text.

They can assume that the chart's header has already been written as a file title at the top, and that a line for the current timestep has been written as well.

Parameters

jOut	java.io.FileWriter The file to write to. Doesn't need to be opened or closed.

Exceptions

java.io.IOException	if there is a problem writing the file.
ModelException	if there is a problem assembling the chart data.

Member Data Documentation

◆ m_bExternallyManageWriting

boolean sortie.datavisualizer.DataRequest.m_bExternallyManageWriting = true

protected

Whether or not this data request gets its file writing managed externally.

◆ m_bShowOneTimestep

boolean sortie.datavisualizer.DataRequest.m_bShowOneTimestep = true

protected

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

Defaults to true.

◆ m_iCurrentTimestep

int sortie.datavisualizer.DataRequest.m_iCurrentTimestep

protected

Current time step being parsed.

◆ m_oChartFrame

ModelInternalFrame sortie.datavisualizer.DataRequest.m_oChartFrame

protected

Chart for this request.

This is not automatically set.

◆ m_sBatchFilename

String sortie.datavisualizer.DataRequest.m_sBatchFilename = ""

protected

File name for batch data extraction.

◆ m_sChartName

String sortie.datavisualizer.DataRequest.m_sChartName

protected

Name string of chart.

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

DataRequest.java

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DataRequest()

Member Function Documentation

◆ actionPerformed()

◆ addDeadTreeBoolData()

◆ addDeadTreeCharData()

◆ addDeadTreeFloatData()

◆ addDeadTreeIntData()

◆ addGridBoolData()

◆ addGridBoolDataMemberCode()

◆ addGridCharData()

◆ addGridCharDataMemberCode()

◆ addGridFloatData()

◆ addGridFloatDataMemberCode()

◆ addGridIntData()

◆ addGridIntDataMemberCode()

◆ addGridPackageBoolData()

◆ addGridPackageBoolDataMemberCode()

◆ addGridPackageCharData()

◆ addGridPackageCharDataMemberCode()

◆ addGridPackageFloatData()

◆ addGridPackageFloatDataMemberCode()

◆ addGridPackageIntData()

◆ addGridPackageIntDataMemberCode()

◆ addTreeBoolData()

◆ addTreeBoolDataMemberCode()

◆ addTreeCharData()

◆ addTreeCharDataMemberCode()

◆ addTreeFloatData()

◆ addTreeFloatDataMemberCode()

◆ addTreeIntData()

◆ addTreeIntDataMemberCode()

◆ endPackage()

◆ endTree()

◆ extractBatchSetupInfo()

◆ getChart()

◆ getChartName()

◆ getReadyForTimestepParse()

◆ isFileWritingExternallyManaged()

◆ outputFileParseFinished()

◆ saveChartDataToFile()

◆ setCurrentTimestep()

◆ timestepParseFinished()

◆ wantAnyDeadTreeBools()

◆ wantAnyDeadTreeChars()

◆ wantAnyDeadTreeFloats()

◆ wantAnyDeadTreeInts()

◆ wantAnyGridBools()

◆ wantAnyGridChars()

◆ wantAnyGridFloats()

◆ wantAnyGridInts()

◆ wantAnyGridPackageBools()

◆ wantAnyGridPackageChars()

◆ wantAnyGridPackageFloats()

◆ wantAnyGridPackageInts()

◆ wantAnyTreeBools()

◆ wantAnyTreeChars()

◆ wantAnyTreeFloats()

◆ wantAnyTreeInts()

◆ writeChartDataToFile()

Member Data Documentation

◆ m_bExternallyManageWriting

◆ m_bShowOneTimestep

◆ m_iCurrentTimestep

◆ m_oChartFrame

◆ m_sBatchFilename

◆ m_sChartName