Manages output behaviors and data. More...

Inheritance diagram for sortie.data.funcgroups.OutputBehaviors:

Public Member Functions
	OutputBehaviors (GUIManager oManager) throws ModelException
	Constructor. More...

void	writeBehaviorNodes (BufferedWriter out, TreePopulation oPop) throws ModelException
	Overwritten to only write the nodes if they're enabled. More...

ArrayList< Behavior >	getAllInstantiatedBehaviors ()
	Overridden to only return the activated output behaviors. More...

Behavior	createBehaviorFromParameterFileTag (String sParameterFileTag) throws ModelException
	Overridden from base to ignore this. More...

void	removeBehavior (Behavior oBeh)
	Overridden from base to inactivate. More...

ShortOutput	getShortOutput ()
	Gets short output. More...

DetailedOutput	getDetailedOutput ()
	Gets detailed output. More...

boolean	savingShortOutputData ()
	Gets whether or not short output is being saved. More...

void	displayWindow (MainWindow oWindow)
	Displays the output setup options. More...

Public Member Functions inherited from sortie.data.funcgroups.BehaviorTypeBase
	BehaviorTypeBase (GUIManager oManager, String sName)
	Constructor. More...

boolean	anyBehaviorsEnabled ()
	Determines if any of the child behaviors are currently enabled. More...

void	validateData (TreePopulation oPop) throws ModelException
	Implements data checking. More...

Behavior	createBehaviorFromParameterFileTag (String sParameterFileTag) throws ModelException
	Creates a new behavior from an XML parameter file name tag and inserts it into the child behaviors list. More...

void	sortBehaviors ()
	Sorts the behaviors by list position. More...

boolean	canBehaviorBeDuplicated (String sParameterFileTag) throws ModelException
	Whether or not a behavior of a certain class can be duplicated in a run. More...

boolean	doesBehaviorNeedTrees (String sParameterFileTag) throws ModelException
	Whether or not a behavior of a certain class can be duplicated in a run. More...

ArrayList< BehaviorInstantiator >	getAllPossibleBehaviors ()
	Gets all possible behaviors. More...

Behavior	getBehaviorByXMLParametersParentTag (String sXMLTag, int iPos)
	Finds a behavior by its XML parameters parent tag. More...

String	getDescriptor (String sParameterFileTag)
	Gets the descriptor for a behavior based on its parameter file tag. More...

Grid []	getEnabledGridObjects () throws ModelException
	Gets the list of grid objects which the currently enabled behaviors would be expected to create - and thus would be available to output, etc. More...

ArrayList< Behavior >	getAllInstantiatedBehaviors ()
	Get the list of child behaviors currently selected for the run. More...

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

ArrayList< Behavior >	getBehaviorByDisplayName (String sDescriptor)
	Convenience method for getting an instantiated behavior. More...

ArrayList< Behavior >	getBehaviorByParameterFileTag (String sParameterFileTag)
	Finds an instantiated behavior by its XML parameter file tag. More...

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

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

void	endOfParameterFileRead ()
	Allows child behaviors to do end-of-parameter-file tasks. More...

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

GUIManager	getGUIManager ()

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	removeBehavior (Behavior oBeh)
	Removes a behavior from the instantiated list. More...

String	getName ()
	Returns the user-acceptable name for this object. More...

void	changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException
	Allows instantiated behaviors to perform any tasks associated with a change of plot resolution. More...

void	doSetup (TreePopulation oPop) throws ModelException
	Does any needed setup once the tree population object has data. More...

Static Public Attributes
static final int	NOTDEAD = 0
	Dead code for not dead - matches definition in C++. More...

static final int	HARVEST = 1
	Dead code for harvest - matches definition in C++. More...

static final int	NATURAL = 2
	Dead code for natural mortality - matches definition in C++. More...

static final int	DISEASE = 3
	Dead code for disease - matches definition in C++. More...

static final int	FIRE = 4
	Dead code for fire - matches definition in C++. More...

static final int	INSECTS = 5
	Dead code for insects - matches definition in C++. More...

static final int	STORM = 6
	Dead code for storm - matches definition in C++. More...

static final int	NUMCODES = 7
	Total number of dead reason codes. More...

Additional Inherited Members
Static Public Member Functions inherited from sortie.data.funcgroups.BehaviorTypeBase
static boolean []	mergeBooleans (boolean[] p_oMergeOne, boolean[] p_oMergeTwo)
	Merges two boolean arrays and returns an array where there is a true in each array bucket where EITHER array is true. More...

Protected Attributes inherited from sortie.data.funcgroups.BehaviorTypeBase
ArrayList< Behavior >	mp_oInstantiatedBehaviors
	List of child behaviors currently selected for the run. More...

ArrayList< BehaviorInstantiator >	mp_oAvailableBehaviors
	List of possible behaviors that can be created. More...

GUIManager	m_oManager
	GUIManager object. More...

String	m_sName
	User-consumable name for this object. More...

Detailed Description

Manages output behaviors and data.

Output behaviors are always instantiated. Copyright: Copyright (c) Charles D. Canham 2011 Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

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

Constructor & Destructor Documentation

◆ OutputBehaviors()

sortie.data.funcgroups.OutputBehaviors.OutputBehaviors ( GUIManager oManager ) throws ModelException

Constructor.

Parameters

oManager GUIManager object.

Member Function Documentation

◆ createBehaviorFromParameterFileTag()

Behavior sortie.data.funcgroups.OutputBehaviors.createBehaviorFromParameterFileTag ( String sParameterFileTag ) throws ModelException

Overridden from base to ignore this.

The previously instantiated behaviors are returned.

◆ displayWindow()

void sortie.data.funcgroups.OutputBehaviors.displayWindow ( MainWindow oWindow )

Displays the output setup options.

Parameters

oWindow Main application window.

◆ getAllInstantiatedBehaviors()

ArrayList<Behavior> sortie.data.funcgroups.OutputBehaviors.getAllInstantiatedBehaviors ( )

Overridden to only return the activated output behaviors.

◆ getDetailedOutput()

DetailedOutput sortie.data.funcgroups.OutputBehaviors.getDetailedOutput ( )

Gets detailed output.

Returns: Detailed output.

◆ getShortOutput()

ShortOutput sortie.data.funcgroups.OutputBehaviors.getShortOutput ( )

Gets short output.

Returns: Short output.

◆ removeBehavior()

void sortie.data.funcgroups.OutputBehaviors.removeBehavior ( Behavior oBeh )

Overridden from base to inactivate.

◆ savingShortOutputData()

boolean sortie.data.funcgroups.OutputBehaviors.savingShortOutputData ( )

Gets whether or not short output is being saved.

Returns: Save status.

◆ writeBehaviorNodes()

void sortie.data.funcgroups.OutputBehaviors.writeBehaviorNodes	(	BufferedWriter	out,
		TreePopulation	oPop
	)		throws ModelException

Overwritten to only write the nodes if they're enabled.

Member Data Documentation

◆ DISEASE

final int sortie.data.funcgroups.OutputBehaviors.DISEASE = 3

static

Dead code for disease - matches definition in C++.

◆ FIRE

final int sortie.data.funcgroups.OutputBehaviors.FIRE = 4

static

Dead code for fire - matches definition in C++.

◆ HARVEST

final int sortie.data.funcgroups.OutputBehaviors.HARVEST = 1

static

Dead code for harvest - matches definition in C++.

◆ INSECTS

final int sortie.data.funcgroups.OutputBehaviors.INSECTS = 5

static

Dead code for insects - matches definition in C++.

◆ NATURAL

final int sortie.data.funcgroups.OutputBehaviors.NATURAL = 2

static

Dead code for natural mortality - matches definition in C++.

◆ NOTDEAD

final int sortie.data.funcgroups.OutputBehaviors.NOTDEAD = 0

static

Dead code for not dead - matches definition in C++.

◆ NUMCODES

final int sortie.data.funcgroups.OutputBehaviors.NUMCODES = 7

static

Total number of dead reason codes.

◆ STORM

final int sortie.data.funcgroups.OutputBehaviors.STORM = 6

static

Dead code for storm - matches definition in C++.

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

data/funcgroups/OutputBehaviors.java

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputBehaviors()

Member Function Documentation

◆ createBehaviorFromParameterFileTag()

◆ displayWindow()

◆ getAllInstantiatedBehaviors()

◆ getDetailedOutput()

◆ getShortOutput()

◆ removeBehavior()

◆ savingShortOutputData()

◆ writeBehaviorNodes()

Member Data Documentation

◆ DISEASE

◆ FIRE

◆ HARVEST

◆ INSECTS

◆ NATURAL

◆ NOTDEAD

◆ NUMCODES

◆ STORM