Corresponds to detailed output. More...

Inheritance diagram for sortie.data.funcgroups.output.DetailedOutput:

Public Member Functions
	DetailedOutput (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString)
	Constructor. More...

boolean	isActive ()

void	inactivate ()
	Clears all settings and sets this to inactive. More...

void	validateData (TreePopulation oPop) throws ModelException
	Validates the data before writing to a parameter file. More...

boolean	setSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, Attributes oAttributes, Object oData) throws ModelException
	Sets a data object's value. More...

boolean	setVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, ArrayList< String > p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, Attributes oParentAttributes, Attributes[] p_oAttributes) throws ModelException
	Sets a data vector's value. More...

void	readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException
	Accepts an XML parent tag (empty, no data) from the parser. More...

void	changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException
	Checks detailed output settings upon change of species. More...

void	copySpecies (int iSpeciesCopyFrom, int iSpeciesCopyTo) throws ModelException
	Updates output settings when species are copied. More...

void	changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException
	Removes cells from subplots that are outside the plot. More...

void	writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
	Writes the parameter file data for detailed output. More...

Subplot	addDetailedOutputSubplot (String sName)
	Creates a subplot for detailed output. More...

void	addDetailedOutputSubplot (Subplot oSubplot)
	Adds a subplot for detailed output. More...

void	clearDetailedOutputSubplots ()
	Clears subplot data. More...

float	getDetailedSubplotXCellLength ()
	Gets the subplot X cell length. More...

void	setDetailedSubplotXCellLength (float fLength)
	Sets the subplot X cell length. More...

float	getDetailedSubplotYCellLength ()
	Gets the subplot Y cell length. More...

void	setDetailedSubplotYCellLength (float fLength)
	Sets the subplot Y cell length. More...

int	getNumberOfDetailedSubplots ()
	Gets the number of subplots. More...

Subplot	getDetailedSubplot (int iIndex)
	Gets a subplot. More...

void	setDetailedOutputFileName (String sFilename)
	Sets the detailed output filename. More...

String	getDetailedOutputFileName ()
	Gets the detailed output filename. More...

int	getNumberOfDetailedLiveTreeSettings ()
	Gets the number of tree settings for which there is detailed output info (each setting is one tree species/type combo). More...

int	getNumberOfDetailedDeadTreeSettings ()
	Gets the number of tree settings for which there is detailed output info (each setting is one tree species/type combo). More...

int	getNumberOfDetailedGridSettings ()
	Gets the number of grid settings for which there is detailed output info. More...

DetailedTreeSettings	getDetailedLiveTreeSetting (int iIndex)
	Returns the detailed output tree setting at a specified index. More...

DetailedTreeSettings	getDetailedDeadTreeSetting (int iIndex)
	Returns the detailed output tree setting at a specified index. More...

DetailedGridSettings	getDetailedGridSetting (int iIndex)
	Returns the detailed output grid setting at a specified index. More...

void	clearDetailedLiveTreeSettings ()
	Deletes all detailed output tree settings. More...

void	clearDetailedGridSettings ()
	Deletes all detailed output grid settings. More...

void	clearDetailedDeadTreeSettings ()
	Deletes all detailed output tree settings for dead trees. More...

void	addDetailedTreeSettings (DetailedTreeSettings oTreeSettings) throws ModelException
	Adds a new detailed output tree settings object. More...

void	addDetailedGridSettings (DetailedGridSettings oTreeSettings)
	Adds a new detailed output grid settings object. More...

TreePopulation	getTreePopulation ()

void	callSetupDialog (JDialog jParent, MainWindow oMain)
	Calls the output setup dialog. More...

void	writeParametersToTextFile (FileWriter jOut, TreePopulation oPop) throws IOException
	Override to not do anything. More...

Public Member Functions inherited from sortie.data.funcgroups.Behavior
GUIManager	getGUIManager ()

	Behavior (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString)
	Constructor. More...

abstract void	validateData (TreePopulation oPop) throws ModelException
	Override this to implement data checking. More...

void	callSetupDialog (JDialog jParent, MainWindow oMain)
	Override this to call a specific setup dialog for this behavior. More...

int	getNumberOfDataObjects ()
	Gets the number of managed data objects. More...

ModelData	getDataObject (int iInd)
	Gets the managed data object at a particular index. More...

void	validate () throws ModelException
	Behavior performs an internal check to make sure its settings are consistent and logical. More...

void	setListPosition (int iListPosition) throws ModelException
	Sets the behavior list position. More...

int	getListPosition ()
	Gets the behavior list position. More...

String	getXMLParametersRoot ()
	Gets the XML parameter root string. More...

int	getNumberNewDataMembers ()

DataMember	getNewTreeDataMember (int iIndex) throws ModelException

void	setCanApplyTo (int iType, boolean bCanApply)
	Sets whether this behavior can apply to a given tree type. More...

String	getParameterFileBehaviorName ()
	Gets the parameter file name for this behavior. More...

double	getVersion ()
	Gets behavior's parameter file version. More...

double	getMinimumVersion ()
	Gets behavior's parameter file minimum version. More...

String	getDescriptor ()
	Gets the descriptor string. More...

String	getHelpFileString ()
	Gets the help file UD. More...

void	setDescriptor (String s)
	Sets the descriptor string. More...

int	getNumberOfCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

int	getNumberOfGrids ()
	Gets the number of grids to which this behavior applies. More...

void	deleteSpeciesTypeCombo (int iIndex) throws ModelException
	Deletes the SpeciesTypeCombo at the given index. More...

void	deleteSpeciesTypeCombo (SpeciesTypeCombo oCombo) throws ModelException
	Deletes a SpeciesTypeCombo. More...

void	clearSpeciesTypeCombos ()
	Empties the species/type combo list. More...

SpeciesTypeCombo	getSpeciesTypeCombo (int iIndex) throws ModelException
	Returns the SpeciesTypeCombo at the given index of the species/type combo list. More...

Grid	getGrid (int iIndex) throws ModelException
	Returns the Grid at the given index of the grid applies to list. More...

ModelData	getRequiredData (int iIndex)
	Returns the required data object at a given index. More...

int	getNumberOfRequiredDataObjects ()
	Gets the number of required data objects for this behavior. More...

void	addSpeciesTypeCombo (SpeciesTypeCombo oCombo) throws ModelException
	Adds a new species/type combo to the list to which this behavior applies. More...

void	addGrid (Grid oGrid, boolean bReplace)
	Adds a new Grid to the list to which this behavior applies. More...

void	addRequiredData (ModelData oData)
	Adds a piece of required data to the list. More...

boolean []	getWhichSpeciesUsed (TreePopulation oPop)
	Returns which species to which this behavior is applied. More...

boolean	setVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, ArrayList< String > p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, Attributes oParentAttributes, Attributes[] p_oAttributes) throws ModelException
	Sets a data vector's value. More...

boolean	setSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, Attributes oAttributes, Object oData) throws ModelException
	Sets a data object's value. More...

ModelData	findObjectByXMLTag (String sXMLTag)
	Finds an object based on its XML tag. More...

void	copySpecies (int iSpeciesCopyFrom, int iSpeciesCopyTo) throws ModelException
	Copies one species to another. More...

void	writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
	Writes the XML data to a parameter file for the behaviors owned by this object. More...

void	writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop) throws java.io.IOException, ModelException
	Writes a set of species-specific float values to a parameter file. More...

void	writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop, boolean[] p_bFlags) throws java.io.IOException, ModelException
	Writes a set of species-specific values to a parameter file for a certain subset of species. More...

void	readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException
	Accepts an XML parent tag (empty, no data) from the parser. More...

void	changeOfSpeciesName (String sOldSpecies, String sNewSpecies)
	Performs any necessary tasks associated with changing the name of a species. More...

void	changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException
	Triggered when there is a change in the species list. More...

boolean	getMustHaveTrees ()
	Gets whether this behavior must have trees. More...

ModelData	findObjectByDescriptor (String sDescriptor)
	Finds an object based on its descriptor. More...

void	writeBehaviorNode (BufferedWriter out, TreePopulation oPop) throws ModelException
	Writes behavior tags to the parameter file. More...

ArrayList< BehaviorParameterDisplay >	formatDataForDisplay (TreePopulation oPop)
	Formats data for display in a set of JTables. More...

String	getAppliedToForDisplay (TreePopulation oPop)
	Get which species/types this behavior applies to, in a display-friendly format truncated to 250 chars. More...

void	readDataFromDisplay (ArrayList< BehaviorParameterDisplay > oData, TreePopulation oPop) throws ModelException
	Reads in data from the parameter display window. More...

boolean	canBeDuplicated ()
	Whether or not this behavior can be duplicated in the run. More...

void	endOfParameterFileRead ()
	Called at the end of the parameter file read process. More...

void	changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException
	Performs any tasks associated with a change of plot resolution. More...

setupType	getSetupType ()

void	writeParametersToTextFile (FileWriter jOut, TreePopulation oPop) throws IOException
	Writes the parameters for the behavior to file, using the same system as the basic parameter display and entry system. More...

Static Public Attributes
static final String	DETAILED_OUTPUT_EXTENSION = ".gz.tar"
	File extension for the detailed output file. More...

Protected Attributes
ArrayList< DetailedTreeSettings >	mp_oDetailedLiveTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)
	For detailed output - collection of DetailedTreeSettings objects. More...

ArrayList< DetailedTreeSettings >	mp_oDetailedDeadTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)
	For detailed output - collection of DetailedTreeSettings objects. More...

ArrayList< DetailedGridSettings >	mp_oDetailedGridSaveSettings = new ArrayList<DetailedGridSettings>(0)
	For detailed output - collection of DetailedGridSettings objects. More...

ArrayList< Subplot >	mp_oDetailedOutputSubplots = new ArrayList<Subplot>(0)
	For detailed output - the list of Subplot objects. More...

Subplot	m_oCurrentSubplot
	When parsing an XML file, this is the subplot currently receiving data. More...

ModelFloat	m_fDetailedSubplotXCellLength
	Subplot X cell length for detailed output subplots - defaults to match plot. More...

ModelFloat	m_fDetailedSubplotYCellLength
	Subplot Y cell length for detailed output subplots - defaults to match plot. More...

ModelString	m_sDetailedOutputFilename
	File name for detailed output. More...

DetailedOutputSettings	m_oCurrentDetailedSettings
	When parsing an XML file, this is the setting currently receiving data. More...

Protected Attributes inherited from sortie.data.funcgroups.Behavior
GUIManager	m_oManager
	GUIManager object. More...

BehaviorTypeBase	m_oParent
	Parent manager. More...

ArrayList< ModelData >	mp_oAllData = new ArrayList<ModelData>()
	All data for this object. More...

ArrayList< SpeciesTypeCombo >	mp_oTreesAppliesTo = new ArrayList<SpeciesTypeCombo>(0)
	A set of SpeciesTypeCombo objects to which this behavior is applied - or none if it is not applied to trees. More...

ArrayList< Integer >	mp_iGridsAppliesTo = new ArrayList<Integer>(0)
	A set of hashcodes of the Grids to which this behavior is applied - or none if it is not applied to grids. More...

ArrayList< DataMember >	mp_oNewTreeDataMembers = new ArrayList<DataMember>(0)
	The new tree data members that this behavior adds, above and beyond the basic tree population data members. More...

boolean	m_bCanBeDuplicated = true
	Whether or not this behavior can have multiple copies in a run or not. More...

String	m_sDescriptor = ""
	This is what will be displayed as the name of a given behavior in the GUI. More...

String	m_sParFileTag = ""
	String which is used to identify this behavior in the parameter file. More...

String	m_sXMLRootString = ""
	XML tag to surround this behavior's data. More...

String	m_sHelpFileString = ""
	Help file topic identifier string. More...

boolean []	mp_bCanApplyToTreeType
	For each tree type, whether or not this behavior can be applied to it. More...

double	m_fVersion = 1.0
	Version of this behavior. More...

double	m_fMinVersion = 1.0
	Minimum version of this behavior. More...

int	m_iListPosition = -1
	This behavior's position in the behavior list. More...

setupType	m_iBehaviorSetupType

Private Member Functions
void	changeGridSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies)
	Changes species in grid settings. More...

void	changeTreeSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies)
	Change of species for tree settings. More...

boolean	verifyTreeMember (DataMember oDataMember, int iSpecies, int iType) throws ModelException
	Verify that a tree member is correct. More...

Private Attributes
TreePopulation	m_oPop
	Copy of tree population for easier parsing. More...

boolean	m_bIsActive
	Flag for whether species change has occurred - just renaming doesn't count. More...

Additional Inherited Members
Static Public Member Functions inherited from sortie.data.funcgroups.Behavior
static void	setVectorValues (ModelVector oData, Float[] p_fValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Float[] p_fValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Double[] p_fValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Double[] p_fValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Integer[] p_iValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, String[] p_sValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, String[] p_sValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Integer[] p_iValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector p_oData, ArrayList< String > p_oValuesToSet, boolean[] p_bAppliesTo) throws ModelException
	Sets the values for vector variables. More...

static void	writeDataToFile (BufferedWriter ojOut, ModelData oData) throws java.io. IOException
	Writes a piece of data to an XML file. More...

static Object []	formatBlankHeaderRow (Object[][] p_oTable)
	Creates a blank header row for a table. More...

static Object [][]	formatDataAsComboBox (Object[][] p_oExisting, ModelEnum oToFormat)
	Adds a value with combo box formatting to an Object array for display in a JTable. More...

static String	formatComboBoxString (ModelEnum oToFormat)
	Formats a combo box string from a ModelEnum. More...

static void	addDataObjectToDisplayArrays (ModelData p_oDataObject, ArrayList< ModelData > p_oSingles, ArrayList< ArrayList< SpeciesSpecific >> p_oSpeciesSpecific, boolean[] p_bAppliesTo)
	Adds a data object to the arrays which will eventually display run parameters in a set of tables. More...

static Object [][]	addDataToArray (Object[][] p_oExistingArray, Object[] p_oAddArray)
	Adds an Object array to an existing Object array. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelFloat oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelInt oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelString oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat)
	Formats a vector of values into an object array and adds it to another Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat, boolean[] p_bWhichSpecies)
	Formats a vector of values into a plain vector suitable for placing in a JTable and adds it to a vector of vectors at the end. More...

static Object []	formatSpeciesHeaderRow (boolean[] p_bUsed, TreePopulation oPop)
	Creates an object array of strings consisting of species names, suitable for including in the parameter entry table. More...

static void	ensureSize (ArrayList<?> list, int size)
	Ensure an ArrayList is at least a specific size. More...

Public Attributes inherited from sortie.data.funcgroups.Behavior
boolean	m_bMustHaveTrees = true
	If true, and a tree has no species/type combos, it automatically becomes disabled. More...

Protected Member Functions inherited from sortie.data.funcgroups.Behavior
void	setSingleValue (ModelData oDataMember, Object oData) throws ModelException
	Sets the value of a single data member. More...

BehaviorParameterDisplay	formatTable (ArrayList< ModelData > p_oSingles, ArrayList< ArrayList< SpeciesSpecific >> p_oSpeciesSpecific, TreePopulation oPop)
	Turns vector groups of data objects into a set of tables for display. More...

Static Protected Member Functions inherited from sortie.data.funcgroups.Behavior
static boolean	boolArraysEqual (boolean[] p_bArrayOne, boolean[] p_bArrayTwo)
	Tests two boolean arrays for equality. More...

Detailed Description

Corresponds to detailed output.

Author: lora

Constructor & Destructor Documentation

◆ DetailedOutput()

sortie.data.funcgroups.output.DetailedOutput.DetailedOutput	(	GUIManager	oManager,
		BehaviorTypeBase	oParent,
		String	sDescriptor,
		String	sParFileTag,
		String	sXMLRootString
	)

Constructor.

Parameters

oManager	GUIManager object
oParent	Parent managing object.
sDescriptor	The name of the behavior for the user.
sParFileTag	String which is used to identify this behavior in the parameter file.
sXMLRootString	XML tag to surround this behavior's data.

Member Function Documentation

◆ addDetailedGridSettings()

void sortie.data.funcgroups.output.DetailedOutput.addDetailedGridSettings ( DetailedGridSettings oTreeSettings )

Adds a new detailed output grid settings object.

This will overwrite any existing settings for that grid.

Parameters

oTreeSettings The new settings object.

◆ addDetailedOutputSubplot() [1/2]

Subplot sortie.data.funcgroups.output.DetailedOutput.addDetailedOutputSubplot ( String sName )

Creates a subplot for detailed output.

Parameters

sName Name of the subplot.

Returns: The new Subplot object.

◆ addDetailedOutputSubplot() [2/2]

void sortie.data.funcgroups.output.DetailedOutput.addDetailedOutputSubplot ( Subplot oSubplot )

Adds a subplot for detailed output.

Parameters

oSubplot The subplot.

◆ addDetailedTreeSettings()

void sortie.data.funcgroups.output.DetailedOutput.addDetailedTreeSettings ( DetailedTreeSettings oTreeSettings ) throws ModelException

Adds a new detailed output tree settings object.

This will overwrite any existing settings for that species and type.

Parameters

oTreeSettings The new settings object.

Exceptions

ModelException if either the type or the species name is invalid.

◆ callSetupDialog()

void sortie.data.funcgroups.output.DetailedOutput.callSetupDialog	(	JDialog	jParent,
		MainWindow	oMain
	)

Calls the output setup dialog.

◆ changeGridSpecies()

void sortie.data.funcgroups.output.DetailedOutput.changeGridSpecies	(	int	iOldNumSpecies,
		int []	p_iIndexer,
		String []	p_sNewSpecies
	)

private

Changes species in grid settings.

Parameters

iOldNumSpecies	says how many species there used to be.
p_iIndexer	is an array, sized to the new number of species. For each bucket (representing the index number of a species on the new list), the value is either the index of that same species in the old species list, or -1 if the species is new.
p_sNewSpecies	The new species list.

Exceptions

ModelException if there's a problem.

◆ changeOfPlotResolution()

void sortie.data.funcgroups.output.DetailedOutput.changeOfPlotResolution	(	float	fOldX,
		float	fOldY,
		float	fNewX,
		float	fNewY
	)		throws ModelException

Removes cells from subplots that are outside the plot.

Parameters

fOldX	float Old plot X length.
fOldY	float Old plot Y length.
fNewX	float New plot X length.
fNewY	float New plot Y length.

Exceptions

ModelException won't.

◆ changeOfSpecies()

void sortie.data.funcgroups.output.DetailedOutput.changeOfSpecies	(	int	iOldNumSpecies,
		int []	p_iIndexer,
		String []	p_sNewSpecies
	)		throws ModelException

Checks detailed output settings upon change of species.

Parameters

iOldNumSpecies	says how many species there used to be.
p_iIndexer	is an array, sized to the new number of species. For each bucket (representing the index number of a species on the new list), the value is either the index of that same species in the old species list, or -1 if the species is new.
p_sNewSpecies	The new species list.

◆ changeTreeSpecies()

void sortie.data.funcgroups.output.DetailedOutput.changeTreeSpecies	(	int	iOldNumSpecies,
		int []	p_iIndexer,
		String []	p_sNewSpecies
	)

private

Change of species for tree settings.

Parameters

iOldNumSpecies	says how many species there used to be.
p_iIndexer	is an array, sized to the new number of species. For each bucket (representing the index number of a species on the new list), the value is either the index of that same species in the old species list, or -1 if the species is new.
p_sNewSpecies	The new species list.

Exceptions

ModelException if there's a problem.

◆ clearDetailedDeadTreeSettings()

void sortie.data.funcgroups.output.DetailedOutput.clearDetailedDeadTreeSettings ( )

Deletes all detailed output tree settings for dead trees.

◆ clearDetailedGridSettings()

void sortie.data.funcgroups.output.DetailedOutput.clearDetailedGridSettings ( )

Deletes all detailed output grid settings.

◆ clearDetailedLiveTreeSettings()

void sortie.data.funcgroups.output.DetailedOutput.clearDetailedLiveTreeSettings ( )

Deletes all detailed output tree settings.

◆ clearDetailedOutputSubplots()

void sortie.data.funcgroups.output.DetailedOutput.clearDetailedOutputSubplots ( )

Clears subplot data.

◆ copySpecies()

void sortie.data.funcgroups.output.DetailedOutput.copySpecies	(	int	iSpeciesCopyFrom,
		int	iSpeciesCopyTo
	)		throws ModelException

Updates output settings when species are copied.

Parameters

iSpeciesCopyFrom	int Species to copy.
iSpeciesCopyTo	int Species that is the copy.

Exceptions

ModelException if there is a problem.

◆ getDetailedDeadTreeSetting()

DetailedTreeSettings sortie.data.funcgroups.output.DetailedOutput.getDetailedDeadTreeSetting ( int iIndex )

Returns the detailed output tree setting at a specified index.

Parameters

iIndex The index.

Returns: The DetailedTreeSettings object, or null if the index is invalid.

◆ getDetailedGridSetting()

DetailedGridSettings sortie.data.funcgroups.output.DetailedOutput.getDetailedGridSetting ( int iIndex )

Returns the detailed output grid setting at a specified index.

Parameters

iIndex The index.

Returns: The DetailedGridSettings object, or null if the index is invalid.

◆ getDetailedLiveTreeSetting()

DetailedTreeSettings sortie.data.funcgroups.output.DetailedOutput.getDetailedLiveTreeSetting ( int iIndex )

Returns the detailed output tree setting at a specified index.

Parameters

iIndex The index.

Returns: The DetailedTreeSettings object, or null if the index is invalid.

◆ getDetailedOutputFileName()

String sortie.data.funcgroups.output.DetailedOutput.getDetailedOutputFileName ( )

Gets the detailed output filename.

Returns: Filename.

◆ getDetailedSubplot()

Subplot sortie.data.funcgroups.output.DetailedOutput.getDetailedSubplot ( int iIndex )

Gets a subplot.

No error trapping.

Parameters

iIndex Index of subplot to get.

Returns: Subplot desired.

◆ getDetailedSubplotXCellLength()

float sortie.data.funcgroups.output.DetailedOutput.getDetailedSubplotXCellLength ( )

Gets the subplot X cell length.

Returns: Subplot X cell length.

◆ getDetailedSubplotYCellLength()

float sortie.data.funcgroups.output.DetailedOutput.getDetailedSubplotYCellLength ( )

Gets the subplot Y cell length.

Returns: Subplot Y cell length.

◆ getNumberOfDetailedDeadTreeSettings()

int sortie.data.funcgroups.output.DetailedOutput.getNumberOfDetailedDeadTreeSettings ( )

Gets the number of tree settings for which there is detailed output info (each setting is one tree species/type combo).

Returns: Number of settings.

◆ getNumberOfDetailedGridSettings()

int sortie.data.funcgroups.output.DetailedOutput.getNumberOfDetailedGridSettings ( )

Gets the number of grid settings for which there is detailed output info.

Returns: Number of settings.

◆ getNumberOfDetailedLiveTreeSettings()

int sortie.data.funcgroups.output.DetailedOutput.getNumberOfDetailedLiveTreeSettings ( )

Gets the number of tree settings for which there is detailed output info (each setting is one tree species/type combo).

Returns: Number of settings.

◆ getNumberOfDetailedSubplots()

int sortie.data.funcgroups.output.DetailedOutput.getNumberOfDetailedSubplots ( )

Gets the number of subplots.

Returns: Number of subplots.

◆ getTreePopulation()

TreePopulation sortie.data.funcgroups.output.DetailedOutput.getTreePopulation ( )

◆ inactivate()

void sortie.data.funcgroups.output.DetailedOutput.inactivate ( )

Clears all settings and sets this to inactive.

◆ isActive()

boolean sortie.data.funcgroups.output.DetailedOutput.isActive ( )

◆ readXMLParentTag()

void sortie.data.funcgroups.output.DetailedOutput.readXMLParentTag	(	String	sXMLTag,
		Attributes	oAttributes
	)		throws ModelException

Accepts an XML parent tag (empty, no data) from the parser.

This function watches for the following output tags:

ou_treeInfo
ou_gridInfo
so_treeTypeInfo
so_saveRBA
so_saveABA
so_saveRDN
so_saveADN
po_point

Parameters

sXMLTag	The XML tag.
oAttributes	The attributes of this object.

Exceptions

ModelException if data is missing or invalid.

◆ setDetailedOutputFileName()

void sortie.data.funcgroups.output.DetailedOutput.setDetailedOutputFileName ( String sFilename )

Sets the detailed output filename.

Parameters

sFilename Filename.

◆ setDetailedSubplotXCellLength()

void sortie.data.funcgroups.output.DetailedOutput.setDetailedSubplotXCellLength ( float fLength )

Sets the subplot X cell length.

Parameters

fLength Subplot X cell length.

◆ setDetailedSubplotYCellLength()

void sortie.data.funcgroups.output.DetailedOutput.setDetailedSubplotYCellLength ( float fLength )

Sets the subplot Y cell length.

Parameters

fLength Subplot Y cell length.

◆ setSingleValueByXMLTag()

boolean sortie.data.funcgroups.output.DetailedOutput.setSingleValueByXMLTag	(	String	sXMLTag,
		String	sXMLParentTag,
		Attributes	oAttributes,
		Object	oData
	)		throws ModelException

Sets a data object's value.

Overriden from the base class to capture output settings.

Parameters

sXMLTag	XML tag of data object whose value is to be set.
sXMLParentTag	The immediate parent tag that sXMLTag is within.
oAttributes	Attributes of XML tag
oData	Data value appropriate to the data type

Returns: true if the value was set successfully; false if the value could not be found. (This would not be an error, because I need a way to cycle through the objects until one of the objects comes up with a match.)

Exceptions

ModelException if the value could not be assigned to the data object.

◆ setVectorValueByXMLTag()

boolean sortie.data.funcgroups.output.DetailedOutput.setVectorValueByXMLTag	(	String	sXMLTag,
		String	sXMLParentTag,
		ArrayList< String >	p_oData,
		String []	p_sChildXMLTags,
		boolean []	p_bAppliesTo,
		Attributes	oParentAttributes,
		Attributes []	p_oAttributes
	)		throws ModelException

Sets a data vector's value.

Overridden from the base class. Due to the vagaries of parameter file parsing, our values may come in through here instead of in single values because there could be repeats.

Parameters

sXMLTag	Parent XML tag of data vector whose value is to be set.
sXMLParentTag	The immediate parent tag that sXMLTag is within.
p_oData	Vector of data values appropriate to the data type
p_sChildXMLTags	The XML tags of the child elements
p_bAppliesTo	Array of booleans saying which of the vector values should be set. This is important in the case of species-specifics - the vector index is the species number but not all species are set.
oParentAttributes	Attributes of parent tag. May be useful when overridding this for unusual tags.
p_oAttributes	Attributes passed from parser. This may be needed when overriding this function. Basic species-specific values are already handled by this function.

Returns: true if the value was set successfully; false if the value could not be found. (This would not be an error, because I need a way to cycle through the objects until one of the objects comes up with a match.) If a match to a data object is made via XML tag, but the found object is not a ModelVector, this returns false.

Exceptions

ModelException if the value could not be assigned to the data object.

◆ validateData()

void sortie.data.funcgroups.output.DetailedOutput.validateData ( TreePopulation oPop ) throws ModelException

Validates the data before writing to a parameter file.

Verifies all output settings are correct.

Exceptions

ModelException if the filename is empty but there are save settings.

Parameters

oPop Not used.

◆ verifyTreeMember()

boolean sortie.data.funcgroups.output.DetailedOutput.verifyTreeMember	(	DataMember	oDataMember,
		int	iSpecies,
		int	iType
	)		throws ModelException

private

Verify that a tree member is correct.

Parameters

oDataMember	DataMember Data member to verify
iSpecies	int Species for which to verify the data member
iType	int Tree type for which to verify the data member

Exceptions

ModelException Passing through from called functions

Returns: boolean True if the data member is valid for the tree species and type, false if not

◆ writeParametersToTextFile()

void sortie.data.funcgroups.output.DetailedOutput.writeParametersToTextFile	(	FileWriter	jOut,
		TreePopulation	oPop
	)		throws IOException

Override to not do anything.

◆ writeXML()

void sortie.data.funcgroups.output.DetailedOutput.writeXML	(	BufferedWriter	jOut,
		TreePopulation	oPop
	)		throws ModelException

Writes the parameter file data for detailed output.

Does nothing if there are no detailed output save settings.

Parameters

jOut	File to write
oPop	Tree population

Exceptions

ModelException passed through from file writing

Member Data Documentation

◆ DETAILED_OUTPUT_EXTENSION

final String sortie.data.funcgroups.output.DetailedOutput.DETAILED_OUTPUT_EXTENSION = ".gz.tar"

static

File extension for the detailed output file.

◆ m_bIsActive

boolean sortie.data.funcgroups.output.DetailedOutput.m_bIsActive

private

Flag for whether species change has occurred - just renaming doesn't count.

Whether or not this behavior has any save settings and is active.

◆ m_fDetailedSubplotXCellLength

ModelFloat sortie.data.funcgroups.output.DetailedOutput.m_fDetailedSubplotXCellLength

protected

Initial value:

= new ModelFloat(

Plot.CELL_LENGTH, "Subplot cell length - X (m):", "ou_subplotXLength")

Subplot X cell length for detailed output subplots - defaults to match plot.

◆ m_fDetailedSubplotYCellLength

ModelFloat sortie.data.funcgroups.output.DetailedOutput.m_fDetailedSubplotYCellLength

protected

Initial value:

= new ModelFloat(

Plot.CELL_LENGTH, "Subplot cell length - Y (m):", "ou_subplotYLength")

Subplot Y cell length for detailed output subplots - defaults to match plot.

◆ m_oCurrentDetailedSettings

DetailedOutputSettings sortie.data.funcgroups.output.DetailedOutput.m_oCurrentDetailedSettings

protected

When parsing an XML file, this is the setting currently receiving data.

◆ m_oCurrentSubplot

Subplot sortie.data.funcgroups.output.DetailedOutput.m_oCurrentSubplot

protected

When parsing an XML file, this is the subplot currently receiving data.

◆ m_oPop

TreePopulation sortie.data.funcgroups.output.DetailedOutput.m_oPop

private

Copy of tree population for easier parsing.

◆ m_sDetailedOutputFilename

ModelString sortie.data.funcgroups.output.DetailedOutput.m_sDetailedOutputFilename

protected

Initial value:

= new ModelString("",

"Detailed output filename", "ou_filename")

File name for detailed output.

◆ mp_oDetailedDeadTreeSaveSettings

ArrayList<DetailedTreeSettings> sortie.data.funcgroups.output.DetailedOutput.mp_oDetailedDeadTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)

protected

For detailed output - collection of DetailedTreeSettings objects.

◆ mp_oDetailedGridSaveSettings

ArrayList<DetailedGridSettings> sortie.data.funcgroups.output.DetailedOutput.mp_oDetailedGridSaveSettings = new ArrayList<DetailedGridSettings>(0)

protected

For detailed output - collection of DetailedGridSettings objects.

◆ mp_oDetailedLiveTreeSaveSettings

ArrayList<DetailedTreeSettings> sortie.data.funcgroups.output.DetailedOutput.mp_oDetailedLiveTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)

protected

For detailed output - collection of DetailedTreeSettings objects.

◆ mp_oDetailedOutputSubplots

ArrayList<Subplot> sortie.data.funcgroups.output.DetailedOutput.mp_oDetailedOutputSubplots = new ArrayList<Subplot>(0)

protected

For detailed output - the list of Subplot objects.

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

DetailedOutput.java

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DetailedOutput()

Member Function Documentation

◆ addDetailedGridSettings()

◆ addDetailedOutputSubplot() [1/2]

◆ addDetailedOutputSubplot() [2/2]

◆ addDetailedTreeSettings()

◆ callSetupDialog()

◆ changeGridSpecies()

◆ changeOfPlotResolution()

◆ changeOfSpecies()

◆ changeTreeSpecies()

◆ clearDetailedDeadTreeSettings()

◆ clearDetailedGridSettings()

◆ clearDetailedLiveTreeSettings()

◆ clearDetailedOutputSubplots()

◆ copySpecies()

◆ getDetailedDeadTreeSetting()

◆ getDetailedGridSetting()

◆ getDetailedLiveTreeSetting()

◆ getDetailedOutputFileName()

◆ getDetailedSubplot()

◆ getDetailedSubplotXCellLength()

◆ getDetailedSubplotYCellLength()

◆ getNumberOfDetailedDeadTreeSettings()

◆ getNumberOfDetailedGridSettings()

◆ getNumberOfDetailedLiveTreeSettings()

◆ getNumberOfDetailedSubplots()

◆ getTreePopulation()

◆ inactivate()

◆ isActive()

◆ readXMLParentTag()

◆ setDetailedOutputFileName()

◆ setDetailedSubplotXCellLength()

◆ setDetailedSubplotYCellLength()

◆ setSingleValueByXMLTag()

◆ setVectorValueByXMLTag()

◆ validateData()

◆ verifyTreeMember()

◆ writeParametersToTextFile()

◆ writeXML()

Member Data Documentation

◆ DETAILED_OUTPUT_EXTENSION

◆ m_bIsActive

◆ m_fDetailedSubplotXCellLength

◆ m_fDetailedSubplotYCellLength

◆ m_oCurrentDetailedSettings

◆ m_oCurrentSubplot

◆ m_oPop

◆ m_sDetailedOutputFilename

◆ mp_oDetailedDeadTreeSaveSettings

◆ mp_oDetailedGridSaveSettings

◆ mp_oDetailedLiveTreeSaveSettings

◆ mp_oDetailedOutputSubplots