Public Member Functions | |
GUIManager (MainWindow oWindow) throws ModelException | |
Constructor. | |
boolean | HasParameterFileBeenModified () |
Whether or not the current parameter file has been modified. | |
HelpBroker | GetHelpBroker () |
Gets the HelpBroker object which manages help display for the entire application. | |
void | ProposeNewParameterFile () throws ModelException |
This can be used to propose that a new parameter file is being created. | |
String | GetParameterFileName () |
Gets the parameter file name. | |
void | DisplayOutputWindow () |
Display the window which allows the user to set up output options. | |
void | DisplayTreeSetupWindow () |
Displays the window which allows the user to set up trees. | |
void | DisplayGridSetupWindow () |
Displays the window which allows the user to set up grids. | |
void | InputTreeMap (String sFileName) throws ModelException |
This passes a tree map file on to the tree population. | |
boolean | InputXMLFile (String sFileName, JFrame oWindow) throws ModelException |
Accepts an XML file for input. | |
boolean | GetSnagAwareness () throws ModelException |
Gets whether or not the run is snag-aware. | |
boolean | WriteParameterFile (String sFileName) throws ModelException |
Writes out the XML parameter file with the current settings. | |
MainWindow | GetMainWindow () |
Gets the MainWindow object. | |
String[] | GetBehaviorList (int iSpecies, int iType) |
Gets the descriptive names list of behaviors for a tree species/type combo. | |
void | SetBehaviorList (SpeciesTypeCombo oToSet, String[] p_sBehaviors) throws ModelException |
Sets the list of behaviors for a tree species/type combo. | |
String | PrepToRun () throws ModelException |
Takes all loaded data and prepares a parameter file to pass to the core to run, returning the filename of the parameter file. | |
void | CreateNewParameterFile () throws ModelException |
Performs the actions necessary to start a new parameter file. | |
OutputBehaviors | GetOutputBehaviors () |
Gets the OutputBehaviors object, or null if none exists. | |
DisperseBehaviors | GetDisperseBehaviors () |
Gets the DisperseBehaviors object, or null if none exists. | |
AnalysisBehaviors | GetAnalysisBehaviors () |
Gets the AnalysisBehaviors object, or null if none exists. | |
EstablishmentBehaviors | GetEstablishmentBehaviors () |
Gets the EstablishmentBehaviors object, or null if none exists. | |
SubstrateBehaviors | GetSubstrateBehaviors () |
Gets the Substrate object. | |
MortalityBehaviors | GetMortalityBehaviors () |
Gets the MortalityBehaviors object. | |
GrowthBehaviors | GetGrowthBehaviors () |
Gets the GrowthBehaviors object. | |
Plot | GetPlot () |
Gets the Plot object. | |
TreePopulation | GetTreePopulation () |
Gets the tree population object. | |
Allometry | GetAllometry () |
Gets the allometry object. | |
DisturbanceBehaviors | GetDisturbanceBehaviors () |
Gets the disturbance behaviors object, or null if none exists. | |
PlantingBehaviors | GetPlantingBehaviors () |
Gets the planting behaviors object, or null if none exists. | |
LightBehaviors | GetLightBehaviors () |
Gets the light behaviors object. | |
RemoveDeadBehaviors | GetRemoveDeadBehaviors () |
void | InputHarvestRegime (String sFileName) throws ModelException |
Reads in a harvest regime. | |
BehaviorTypeBase[] | GetAllBehaviorGroups () |
Gets all of the objects descended from BehaviorTypeBase. | |
WorkerBase[] | GetAllObjects () |
Gets the array of managed objects. | |
void | DisplayRunParameters () |
Allows the user to edit parameters. | |
void | DisplayModelFlowWindow () |
Allows the user to edit simulation flow and behavior order. | |
JDialog | DisplayEpisodicEventsWindow () throws ModelException |
Allows the user to edit episodic event data. | |
void | ExtractParameters (JDialog jDataWindow) throws ModelException |
Extracts the data from the parameter window and passes it to objects. | |
void | DoSetup () throws ModelException |
Triggers the DoSetup() methods of all BehaviorTypeBase objects under management. | |
Protected Member Functions | |
void | InputXMLParameterFile (String sFileName) throws ModelException |
Inputs an XML parameter file. | |
void | InputXMLDataFile (String sFileName, JFrame oWindow) throws ModelException |
Inputs an XML file which is not a parameter type. | |
void | ValidateDataSet () throws ModelException |
Checks to see if the currently loaded dataset is adequate for creating a run and internally valid. | |
void | ClearCurrentData () throws ModelException |
This clears old settings in order to accept a new parameter file. | |
Protected Attributes | |
final String | PARAMETER_FILE = "01" |
This stands for the parameter file XML file type. | |
final String | DETAILED_OUTPUT_FILE = "06" |
This stands for the detailed output file XML file type. | |
final String | DETAILED_OUTPUT_TIMESTEP = "07" |
This stands for the detailed output timestep file XML file type. | |
final String | BATCH_FILE = "04" |
This stands for the batch file XML file type. | |
Private Attributes | |
String | m_sParameterFile |
Path and name of parameter currently loaded, if any. | |
boolean | m_bWasParameterFileModified |
Flag for whether or not a loaded parameter file was modified. | |
WorkerBase[] | mp_oManagedObjects |
This is an array of behaviors and populations, in the order in which they would appear in the parameter file. | |
MainWindow | m_oMainWindow |
Pointer to main application window. |
It performs a function very similar to the Simulation Manager in the C++ code.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
|
Constructor. This creates the objects with no data in them so they can be filled during a new parameter file setup.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
This clears old settings in order to accept a new parameter file. If there's no current data, this will make sure everything is set up to accept new data. The parameter file string is set to empty, and the parameter file modified flag is set to false.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Performs the actions necessary to start a new parameter file.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Allows the user to edit episodic event data. This specifically doesn't actually display the window. The MainWindow object that called this gets the option to resize it because it's so big. If I had lots of time, I'd do this for all windows.
Edit history: ------------------ May 4, 2004: Created (LEM) |
|
Displays the window which allows the user to set up grids.
|
|
Allows the user to edit simulation flow and behavior order.
|
|
Display the window which allows the user to set up output options.
|
|
Allows the user to edit parameters.
|
|
Displays the window which allows the user to set up trees.
|
|
Triggers the DoSetup() methods of all BehaviorTypeBase objects under management.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Extracts the data from the parameter window and passes it to objects.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets all of the objects descended from BehaviorTypeBase.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the array of managed objects.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the allometry object.
Edit history: ------------------ April 25, 2005: Created (LEM) |
|
Gets the AnalysisBehaviors object, or null if none exists.
Edit history: ------------------ October 27, 2004: Created in beta version (LEM) |
|
Gets the descriptive names list of behaviors for a tree species/type combo.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the DisperseBehaviors object, or null if none exists.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the disturbance behaviors object, or null if none exists.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the EstablishmentBehaviors object, or null if none exists.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the GrowthBehaviors object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the HelpBroker object which manages help display for the entire application.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the light behaviors object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the MainWindow object.
|
|
Gets the MortalityBehaviors object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the OutputBehaviors object, or null if none exists.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the parameter file name.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the planting behaviors object, or null if none exists.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the Plot object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets whether or not the run is snag-aware. This searches through all behaviors looking for any that are applied to snags. If none, then the run is not snag-aware.
|
|
Gets the Substrate object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the tree population object.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Whether or not the current parameter file has been modified.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Reads in a harvest regime. Passes it off to the harvest and planting behaviors to do with it what they will. Currently this is not supported if the currently loaded parameter file is XML.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
This passes a tree map file on to the tree population.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Inputs an XML file which is not a parameter type. This would probably be a detailed output timestep file, a tree map, or a grid map. This method does not clear out existing data before parsing the file.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Accepts an XML file for input. The file type is determined, and then action is taken depending on type. If the file type is a parameter file or a detailed output setup file, existing data is cleared and then the file is parsed. If the file type is detailed output timestep, the user is asked whether they want to replace or add to existing data. The appropriate step is then taken.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Inputs an XML parameter file.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Takes all loaded data and prepares a parameter file to pass to the core to run, returning the filename of the parameter file.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
This can be used to propose that a new parameter file is being created. If there is currently no parameter file name, this will accept the proposal and place the key "<New>" in the parameter file name. Then, everything is set as through there is a parameter file entered. All objects are allowed to DoSetup(). If it is not time to create a new parameter file, nothing happens. This is called by the TreeSetup dialog when changes have been made because it's the first step in creating a new file. It does not know whether it's modifying an existing file or creating a new one, so it calls this so the GUIManager object can decide.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Sets the list of behaviors for a tree species/type combo. This replaces any existing assignments.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Checks to see if the currently loaded dataset is adequate for creating a run and internally valid. The dataset is valid if there is at least one behavior enabled, and each managed object successfully validates its internal data.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Writes out the XML parameter file with the current settings. Note that it is not required that the data set be adequate or valid; this way work can be saved in progress. However, if the dataset is invalid, the user will be warned of that fact.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
This stands for the batch file XML file type. This matches the value in the C++ file "DataTypes.h". |
|
This stands for the detailed output file XML file type. This matches the value in the C++ file "DataTypes.h". |
|
This stands for the detailed output timestep file XML file type. This matches the value in the C++ file "DataTypes.h". |
|
This stands for the parameter file XML file type. This matches the value in the C++ file "DataTypes.h". |