Corresponds to short output. More...

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

Public Member Functions
	ShortOutput (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString)
	Constructor. 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	changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException
	Removes cells from subplots that are outside the plot. More...

void	updateIsActive ()
	Keeps the behavior active flag current. More...

void	inactivate ()
	Inactivates this behavior. More...

void	setSaveAbsoluteDensity (int iType, int iDeadCode, boolean bUse) throws ModelException
	Sets the save absolute density attribute for a type. More...

void	setSaveRelativeDensity (int iType, boolean bUse) throws ModelException
	Sets the save relative density attribute for a type. More...

void	setSaveAbsoluteBasalArea (int iType, int iDeadCode, boolean bUse) throws ModelException
	Sets the save absolute basal area attribute for a type. More...

void	setSaveRelativeBasalArea (int iType, boolean bUse) throws ModelException
	Sets the save relative basal area attribute for a type. More...

boolean	getSaveAbsoluteBasalArea (int iType, int iDeadCode) throws ModelException
	Gets whether or not absolute basal area is saved for a tree type. More...

boolean	getSaveRelativeBasalArea (int iType) throws ModelException
	Gets whether or not relative basal area is saved for a tree type. More...

boolean	getSaveAbsoluteDensity (int iType, int iDeadCode) throws ModelException
	Gets whether or not absolute density is saved for a tree type. More...

boolean	getSaveRelativeDensity (int iType) throws ModelException
	Gets whether or not relative density is saved for a tree type. More...

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

Subplot	addShortOutputSubplot (String sName)
	Creates a subplot for short output. More...

void	addShortOutputSubplot (Subplot oSubplot)
	Adds a subplot for short output. More...

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

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

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

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

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

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

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

void	setShortOutputFileName (String sFilename)
	Sets the short output filename. More...

String	getShortOutputFileName ()
	Gets the short output filename. More...

boolean	isActive ()

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	SUMMARY_EXTENSION = ".out"
	File extension for the summary output file. More...

Protected Attributes
ArrayList< Subplot >	mp_oShortOutputSubplots = new ArrayList<Subplot>(0)
	For short output - the list of Subplot objects. More...

ArrayList< TreeOutputSaveInfo >	mp_oShortTreeSaveSettings
	For short output - collection of TreeOutputSaveInfo objects - vector is sized number of types. More...

TreeOutputSaveInfo [][]	mp_oShortDeadTreeSaveSettings
	For short output - settings for dead trees - sized number of types by number of dead reason codes. More...

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

ModelString	m_sShortOutputFilename
	File name for short output. More...

ModelFloat	m_fShortSubplotXCellLength
	Subplot X cell length for short output subplots - defaults to match plot. More...

ModelFloat	m_fShortSubplotYCellLength
	Subplot Y cell length for short output subplots - defaults to match plot. More...

int	m_iCurrentType = -1
	When parsing an XML file, this is the current short output type. More...

int	m_iCurrentDeadCode
	When parsing an XML file, this is the current short output dead code. 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 Attributes
boolean	m_bIsActive
	Whether or not this behavior has any save settings and is active. 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 short output.

Author: lora

Constructor & Destructor Documentation

◆ ShortOutput()

sortie.data.funcgroups.output.ShortOutput.ShortOutput	(	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

◆ addShortOutputSubplot() [1/2]

Subplot sortie.data.funcgroups.output.ShortOutput.addShortOutputSubplot ( String sName )

Creates a subplot for short output.

Parameters

sName Name of the subplot.

Returns: The new Subplot object.

◆ addShortOutputSubplot() [2/2]

void sortie.data.funcgroups.output.ShortOutput.addShortOutputSubplot ( Subplot oSubplot )

Adds a subplot for short output.

Parameters

oSubplot The subplot.

◆ callSetupDialog()

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

Calls the output setup dialog.

◆ changeOfPlotResolution()

void sortie.data.funcgroups.output.ShortOutput.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.

◆ clearShortOutputSubplots()

void sortie.data.funcgroups.output.ShortOutput.clearShortOutputSubplots ( )

Clears subplot data.

◆ getNumberOfShortSubplots()

int sortie.data.funcgroups.output.ShortOutput.getNumberOfShortSubplots ( )

Gets the number of subplots.

Returns: Number of subplots.

◆ getSaveAbsoluteBasalArea()

boolean sortie.data.funcgroups.output.ShortOutput.getSaveAbsoluteBasalArea	(	int	iType,
		int	iDeadCode
	)		throws ModelException

Gets whether or not absolute basal area is saved for a tree type.

Parameters

iType	Tree type.
iDeadCode	Dead code. Use OutputBehaviors.NOTDEAD for live trees.

Returns: Save flag.

Exceptions

ModelException if the type or dead code is not valid.

◆ getSaveAbsoluteDensity()

boolean sortie.data.funcgroups.output.ShortOutput.getSaveAbsoluteDensity	(	int	iType,
		int	iDeadCode
	)		throws ModelException

Gets whether or not absolute density is saved for a tree type.

Parameters

iType	Tree type.
iDeadCode	Dead code. Use OutputBehaviors.NOTDEAD for live trees.

Returns: Save flag.

Exceptions

ModelException if the type or dead code is not valid.

◆ getSaveRelativeBasalArea()

boolean sortie.data.funcgroups.output.ShortOutput.getSaveRelativeBasalArea ( int iType ) throws ModelException

Gets whether or not relative basal area is saved for a tree type.

Parameters

iType Tree type.

Returns: Save flag.

Exceptions

ModelException if the type is not valid.

◆ getSaveRelativeDensity()

boolean sortie.data.funcgroups.output.ShortOutput.getSaveRelativeDensity ( int iType ) throws ModelException

Gets whether or not relative density is saved for a tree type.

Parameters

iType Tree type.

Returns: Save flag.

Exceptions

ModelException if the type is not valid.

◆ getShortOutputFileName()

String sortie.data.funcgroups.output.ShortOutput.getShortOutputFileName ( )

Gets the short output filename.

Returns: Filename.

◆ getShortSubplot()

Subplot sortie.data.funcgroups.output.ShortOutput.getShortSubplot ( int iIndex )

Gets a subplot.

No error trapping.

Parameters

iIndex Index of subplot to get.

Returns: Subplot desired.

◆ getShortSubplotXCellLength()

float sortie.data.funcgroups.output.ShortOutput.getShortSubplotXCellLength ( )

Gets the subplot X cell length.

Returns: Subplot X cell length.

◆ getShortSubplotYCellLength()

float sortie.data.funcgroups.output.ShortOutput.getShortSubplotYCellLength ( )

Gets the subplot Y cell length.

Returns: Subplot Y cell length.

◆ inactivate()

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

Inactivates this behavior.

Sets all saves to false.

◆ isActive()

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

◆ readXMLParentTag()

void sortie.data.funcgroups.output.ShortOutput.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.

◆ setSaveAbsoluteBasalArea()

void sortie.data.funcgroups.output.ShortOutput.setSaveAbsoluteBasalArea	(	int	iType,
		int	iDeadCode,
		boolean	bUse
	)		throws ModelException

Sets the save absolute basal area attribute for a type.

This is ignored if it's not sapling or adult.

Parameters

iType	Tree type.
iDeadCode	Dead code. Use OutputBehaviors.NOTDEAD for live trees.
bUse	Whether or not to use this.

Exceptions

ModelException If the type or dead code is not valid.

◆ setSaveAbsoluteDensity()

void sortie.data.funcgroups.output.ShortOutput.setSaveAbsoluteDensity	(	int	iType,
		int	iDeadCode,
		boolean	bUse
	)		throws ModelException

Sets the save absolute density attribute for a type.

Parameters

iType	Tree type.
iDeadCode	Dead code. Use OutputBehaviors.NOTDEAD for live trees.
bUse	Whether or not to use this.

Exceptions

ModelException If the type or dead code is not valid.

◆ setSaveRelativeBasalArea()

void sortie.data.funcgroups.output.ShortOutput.setSaveRelativeBasalArea	(	int	iType,
		boolean	bUse
	)		throws ModelException

Sets the save relative basal area attribute for a type.

This is ignored if it's not sapling or adult.

Parameters

iType	Tree type.
bUse	Whether or not to use this.

Exceptions

ModelException If the type is not valid.

◆ setSaveRelativeDensity()

void sortie.data.funcgroups.output.ShortOutput.setSaveRelativeDensity	(	int	iType,
		boolean	bUse
	)		throws ModelException

Sets the save relative density attribute for a type.

Parameters

iType	Tree type.
bUse	Whether or not to use this.

Exceptions

ModelException If the type is not valid.

◆ setShortOutputFileName()

void sortie.data.funcgroups.output.ShortOutput.setShortOutputFileName ( String sFilename )

Sets the short output filename.

Parameters

sFilename Filename.

◆ setShortSubplotXCellLength()

void sortie.data.funcgroups.output.ShortOutput.setShortSubplotXCellLength ( float fLength )

Sets the subplot X cell length.

Parameters

fLength Subplot X cell length.

◆ setShortSubplotYCellLength()

void sortie.data.funcgroups.output.ShortOutput.setShortSubplotYCellLength ( float fLength )

Sets the subplot Y cell length.

Parameters

fLength Subplot Y cell length.

◆ setSingleValueByXMLTag()

boolean sortie.data.funcgroups.output.ShortOutput.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.ShortOutput.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.

◆ updateIsActive()

void sortie.data.funcgroups.output.ShortOutput.updateIsActive ( )

Keeps the behavior active flag current.

Any change of save flags has the potential to enable the behavior (by making the first save flag true) or unenabling (by making the last save flag false).

◆ validateData()

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

Validates the data before writing to a parameter file.

Exceptions

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

Parameters

oPop Not used.

◆ writeParametersToTextFile()

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

Override to not do anything.

◆ writeXML()

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

Writes the parameter file data for short output.

Does nothing if there are no short output save settings.

Parameters

jOut	File to write
oPop	Tree population

Exceptions

ModelException passed through from file writing

Member Data Documentation

◆ m_bIsActive

boolean sortie.data.funcgroups.output.ShortOutput.m_bIsActive

private

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

◆ m_fShortSubplotXCellLength

ModelFloat sortie.data.funcgroups.output.ShortOutput.m_fShortSubplotXCellLength

protected

Initial value:

= new ModelFloat(

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

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

◆ m_fShortSubplotYCellLength

ModelFloat sortie.data.funcgroups.output.ShortOutput.m_fShortSubplotYCellLength

protected

Initial value:

= new ModelFloat(

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

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

◆ m_iCurrentDeadCode

int sortie.data.funcgroups.output.ShortOutput.m_iCurrentDeadCode

protected

When parsing an XML file, this is the current short output dead code.

◆ m_iCurrentType

int sortie.data.funcgroups.output.ShortOutput.m_iCurrentType = -1

protected

When parsing an XML file, this is the current short output type.

◆ m_oCurrentSubplot

Subplot sortie.data.funcgroups.output.ShortOutput.m_oCurrentSubplot

protected

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

◆ m_sShortOutputFilename

ModelString sortie.data.funcgroups.output.ShortOutput.m_sShortOutputFilename

protected

Initial value:

= new ModelString("",

"Filename for summary output", "so_filename")

File name for short output.

◆ mp_oShortDeadTreeSaveSettings

TreeOutputSaveInfo [][] sortie.data.funcgroups.output.ShortOutput.mp_oShortDeadTreeSaveSettings

protected

Initial value:

= new

TreeOutputSaveInfo[TreePopulation.getNumberOfTypes()][OutputBehaviors.NUMCODES]

For short output - settings for dead trees - sized number of types by number of dead reason codes.

◆ mp_oShortOutputSubplots

ArrayList<Subplot> sortie.data.funcgroups.output.ShortOutput.mp_oShortOutputSubplots = new ArrayList<Subplot>(0)

protected

For short output - the list of Subplot objects.

◆ mp_oShortTreeSaveSettings

ArrayList<TreeOutputSaveInfo> sortie.data.funcgroups.output.ShortOutput.mp_oShortTreeSaveSettings

protected

Initial value:

=

new ArrayList<TreeOutputSaveInfo>(0)

For short output - collection of TreeOutputSaveInfo objects - vector is sized number of types.

◆ SUMMARY_EXTENSION

final String sortie.data.funcgroups.output.ShortOutput.SUMMARY_EXTENSION = ".out"

static

File extension for the summary output file.

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

ShortOutput.java

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShortOutput()

Member Function Documentation

◆ addShortOutputSubplot() [1/2]

◆ addShortOutputSubplot() [2/2]

◆ callSetupDialog()

◆ changeOfPlotResolution()

◆ clearShortOutputSubplots()

◆ getNumberOfShortSubplots()

◆ getSaveAbsoluteBasalArea()

◆ getSaveAbsoluteDensity()

◆ getSaveRelativeBasalArea()

◆ getSaveRelativeDensity()

◆ getShortOutputFileName()

◆ getShortSubplot()

◆ getShortSubplotXCellLength()

◆ getShortSubplotYCellLength()

◆ inactivate()

◆ isActive()

◆ readXMLParentTag()

◆ setSaveAbsoluteBasalArea()

◆ setSaveAbsoluteDensity()

◆ setSaveRelativeBasalArea()

◆ setSaveRelativeDensity()

◆ setShortOutputFileName()

◆ setShortSubplotXCellLength()

◆ setShortSubplotYCellLength()

◆ setSingleValueByXMLTag()

◆ setVectorValueByXMLTag()

◆ updateIsActive()

◆ validateData()

◆ writeParametersToTextFile()

◆ writeXML()

Member Data Documentation

◆ m_bIsActive

◆ m_fShortSubplotXCellLength

◆ m_fShortSubplotYCellLength

◆ m_iCurrentDeadCode

◆ m_iCurrentType

◆ m_oCurrentSubplot

◆ m_sShortOutputFilename

◆ mp_oShortDeadTreeSaveSettings

◆ mp_oShortOutputSubplots

◆ mp_oShortTreeSaveSettings

◆ SUMMARY_EXTENSION