#include <OutputShort.h>
Inheritance diagram for clShortOutput:
Public Member Functions | |
clShortOutput (clSimManager *p_oSimManager) | |
Constructor. | |
~clShortOutput () | |
Destructor. | |
void | Action () |
Collects data and writes the output file. | |
Protected Member Functions | |
void | GetData (xercesc::DOMDocument *p_oDoc) |
Reads the desired options out of the parameter file. | |
void | WriteFileHeader () |
Writes output file header. | |
void | ExtractTreeInfo (xercesc::DOMDocument *p_oDoc) |
Extracts the output data relating to tree saving. | |
void | ExtractSubplotInfo (xercesc::DOMDocument *p_oDoc) |
Extracts the subplot data. | |
bool | TestForSave (DOMElement *p_oParentElement, char *cNodeName) |
Tests to see if a given node exists and has an attribute called "save" equal to true. | |
Protected Attributes | |
char | m_cFileName [MAX_FILENAME_SIZE] |
Output file name. | |
clShortOutput::stcTreeOutputInfo * | mp_treeSettings |
Data structure for defining what tree output data to save An array of stcTreeOutputInfo's, one for each tree type that we're saving data for. | |
short int | m_iNumTypesToSave |
Number of tree types that we're saving data for. | |
clShortOutput::stcSubplotInfo * | mp_subplots |
Data structure for saving subplot data.An array of stcSubplotInfos, one for each subplot to save. | |
short int | m_iNumSubplotsToSave |
Number of subplots we're saving data for. | |
Classes | |
struct | stcCoords |
Structure for holding coordinates. More... | |
struct | stcSubplotInfo |
Data structure for saving subplot data. More... | |
struct | stcTreeOutputInfo |
Data structure for defining what tree output data to save. More... |
It's a shortcut if a detailed output file isn't what you need. It supports subplots - as many as you want.
This will save absolute and relative basal area and density for snags, adults, and saplings, and absolute density for seedlings.
The namestring of this behavior, and the name which it is called in the behavior list of the parameter file, is "short output".
Copyright 2004 Charles D. Canham.
clShortOutput::clShortOutput | ( | clSimManager * | p_oSimManager | ) |
Constructor.
p_oSimManager | Sim Manager object. |
void clShortOutput::GetData | ( | xercesc::DOMDocument * | p_oDoc | ) | [protected, virtual] |
Reads the desired options out of the parameter file.
p_oDoc | DOM tree of the parsed input file. |
Implements clWorkerBase.
void clShortOutput::ExtractTreeInfo | ( | xercesc::DOMDocument * | p_oDoc | ) | [protected] |
Extracts the output data relating to tree saving.
p_oDoc | DOM tree of parsed input file. |
void clShortOutput::ExtractSubplotInfo | ( | xercesc::DOMDocument * | p_oDoc | ) | [protected] |
Extracts the subplot data.
p_oDoc | DOM tree of parsed input file. |
bool clShortOutput::TestForSave | ( | DOMElement * | p_oParentElement, | |
char * | cNodeName | |||
) | [protected] |
Tests to see if a given node exists and has an attribute called "save" equal to true.
p_oParentElement | Pointer to the parent element of the node in question. | |
cNodeName | Tag name of the node. |
char clShortOutput::m_cFileName[MAX_FILENAME_SIZE] [protected] |
Output file name.
If it already exists, new data is appended at the end
struct clShortOutput::stcTreeOutputInfo * clShortOutput::mp_treeSettings [protected] |
Data structure for defining what tree output data to save An array of stcTreeOutputInfo's, one for each tree type that we're saving data for.
short int clShortOutput::m_iNumTypesToSave [protected] |
Number of tree types that we're saving data for.
struct clShortOutput::stcSubplotInfo * clShortOutput::mp_subplots [protected] |
Data structure for saving subplot data.An array of stcSubplotInfos, one for each subplot to save.
They get the same data saved as the plot as a whole.