SORTIE Java Interface
1
|
Controls the data visualization for a single detailed output file. More...
Public Member Functions | |
DetailedOutputFileManager (DataVisualizerManager oManager, String sTarball) throws ModelException | |
Constructor. More... | |
void | setParFileTimesteps (int i) |
Sets the number of timesteps for the detailed output file parameter file. More... | |
int | getNumberOfActualTimesteps () |
Gets the number of actual data timesteps contained in this detailed output file (as opposed to how many the par file says there are). More... | |
void | setSubplotXCellLength (float f) |
Sets the subplot X cell length. More... | |
void | setSubplotYCellLength (float f) |
Sets the subplot Y cell length. More... | |
boolean | isThisSubplot (String sSubplotName) |
Checks to see if a subplot name indicates that the detailed output file being managed is in fact for that subplot. More... | |
float | getPlotArea () |
Gets the area of this plot or subplot, in ha. More... | |
void | addBatchData (ChartInfo oInfo) throws ModelException |
Adds a new item to the data request list. More... | |
void | doBatchExtraction () throws ModelException |
Does batch data extraction of all data requests. More... | |
JInternalFrame | drawChart (String sGraphName) throws ModelException |
Handles the request to draw a chart for this file. More... | |
void | updateCurrentRunCharts () throws ModelException |
Updates charts for a current run. More... | |
JPopupMenu | getTableOptions (ActionListener sActionListener) |
Gets the tables that can be drawn for this file. More... | |
JPopupMenu | getHistogramOptions (ActionListener sActionListener) |
Gets the histograms that can be drawn for this file. More... | |
JPopupMenu | getMapOptions (ActionListener sActionListener) |
Gets the maps that can be drawn for this file. More... | |
JPopupMenu | getLineGraphOptions (ActionListener sActionListener) |
Gets the line graphs that can be drawn for this file. More... | |
void | setXPlotLength (float f) |
Sets the plot X length. More... | |
void | setYPlotLength (float f) |
Sets the plot Y length. More... | |
void | setNumberOfYearsPerTimestep (float f) |
Sets the number of years per timestep. More... | |
float | getNumberOfYearsPerTimestep () |
Gets the number of years per timestep. More... | |
float | getXPlotLength () |
Gets the plot X length. More... | |
float | getYPlotLength () |
Gets the plot Y length. More... | |
void | updateCharts () throws ModelException |
Redraws all the charts currently open for this detailed output file. More... | |
void | addSpeciesName (String sName) |
Adds a species name to the end of the species name list. More... | |
DetailedTreeSettings | createNewTreeSettings (String sSpeciesName, int iType, int iDeadCode) throws ModelException |
Creates a new DetailedTreeSettings object and adds it to the tree settings vector. More... | |
DetailedGridSettings | createNewGridSettings (String sGridName) |
Creates a new DetailedGridSettings object and adds it to the grid settings vector. More... | |
void | addGridXCellLength (String sGridName, float fLength) |
Adds the X cell length to grid settings. More... | |
void | addGridYCellLength (String sGridName, float fLength) |
Adds the Y cell length to grid settings. More... | |
int | getNumberOfSpecies () |
Gets the number of species that exist in the detailed output header file. More... | |
int | getNumberOfTypes () |
Gets the number of tree types. More... | |
int | getSpeciesCodeFromName (String sName) throws ModelException |
When passed the name of a species, will give back the corresponding species number code. More... | |
String | getSpeciesNameFromCode (int iIndex) throws ModelException |
When passed the index of a species, will give back the corresponding species name. More... | |
void | readFile (int iTimestep) throws ModelException |
Read the detailed output file for a particular timestep. More... | |
boolean | wantAnyTreeFloats () |
Whether or not any open data requests want any tree float data members. More... | |
boolean | wantAnyDeadTreeFloats () |
Whether or not any open data requests want any dead tree float data members. More... | |
boolean | wantAnyGridFloats () |
Whether or not any open data requests want any grid float data members. More... | |
boolean | wantAnyGridPackageFloats () |
Whether or not any open data requests want any grid package float data members. More... | |
boolean | wantAnyTreeInts () |
Whether or not any open data requests want any tree int data members. More... | |
boolean | wantAnyDeadTreeInts () |
Whether or not any open data requests want any dead tree int data members. More... | |
boolean | wantAnyGridInts () |
Whether or not any open data requests want any grid int data members. More... | |
boolean | wantAnyGridPackageInts () |
Whether or not any open data requests want any grid package int data members. More... | |
boolean | wantAnyTreeChars () |
Whether or not any open data requests want any tree char data members. More... | |
boolean | wantAnyDeadTreeChars () |
Whether or not any open data requests want any dead tree char data members. More... | |
boolean | wantAnyGridChars () |
Whether or not any open data requests want any grid char data members. More... | |
boolean | wantAnyGridPackageChars () |
Whether or not any open data requests want any grid package char data members. More... | |
boolean | wantAnyTreeBools () |
Whether or not any open data requests want any tree bool data members. More... | |
boolean | wantAnyDeadTreeBools () |
Whether or not any open data requests want any dead tree bool data members. More... | |
boolean | wantAnyGridBools () |
Whether or not any open data requests want any grid bool data members. More... | |
boolean | wantAnyGridPackageBools () |
Whether or not any open data requests want any grid package bool data members. More... | |
void | addTreeFloatData (int iSpecies, int iType, int iCode, float fVal) throws SAXException |
Accepts a piece of tree float data from the parser and passes it on to open data requests. More... | |
void | addDeadTreeFloatData (int iSpecies, int iType, int iCode, int iDeadCode, float fVal) throws SAXException |
Accepts a piece of dead tree float data from the parser and passes it on to open data requests. More... | |
void | addGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal) throws SAXException |
Accepts a piece of grid float data from the parser and passes it on to open data requests. More... | |
void | addGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal) throws SAXException |
Accepts a piece of grid package float data from the parser and passes it on to open data requests. More... | |
void | addTreeIntData (int iSpecies, int iType, int iCode, int iVal) throws SAXException |
Accepts a piece of tree int data from the parser and passes it on to open data requests. More... | |
void | addDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal) throws SAXException |
Accepts a piece of dead tree int data from the parser and passes it on to open data requests. More... | |
void | addGridIntData (String sGridName, int iX, int iY, int iCode, int iVal) throws SAXException |
Accepts a piece of grid int data from the parser and passes it on to open data requests. More... | |
void | addGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal) throws SAXException |
Accepts a piece of grid package int data from the parser and passes it on to open data requests. More... | |
void | addTreeCharData (int iSpecies, int iType, int iCode, String sVal) throws SAXException |
Accepts a piece of tree char data from the parser and passes it on to open data requests. More... | |
void | addDeadTreeCharData (int iSpecies, int iType, int iCode, int iDeadCode, String sVal) throws SAXException |
Accepts a piece of dead tree char data from the parser and passes it on to open data requests. More... | |
void | addGridCharData (String sGridName, int iX, int iY, int iCode, String sVal) throws SAXException |
Accepts a piece of grid char data from the parser and passes it on to open data requests. More... | |
void | addGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal) throws SAXException |
Accepts a piece of grid package char data from the parser and passes it on to open data requests. More... | |
void | addTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal) throws SAXException |
Accepts a piece of tree bool data from the parser to pass on to open data requests. More... | |
void | addDeadTreeBoolData (int iSpecies, int iType, int iCode, int iDeadCode, boolean bVal) throws SAXException |
Accepts a piece of dead tree bool data from the parser to pass on to open data requests. More... | |
void | addGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal) throws SAXException |
Accepts a piece of grid bool data from the parser to pass on to open data requests. More... | |
void | addGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal) throws SAXException |
Accepts a piece of grid package bool data from the parser to pass on to open data requests. More... | |
void | addTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException |
Accepts a tree float data member code from the parser to pass on to open data requests. More... | |
void | addGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid float data member code from the parser to pass on to open data requests. More... | |
void | addGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid package float data member code from the parser to pass on to open data requests. More... | |
void | addTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException |
Accepts an int data member code from the parser to pass on to open data requests. More... | |
void | addGridIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts an int data member code from the parser to pass on to open data requests. More... | |
void | addGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid package int data member code from the parser to pass on to open data requests. More... | |
void | addTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException |
Accepts a tree char data member code from the parser to pass on to open data requests. More... | |
void | addGridCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid char data member code from the parser to pass on to open data requests. More... | |
void | addGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid package char data member code from the parser to pass on to open data requests. More... | |
void | addTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException |
Accepts a tree bool data member code from the parser to pass on to open data requests. More... | |
void | addGridBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid bool data member code from the parser to pass on to open data requests. More... | |
void | addGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException |
Accepts a grid package bool data member code from the parser to pass on to open data requests. More... | |
void | endPackage () throws SAXException |
Notifies all open data requests that a new package has ended. More... | |
void | endTree () throws SAXException |
Notifies all open data requests that a tree record has ended. More... | |
int | getNumberTreeSettings () |
Get the total number of detailed tree settings. More... | |
DetailedTreeSettings | getTreeSetting (int i) |
Access a detailed tree output settings record. More... | |
float | getGridXCellLength (String sGridName) |
Gets the length of X cells for a grid. More... | |
float | getGridYCellLength (String sGridName) |
Gets the length of Y cells for a grid. More... | |
void | cleanUp () throws ModelException |
Deletes all files from the tarball in the temp folder. More... | |
void | addSubplotCell (int iX, int iY) |
Adds one of the cells of this subplot. More... | |
void | addChartForBatchExtraction (String sGraphName) throws ModelException |
Public Member Functions inherited from sortie.datavisualizer.DataFileManager | |
Legend | getLegend () |
Get the legend for this file. More... | |
int | getNumberOpenCharts () |
Gets the number of open charts for this file. More... | |
void | closeAllCharts () |
Closes all the open charts for this window. More... | |
void | cleanUp () throws ModelException |
Any clean-up tasks that must be done can be put here. More... | |
DataFileManager (DataVisualizerManager oManager, String sFileName) | |
Constructor. More... | |
String | getFileName () |
Gets the file being managed. More... | |
abstract JPopupMenu | getLineGraphOptions (ActionListener sActionListener) |
Gets a list of the line graphs this object is capable of drawing. More... | |
abstract JPopupMenu | getMapOptions (ActionListener sActionListener) |
Gets a list of maps this object is capable of drawing. More... | |
abstract JPopupMenu | getHistogramOptions (ActionListener sActionListener) |
Gets a list of histograms this object is capable of drawing. More... | |
abstract JPopupMenu | getTableOptions (ActionListener sActionListener) |
Gets a list of tables this object is capable of drawing. More... | |
JInternalFrame | createNewChart (String sGraphName) throws ModelException |
Creates a requested chart as a JInternalFrame. More... | |
abstract void | updateCharts () throws ModelException |
Prompts the redrawing of all open charts. More... | |
abstract void | updateCurrentRunCharts () throws ModelException |
Prompts the redrawing of open charts for the current run. More... | |
Static Public Member Functions | |
static JPanel | getOptionsPanel (String sGraphName) throws ModelException |
Private Member Functions | |
ArrayList< String > | getMenuOptions (MenuElement jMenu) |
Recursively add all the elements of a menu and its sub menus to an array of strings. More... | |
void | countTimesteps () throws ModelException |
Counts the number of timesteps in the tarball and places it in m_iNumTimesteps. More... | |
void | parseParamFile () throws ModelException |
Parses the parameter file portion of the tarball. More... | |
DataRequest | interpretGraphName (String sGraphName) throws ModelException |
Matches a graph name to a data request class and returns an instance of the appropriate class. More... | |
Private Attributes | |
ArrayList< DataRequest > | mp_oDataRequests = new ArrayList<DataRequest>(0) |
The collection of all data requests currently open. More... | |
ArrayList< String > | mp_sSpeciesNames = new ArrayList<String>(0) |
Species names - the order determines the species codes. More... | |
ArrayList< DetailedTreeSettings > | mp_oTreeSettings = new ArrayList<DetailedTreeSettings>(0) |
Collection of DetailedTreeSettings objects. More... | |
ArrayList< DetailedGridSettings > | mp_oGridSettings = new ArrayList<DetailedGridSettings>(0) |
Collection of DetailedGridSettings objects. More... | |
boolean [] | mp_bHistogramIsFloat |
Whether each histogram option is float (true) or int (false) More... | |
String [] | mp_sHistogramNames |
Histogram names - so we can figure out which value in mp_bHistogramIsFloat value to use. More... | |
String [] | mp_sMapNames |
All the map names, so we can quickly check if an option is valid. More... | |
String [] | mp_sTableNames |
All the table names, so we can quickly check if an option is valid. More... | |
String [] | mp_sLineGraphNames |
All the line graph names, so we can quickly check if an option is valid. More... | |
int [] | mp_iDeadCodes |
Dead reason codes for each tree data member. More... | |
String | m_sShortFileDisplayName |
Display string of filename - should have the last 40 chars. More... | |
String | m_sLongFileDisplayName |
Display string of filename - should have the last 90 chars. More... | |
XMLReader | m_oParser |
File parser. More... | |
String | m_sTempRoot |
Root directory to put temp files. More... | |
float | m_fPlotArea = 0 |
Area of plot (or subplot) in hectares. More... | |
int | m_iNumTimesteps |
Number of actual timesteps of data. More... | |
boolean | m_bBatchMode = false |
Whether not this is working in the context of batch output extraction. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from sortie.datavisualizer.DataFileManager | |
abstract JInternalFrame | drawChart (String sGraphName) throws ModelException |
Creates a requested chart as a JInternalFrame. More... | |
Protected Attributes inherited from sortie.datavisualizer.DataFileManager | |
DataVisualizerManager | m_oManager |
Manager object. More... | |
String | m_sFilename |
File under management. More... | |
ArrayList< JInternalFrame > | mp_oCharts = new ArrayList<JInternalFrame>(0) |
All charts under management. More... | |
Legend | m_oLegend |
The legend for this file. More... | |
String [] | mp_sDeadCodeNames = new String[OutputBehaviors.NUMCODES] |
Text equivalents of dead codes. More... | |
Controls the data visualization for a single detailed output file.
Copyright: Copyright (c) Charles D. Canham 2012 Company: Cary Institute of Ecosystem Studies
Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)
sortie.datavisualizer.DetailedOutputFileManager.DetailedOutputFileManager | ( | DataVisualizerManager | oManager, |
String | sTarball | ||
) | throws ModelException |
Constructor.
oManager | Data file manager. |
sTarball | Detailed output file to manage. |
ModelException | If there was a problem reading the file. |
void sortie.datavisualizer.DetailedOutputFileManager.addBatchData | ( | ChartInfo | oInfo | ) | throws ModelException |
Adds a new item to the data request list.
This is the same as drawChart but does not actually open or draw a chart. This will verify that the option is possible for this file before adding it. No file parsing is triggered.
oInfo | Info for chart to draw. |
ModelException | If anything goes wrong. |
void sortie.datavisualizer.DetailedOutputFileManager.addChartForBatchExtraction | ( | String | sGraphName | ) | throws ModelException |
void sortie.datavisualizer.DetailedOutputFileManager.addDeadTreeBoolData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
int | iDeadCode, | ||
boolean | bVal | ||
) | throws SAXException |
Accepts a piece of dead tree bool data from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value and passes it on to open data requests. |
iDeadCode | Dead code for this tree. |
bVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addDeadTreeCharData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
int | iDeadCode, | ||
String | sVal | ||
) | throws SAXException |
Accepts a piece of dead tree char data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
iDeadCode | Dead code for this tree. |
sVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addDeadTreeFloatData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
int | iDeadCode, | ||
float | fVal | ||
) | throws SAXException |
Accepts a piece of dead tree float data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
iDeadCode | Dead code for this tree. |
fVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addDeadTreeIntData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
int | iDeadCode, | ||
int | iVal | ||
) | throws SAXException |
Accepts a piece of dead tree int data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
iDeadCode | Dead code for this tree. |
iVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridBoolData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
boolean | bVal | ||
) | throws SAXException |
Accepts a piece of grid bool data from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value and passes it on to open data requests. |
bVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridBoolDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid bool data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridCharData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
String | sVal | ||
) | throws SAXException |
Accepts a piece of grid char data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
sVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridCharDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid char data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridFloatData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
float | fVal | ||
) | throws SAXException |
Accepts a piece of grid float data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
fVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridFloatDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid float data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridIntData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
int | iVal | ||
) | throws SAXException |
Accepts a piece of grid int data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
iVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridIntDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts an int data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageBoolData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
boolean | bVal | ||
) | throws SAXException |
Accepts a piece of grid package bool data from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value and passes it on to open data requests. |
bVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageBoolDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid package bool data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageCharData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
String | sVal | ||
) | throws SAXException |
Accepts a piece of grid package char data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
sVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageCharDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid package char data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageFloatData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
float | fVal | ||
) | throws SAXException |
Accepts a piece of grid package float data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
fVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageFloatDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid package float data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageIntData | ( | String | sGridName, |
int | iX, | ||
int | iY, | ||
int | iCode, | ||
int | iVal | ||
) | throws SAXException |
Accepts a piece of grid package int data from the parser and passes it on to open data requests.
sGridName | Name of the grid for this data |
iX | X number of the cell from which this value came |
iY | Y number of the cell from which this value came |
iCode | Data member code of this value. |
iVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridPackageIntDataMemberCode | ( | String | sGridName, |
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a grid package int data member code from the parser to pass on to open data requests.
sGridName | Name of the grid for this data |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridXCellLength | ( | String | sGridName, |
float | fLength | ||
) |
Adds the X cell length to grid settings.
sGridName | The grid name for which to add the cell length. |
fLength | The new X cell length in m. |
void sortie.datavisualizer.DetailedOutputFileManager.addGridYCellLength | ( | String | sGridName, |
float | fLength | ||
) |
Adds the Y cell length to grid settings.
sGridName | The grid name for which to add the cell length. |
fLength | The new Y cell length in m. |
void sortie.datavisualizer.DetailedOutputFileManager.addSpeciesName | ( | String | sName | ) |
Adds a species name to the end of the species name list.
The position within the vector becomes that name's species index code.
sName | The species name to add. |
void sortie.datavisualizer.DetailedOutputFileManager.addSubplotCell | ( | int | iX, |
int | iY | ||
) |
Adds one of the cells of this subplot.
This adds the area of the cell to the total, taking into account odd-sized end cells.
iX | X cell |
iY | Y cell |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeBoolData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
boolean | bVal | ||
) | throws SAXException |
Accepts a piece of tree bool data from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value and passes it on to open data requests. |
bVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeBoolDataMemberCode | ( | int | iSpecies, |
int | iType, | ||
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a tree bool data member code from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeCharData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
String | sVal | ||
) | throws SAXException |
Accepts a piece of tree char data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
sVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeCharDataMemberCode | ( | int | iSpecies, |
int | iType, | ||
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a tree char data member code from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeFloatData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
float | fVal | ||
) | throws SAXException |
Accepts a piece of tree float data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
fVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeFloatDataMemberCode | ( | int | iSpecies, |
int | iType, | ||
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts a tree float data member code from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeIntData | ( | int | iSpecies, |
int | iType, | ||
int | iCode, | ||
int | iVal | ||
) | throws SAXException |
Accepts a piece of tree int data from the parser and passes it on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
iCode | Data member code of this value. |
iVal | Value. |
void sortie.datavisualizer.DetailedOutputFileManager.addTreeIntDataMemberCode | ( | int | iSpecies, |
int | iType, | ||
String | sLabel, | ||
int | iCode | ||
) | throws SAXException |
Accepts an int data member code from the parser to pass on to open data requests.
iSpecies | Species of the tree from which this value came. |
iType | Type of the tree from which this value came. |
sLabel | The label of the data member. |
iCode | The data member code. |
void sortie.datavisualizer.DetailedOutputFileManager.cleanUp | ( | ) | throws ModelException |
Deletes all files from the tarball in the temp folder.
|
private |
Counts the number of timesteps in the tarball and places it in m_iNumTimesteps.
The value is found by counting the number of files. The number of timesteps is the number of files - 2 (for the parameter file and initial conditions). This is compared to the number of timesteps found in the header file and the lesser one is chosen.
ModelException | - wrapping other exceptions |
DetailedGridSettings sortie.datavisualizer.DetailedOutputFileManager.createNewGridSettings | ( | String | sGridName | ) |
Creates a new DetailedGridSettings object and adds it to the grid settings vector.
sGridName | The grid name string |
DetailedTreeSettings sortie.datavisualizer.DetailedOutputFileManager.createNewTreeSettings | ( | String | sSpeciesName, |
int | iType, | ||
int | iDeadCode | ||
) | throws ModelException |
Creates a new DetailedTreeSettings object and adds it to the tree settings vector.
sSpeciesName | The species name string |
iType | The type number |
iDeadCode | Dead code for tree settings. |
ModelException | if either the type or the species name is invalid. |
void sortie.datavisualizer.DetailedOutputFileManager.doBatchExtraction | ( | ) | throws ModelException |
Does batch data extraction of all data requests.
JInternalFrame sortie.datavisualizer.DetailedOutputFileManager.drawChart | ( | String | sGraphName | ) | throws ModelException |
Handles the request to draw a chart for this file.
The request will be passed on to an appropriate DataRequest object. If the chart is already open, the open chart will be returned.
sGraphName | Name of chart to draw. |
ModelException | If anything goes wrong. |
void sortie.datavisualizer.DetailedOutputFileManager.endPackage | ( | ) | throws SAXException |
Notifies all open data requests that a new package has ended.
void sortie.datavisualizer.DetailedOutputFileManager.endTree | ( | ) | throws SAXException |
Notifies all open data requests that a tree record has ended.
float sortie.datavisualizer.DetailedOutputFileManager.getGridXCellLength | ( | String | sGridName | ) |
Gets the length of X cells for a grid.
sGridName | Grid for which to get the X cell length. |
float sortie.datavisualizer.DetailedOutputFileManager.getGridYCellLength | ( | String | sGridName | ) |
Gets the length of Y cells for a grid.
sGridName | Grid for which to get the Y cell length. |
JPopupMenu sortie.datavisualizer.DetailedOutputFileManager.getHistogramOptions | ( | ActionListener | sActionListener | ) |
Gets the histograms that can be drawn for this file.
JPopupMenu sortie.datavisualizer.DetailedOutputFileManager.getLineGraphOptions | ( | ActionListener | sActionListener | ) |
Gets the line graphs that can be drawn for this file.
JPopupMenu sortie.datavisualizer.DetailedOutputFileManager.getMapOptions | ( | ActionListener | sActionListener | ) |
Gets the maps that can be drawn for this file.
|
private |
Recursively add all the elements of a menu and its sub menus to an array of strings.
jMenu | Menu to analyze |
int sortie.datavisualizer.DetailedOutputFileManager.getNumberOfActualTimesteps | ( | ) |
Gets the number of actual data timesteps contained in this detailed output file (as opposed to how many the par file says there are).
int sortie.datavisualizer.DetailedOutputFileManager.getNumberOfSpecies | ( | ) |
Gets the number of species that exist in the detailed output header file.
int sortie.datavisualizer.DetailedOutputFileManager.getNumberOfTypes | ( | ) |
Gets the number of tree types.
float sortie.datavisualizer.DetailedOutputFileManager.getNumberOfYearsPerTimestep | ( | ) |
Gets the number of years per timestep.
int sortie.datavisualizer.DetailedOutputFileManager.getNumberTreeSettings | ( | ) |
Get the total number of detailed tree settings.
|
static |
float sortie.datavisualizer.DetailedOutputFileManager.getPlotArea | ( | ) |
Gets the area of this plot or subplot, in ha.
int sortie.datavisualizer.DetailedOutputFileManager.getSpeciesCodeFromName | ( | String | sName | ) | throws ModelException |
When passed the name of a species, will give back the corresponding species number code.
sName | The name of the species. |
ModelException | if the name is not recognized. |
String sortie.datavisualizer.DetailedOutputFileManager.getSpeciesNameFromCode | ( | int | iIndex | ) | throws ModelException |
When passed the index of a species, will give back the corresponding species name.
iIndex | Species index. |
ModelException | if the index is unrecognized. |
JPopupMenu sortie.datavisualizer.DetailedOutputFileManager.getTableOptions | ( | ActionListener | sActionListener | ) |
Gets the tables that can be drawn for this file.
DetailedTreeSettings sortie.datavisualizer.DetailedOutputFileManager.getTreeSetting | ( | int | i | ) |
Access a detailed tree output settings record.
i | Index of the desired record. |
float sortie.datavisualizer.DetailedOutputFileManager.getXPlotLength | ( | ) |
Gets the plot X length.
float sortie.datavisualizer.DetailedOutputFileManager.getYPlotLength | ( | ) |
Gets the plot Y length.
|
private |
Matches a graph name to a data request class and returns an instance of the appropriate class.
sGraphName | Graph name. |
ModelException | Passed through from created objects. |
boolean sortie.datavisualizer.DetailedOutputFileManager.isThisSubplot | ( | String | sSubplotName | ) |
Checks to see if a subplot name indicates that the detailed output file being managed is in fact for that subplot.
If it were, the subplot name would be the last part of the tarball name preceded by an underscore.
sSubplotName | Name of possible subplot for this file. |
|
private |
Parses the parameter file portion of the tarball.
This function parses the detailed output header file to find species information and tree setup information.
ModelException | if the file cannot be parsed. |
void sortie.datavisualizer.DetailedOutputFileManager.readFile | ( | int | iTimestep | ) | throws ModelException |
Read the detailed output file for a particular timestep.
iTimestep | Timestep for which to read the file. |
ModelException | If the file cannot be read. |
void sortie.datavisualizer.DetailedOutputFileManager.setNumberOfYearsPerTimestep | ( | float | f | ) |
Sets the number of years per timestep.
f | Number of years per timestep. |
void sortie.datavisualizer.DetailedOutputFileManager.setParFileTimesteps | ( | int | i | ) |
Sets the number of timesteps for the detailed output file parameter file.
i | Number of timesteps. |
void sortie.datavisualizer.DetailedOutputFileManager.setSubplotXCellLength | ( | float | f | ) |
Sets the subplot X cell length.
f | X cell length, in m. |
void sortie.datavisualizer.DetailedOutputFileManager.setSubplotYCellLength | ( | float | f | ) |
Sets the subplot Y cell length.
f | Y cell length, in m. |
void sortie.datavisualizer.DetailedOutputFileManager.setXPlotLength | ( | float | f | ) |
Sets the plot X length.
f | Plot X length, in meters. |
void sortie.datavisualizer.DetailedOutputFileManager.setYPlotLength | ( | float | f | ) |
Sets the plot Y length.
f | Plot Y length, in meters. |
void sortie.datavisualizer.DetailedOutputFileManager.updateCharts | ( | ) | throws ModelException |
Redraws all the charts currently open for this detailed output file.
This is accomplished by sending an UpdateChart() call to each data request object.
ModelException | wrapping another exception. |
void sortie.datavisualizer.DetailedOutputFileManager.updateCurrentRunCharts | ( | ) | throws ModelException |
Updates charts for a current run.
This re-inflates the tarball and gets the last timestep file for parsing and processing.
ModelException | if there is a problem reading the file or drawing the charts. |
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyDeadTreeBools | ( | ) |
Whether or not any open data requests want any dead tree bool data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyDeadTreeChars | ( | ) |
Whether or not any open data requests want any dead tree char data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyDeadTreeFloats | ( | ) |
Whether or not any open data requests want any dead tree float data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyDeadTreeInts | ( | ) |
Whether or not any open data requests want any dead tree int data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridBools | ( | ) |
Whether or not any open data requests want any grid bool data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridChars | ( | ) |
Whether or not any open data requests want any grid char data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridFloats | ( | ) |
Whether or not any open data requests want any grid float data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridInts | ( | ) |
Whether or not any open data requests want any grid int data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridPackageBools | ( | ) |
Whether or not any open data requests want any grid package bool data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridPackageChars | ( | ) |
Whether or not any open data requests want any grid package char data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridPackageFloats | ( | ) |
Whether or not any open data requests want any grid package float data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyGridPackageInts | ( | ) |
Whether or not any open data requests want any grid package int data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyTreeBools | ( | ) |
Whether or not any open data requests want any tree bool data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyTreeChars | ( | ) |
Whether or not any open data requests want any tree char data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyTreeFloats | ( | ) |
Whether or not any open data requests want any tree float data members.
boolean sortie.datavisualizer.DetailedOutputFileManager.wantAnyTreeInts | ( | ) |
Whether or not any open data requests want any tree int data members.
|
private |
Whether not this is working in the context of batch output extraction.
|
private |
Area of plot (or subplot) in hectares.
|
private |
Number of actual timesteps of data.
|
private |
File parser.
|
private |
Display string of filename - should have the last 90 chars.
|
private |
Display string of filename - should have the last 40 chars.
|
private |
Root directory to put temp files.
|
private |
Whether each histogram option is float (true) or int (false)
|
private |
Dead reason codes for each tree data member.
|
private |
The collection of all data requests currently open.
|
private |
Collection of DetailedGridSettings objects.
|
private |
Collection of DetailedTreeSettings objects.
|
private |
Histogram names - so we can figure out which value in mp_bHistogramIsFloat value to use.
|
private |
All the line graph names, so we can quickly check if an option is valid.
|
private |
All the map names, so we can quickly check if an option is valid.
|
private |
Species names - the order determines the species codes.
|
private |
All the table names, so we can quickly check if an option is valid.