Window used by the user to set up detailed output output options for dead trees. More...

Inheritance diagram for sortie.gui.DetailedOutputDeadTreeSetup:

Public Member Functions
	DetailedOutputDeadTreeSetup (JDialog oParent, DetailedOutput oOutput)
	Constructor. More...

void	saveAll () throws ModelException
	Causes all possible tree data members to be saved for the run. More...

void	actionPerformed (ActionEvent oEvent)
	Performs the actions of the window. More...

Private Member Functions
void	collectTreeDataMembers (TreePopulation oPop) throws ModelException
	Collects together the tree data members that will be displayed. More...

void	saveData () throws ModelException
	Saves the settings collected by this window to the OutputBehaviors object. More...

void	loadSettings ()
	Loads the settings from output into this form's temp array for display. More...

void	updateSaves ()
	Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings. More...

void	createGUI ()

JPanel	createTreeTypePanel (int iType)
	Builds GUI. More...

void	addButtonActionPerformed (int iType) throws ModelException
	Serves as the common function for adding settings entered when the user clicks an "Add" button. More...

void	removeButtonActionPerformed (int iType)
	Serves as the common function for removing settings entered when the user clicks a "Remove" button. More...

Private Attributes
DetailedOutput	m_oOutput
	For exchanging data with. More...

ArrayList< DetailedTreeSettings >	mp_oDetailedTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)
	Temp collection of settings - vector of DetailedTreeSettings objects. More...

String	m_sHelpID = "windows.detailed_output_tree_setup"
	The help ID for this window. More...

boolean [][]	mp_bSeedlingDataMembersBySpecies
	For each seedling data member, whether it's used by a particular species. More...

boolean [][]	mp_bSaplingDataMembersBySpecies
	For each sapling data member, whether it's used by a particular species. More...

boolean [][]	mp_bAdultDataMembersBySpecies
	For each adult data member, whether it's used by a particular species. More...

boolean [][]	mp_bSnagDataMembersBySpecies
	For each snag data member, whether it's used by a particular species. More...

boolean	m_bIsSnagAware = false
	Whether or not this run is snag-aware and any snags should be saved. More...

JTextField	m_jSeedlingTimestepsEdit = new JTextField()
	Edit box for entering how often to save. More...

JTextField	m_jSaplingTimestepsEdit = new JTextField()
	Edit box for entering how often to save. More...

JTextField	m_jAdultTimestepsEdit = new JTextField()
	Edit box for entering how often to save. More...

JTextField	m_jSnagTimestepsEdit = new JTextField()
	Edit box for entering how often to save. More...

DefaultListModel< DataMember >	m_jSeedlingDataMemberListModel
	List model for the seedling data member list. More...

DefaultListModel< DataMember >	m_jSaplingDataMemberListModel = new DefaultListModel<DataMember>()
	List model for the sapling data member list. More...

DefaultListModel< DataMember >	m_jAdultDataMemberListModel = new DefaultListModel<DataMember>()
	List model for the adult data member list. More...

DefaultListModel< DataMember >	m_jSnagDataMemberListModel = new DefaultListModel<DataMember>()
	List model for the snag data member list. More...

DefaultListModel< String >	m_jSpeciesListModel = new DefaultListModel<String>()
	List model for the species list. More...

DefaultListModel< String >	m_jSeedlingSaveListModel = new DefaultListModel<String>()
	List model for the seedling saved data member list. More...

DefaultListModel< String >	m_jSaplingSaveListModel = new DefaultListModel<String>()
	List model for the sapling saved data member list. More...

DefaultListModel< String >	m_jAdultSaveListModel = new DefaultListModel<String>()
	List model for the adult saved data member list. More...

DefaultListModel< String >	m_jSnagSaveListModel = new DefaultListModel<String>()
	List model for the snag saved data member list. More...

DefaultListModel< String >	m_jDeadCodesListModel = new DefaultListModel<String>()
	List model for the dead reason codes list. More...

JList< DataMember >	m_jSeedlingDataMemberList = new JList<DataMember>(m_jSeedlingDataMemberListModel)
	Seedling data member list. More...

JList< String >	m_jSeedlingSpeciesList = new JList<String>(m_jSpeciesListModel)
	Seedling species list. More...

JList< String >	m_jSeedlingSaveList = new JList<String>(m_jSeedlingSaveListModel)
	Seedling save list. More...

JList< String >	m_jSaplingSpeciesList = new JList<String>(m_jSpeciesListModel)
	Sapling species list. More...

JList< String >	m_jSaplingSaveList = new JList<String>(m_jSaplingSaveListModel)
	Sapling save list. More...

JList< DataMember >	m_jSaplingDataMemberList = new JList<DataMember>(m_jSaplingDataMemberListModel)
	Sapling data member list. More...

JList< String >	m_jAdultSpeciesList = new JList<String>(m_jSpeciesListModel)
	Adult species list. More...

JList< String >	m_jAdultSaveList = new JList<String>(m_jAdultSaveListModel)
	Adult save list. More...

JList< DataMember >	m_jAdultDataMemberList = new JList<DataMember>(m_jAdultDataMemberListModel)
	Adult data member list. More...

JList< String >	m_jSnagSpeciesList = new JList<String>(m_jSpeciesListModel)
	Snag species list. More...

JList< String >	m_jSnagSaveList = new JList<String>(m_jSnagSaveListModel)
	Snag save list. More...

JList< DataMember >	m_jSnagDataMemberList = new JList<DataMember>(m_jSnagDataMemberListModel)
	Snag data member list. More...

JList< String >	m_jSeedlingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
	Seedling dead code list. More...

JList< String >	m_jSaplingDeadCodeList = new JList<String>(m_jDeadCodesListModel)
	Sapling dead code list. More...

JList< String >	m_jAdultDeadCodeList = new JList<String>(m_jDeadCodesListModel)
	Adult dead code list. More...

JList< String >	m_jSnagDeadCodeList = new JList<String>(m_jDeadCodesListModel)
	Snag dead code list. More...

Detailed Description

Window used by the user to set up detailed output output options for dead trees.

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

◆ DetailedOutputDeadTreeSetup()

sortie.gui.DetailedOutputDeadTreeSetup.DetailedOutputDeadTreeSetup	(	JDialog	oParent,
		DetailedOutput	oOutput
	)

Constructor.

Parameters

oParent	Parent window in which to display this dialog.
oOutput	DetailedOutput object.

Member Function Documentation

◆ actionPerformed()

void sortie.gui.DetailedOutputDeadTreeSetup.actionPerformed ( ActionEvent oEvent )

Performs the actions of the window.

Parameters

oEvent ActionEvent object.

◆ addButtonActionPerformed()

void sortie.gui.DetailedOutputDeadTreeSetup.addButtonActionPerformed ( int iType ) throws ModelException

private

Serves as the common function for adding settings entered when the user clicks an "Add" button.

Parameters

iType The tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.

Exceptions

ModelException if the run is not snag-aware but someone is trying to save snag settings.

◆ collectTreeDataMembers()

void sortie.gui.DetailedOutputDeadTreeSetup.collectTreeDataMembers ( TreePopulation oPop ) throws ModelException

private

Collects together the tree data members that will be displayed.

Parameters

oPop	Tree population object.

Exceptions

ModelException passed through from called functions. Should never be thrown.

◆ createGUI()

void sortie.gui.DetailedOutputDeadTreeSetup.createGUI ( )

private

◆ createTreeTypePanel()

JPanel sortie.gui.DetailedOutputDeadTreeSetup.createTreeTypePanel ( int iType )

private

Builds GUI.

Exceptions

java.lang.Exception if there's a problem.

◆ loadSettings()

void sortie.gui.DetailedOutputDeadTreeSetup.loadSettings ( )

private

Loads the settings from output into this form's temp array for display.

◆ removeButtonActionPerformed()

void sortie.gui.DetailedOutputDeadTreeSetup.removeButtonActionPerformed ( int iType )

private

Serves as the common function for removing settings entered when the user clicks a "Remove" button.

Parameters

iType The tree type (TreePopulation.SEEDLING, TreePopulation.SAPLING, TreePopulation.ADULT, or TreePopulation.SNAG) that is firing the button.

◆ saveAll()

void sortie.gui.DetailedOutputDeadTreeSetup.saveAll ( ) throws ModelException

Causes all possible tree data members to be saved for the run.

This can be called without the window's being visible. Its results are immediately applied to the output behavior - so this is not subject to a Cancel button.

Exceptions

ModelException passed through from called methods.

◆ saveData()

void sortie.gui.DetailedOutputDeadTreeSetup.saveData ( ) throws ModelException

private

Saves the settings collected by this window to the OutputBehaviors object.

Exceptions

ModelException passed through from called methods.

◆ updateSaves()

void sortie.gui.DetailedOutputDeadTreeSetup.updateSaves ( )

private

Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.

Member Data Documentation

◆ m_bIsSnagAware

boolean sortie.gui.DetailedOutputDeadTreeSetup.m_bIsSnagAware = false

private

Whether or not this run is snag-aware and any snags should be saved.

◆ m_jAdultDataMemberList

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDataMemberList = new JList<DataMember>(m_jAdultDataMemberListModel)

private

Adult data member list.

◆ m_jAdultDataMemberListModel

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDataMemberListModel = new DefaultListModel<DataMember>()

private

List model for the adult data member list.

◆ m_jAdultDeadCodeList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultDeadCodeList = new JList<String>(m_jDeadCodesListModel)

private

Adult dead code list.

◆ m_jAdultSaveList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSaveList = new JList<String>(m_jAdultSaveListModel)

private

Adult save list.

◆ m_jAdultSaveListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSaveListModel = new DefaultListModel<String>()

private

List model for the adult saved data member list.

◆ m_jAdultSpeciesList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultSpeciesList = new JList<String>(m_jSpeciesListModel)

private

Adult species list.

◆ m_jAdultTimestepsEdit

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jAdultTimestepsEdit = new JTextField()

private

Edit box for entering how often to save.

◆ m_jDeadCodesListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jDeadCodesListModel = new DefaultListModel<String>()

private

List model for the dead reason codes list.

◆ m_jSaplingDataMemberList

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDataMemberList = new JList<DataMember>(m_jSaplingDataMemberListModel)

private

Sapling data member list.

◆ m_jSaplingDataMemberListModel

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDataMemberListModel = new DefaultListModel<DataMember>()

private

List model for the sapling data member list.

◆ m_jSaplingDeadCodeList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingDeadCodeList = new JList<String>(m_jDeadCodesListModel)

private

Sapling dead code list.

◆ m_jSaplingSaveList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSaveList = new JList<String>(m_jSaplingSaveListModel)

private

Sapling save list.

◆ m_jSaplingSaveListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSaveListModel = new DefaultListModel<String>()

private

List model for the sapling saved data member list.

◆ m_jSaplingSpeciesList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingSpeciesList = new JList<String>(m_jSpeciesListModel)

private

Sapling species list.

◆ m_jSaplingTimestepsEdit

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSaplingTimestepsEdit = new JTextField()

private

Edit box for entering how often to save.

◆ m_jSeedlingDataMemberList

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDataMemberList = new JList<DataMember>(m_jSeedlingDataMemberListModel)

private

Seedling data member list.

◆ m_jSeedlingDataMemberListModel

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDataMemberListModel

private

Initial value:

= new

DefaultListModel<DataMember>()

List model for the seedling data member list.

◆ m_jSeedlingDeadCodeList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingDeadCodeList = new JList<String>(m_jDeadCodesListModel)

private

Seedling dead code list.

◆ m_jSeedlingSaveList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSaveList = new JList<String>(m_jSeedlingSaveListModel)

private

Seedling save list.

◆ m_jSeedlingSaveListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSaveListModel = new DefaultListModel<String>()

private

List model for the seedling saved data member list.

◆ m_jSeedlingSpeciesList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingSpeciesList = new JList<String>(m_jSpeciesListModel)

private

Seedling species list.

◆ m_jSeedlingTimestepsEdit

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSeedlingTimestepsEdit = new JTextField()

private

Edit box for entering how often to save.

◆ m_jSnagDataMemberList

JList<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDataMemberList = new JList<DataMember>(m_jSnagDataMemberListModel)

private

Snag data member list.

◆ m_jSnagDataMemberListModel

DefaultListModel<DataMember> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDataMemberListModel = new DefaultListModel<DataMember>()

private

List model for the snag data member list.

◆ m_jSnagDeadCodeList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagDeadCodeList = new JList<String>(m_jDeadCodesListModel)

private

Snag dead code list.

◆ m_jSnagSaveList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSaveList = new JList<String>(m_jSnagSaveListModel)

private

Snag save list.

◆ m_jSnagSaveListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSaveListModel = new DefaultListModel<String>()

private

List model for the snag saved data member list.

◆ m_jSnagSpeciesList

JList<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagSpeciesList = new JList<String>(m_jSpeciesListModel)

private

Snag species list.

◆ m_jSnagTimestepsEdit

JTextField sortie.gui.DetailedOutputDeadTreeSetup.m_jSnagTimestepsEdit = new JTextField()

private

Edit box for entering how often to save.

◆ m_jSpeciesListModel

DefaultListModel<String> sortie.gui.DetailedOutputDeadTreeSetup.m_jSpeciesListModel = new DefaultListModel<String>()

private

List model for the species list.

◆ m_oOutput

DetailedOutput sortie.gui.DetailedOutputDeadTreeSetup.m_oOutput

private

For exchanging data with.

◆ m_sHelpID

String sortie.gui.DetailedOutputDeadTreeSetup.m_sHelpID = "windows.detailed_output_tree_setup"

private

The help ID for this window.

◆ mp_bAdultDataMembersBySpecies

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bAdultDataMembersBySpecies

private

For each adult data member, whether it's used by a particular species.

Array is sized number of adult data members by number of species.

◆ mp_bSaplingDataMembersBySpecies

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSaplingDataMembersBySpecies

private

For each sapling data member, whether it's used by a particular species.

Array is sized number of sapling data members by number of species.

◆ mp_bSeedlingDataMembersBySpecies

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSeedlingDataMembersBySpecies

private

For each seedling data member, whether it's used by a particular species.

Array is sized number of seedling data members by number of species.

◆ mp_bSnagDataMembersBySpecies

boolean [][] sortie.gui.DetailedOutputDeadTreeSetup.mp_bSnagDataMembersBySpecies

private

For each snag data member, whether it's used by a particular species.

Array is sized number of snag data members by number of species.

◆ mp_oDetailedTreeSaveSettings

ArrayList<DetailedTreeSettings> sortie.gui.DetailedOutputDeadTreeSetup.mp_oDetailedTreeSaveSettings = new ArrayList<DetailedTreeSettings>(0)

private

Temp collection of settings - vector of DetailedTreeSettings objects.

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

DetailedOutputDeadTreeSetup.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DetailedOutputDeadTreeSetup()

Member Function Documentation

◆ actionPerformed()

◆ addButtonActionPerformed()

◆ collectTreeDataMembers()

◆ createGUI()

◆ createTreeTypePanel()

◆ loadSettings()

◆ removeButtonActionPerformed()

◆ saveAll()

◆ saveData()

◆ updateSaves()

Member Data Documentation

◆ m_bIsSnagAware

◆ m_jAdultDataMemberList

◆ m_jAdultDataMemberListModel

◆ m_jAdultDeadCodeList

◆ m_jAdultSaveList

◆ m_jAdultSaveListModel

◆ m_jAdultSpeciesList

◆ m_jAdultTimestepsEdit

◆ m_jDeadCodesListModel

◆ m_jSaplingDataMemberList

◆ m_jSaplingDataMemberListModel

◆ m_jSaplingDeadCodeList

◆ m_jSaplingSaveList

◆ m_jSaplingSaveListModel

◆ m_jSaplingSpeciesList

◆ m_jSaplingTimestepsEdit

◆ m_jSeedlingDataMemberList

◆ m_jSeedlingDataMemberListModel

◆ m_jSeedlingDeadCodeList

◆ m_jSeedlingSaveList

◆ m_jSeedlingSaveListModel

◆ m_jSeedlingSpeciesList

◆ m_jSeedlingTimestepsEdit

◆ m_jSnagDataMemberList

◆ m_jSnagDataMemberListModel

◆ m_jSnagDeadCodeList

◆ m_jSnagSaveList

◆ m_jSnagSaveListModel

◆ m_jSnagSpeciesList

◆ m_jSnagTimestepsEdit

◆ m_jSpeciesListModel

◆ m_oOutput

◆ m_sHelpID

◆ mp_bAdultDataMembersBySpecies

◆ mp_bSaplingDataMembersBySpecies

◆ mp_bSeedlingDataMembersBySpecies

◆ mp_bSnagDataMembersBySpecies

◆ mp_oDetailedTreeSaveSettings