SORTIE C++ Test Documentation
Functions
TestDimensionAnalysis.h File Reference
#include <fstream>

Functions

const char * WriteDimensionAnalysisXMLFile1 ()
 Writes the parameter file for run 1. More...
 
const char * WriteDimensionAnalysisXMLFile2 ()
 Writes the parameter file for run 2. More...
 
const char * WriteDimensionAnalysisXMLFile3 ()
 Writes the parameter file for run 3. More...
 
const char * WriteDimensionAnalysisXMLFile4 ()
 Writes the parameter file for run 4. More...
 
const char * WriteDimensionAnalysisXMLFile5 ()
 Writes the parameter file for run 5. More...
 
const char * WriteDimensionAnalysisXMLFile6 ()
 Writes the parameter file for run 6. More...
 
const char * WriteDimensionAnalysisXMLFile7 ()
 Writes the parameter file for run 7. More...
 
const char * WriteDimensionAnalysisXMLFile8 ()
 Writes the parameter file for run 8. More...
 
const char * WriteDimensionAnalysisXMLErrorFile1 ()
 Writes an error file where an equation ID is unrecognized. More...
 
const char * WriteDimensionAnalysisXMLErrorFile2 ()
 Writes an error file where a DBH units value is unrecognized. More...
 
const char * WriteDimensionAnalysisXMLErrorFile3 ()
 Writes an error file where the biomass calculator is applied to a seedling. More...
 
const char * WriteDimensionAnalysisXMLErrorFile4 ()
 Writes an error file where a biomass units value is unrecognized. More...
 
const char * WriteDimensionAnalysisXMLErrorFile5 ()
 Writes an error file where a correction factor flag value is unrecognized. More...
 
const char * WriteDimensionAnalysisXMLErrorFile6 ()
 Writes an error file where a dia meaning value is unrecognized. More...
 
void WriteDimensionAnalysisCommonStuff (std::fstream &oOut)
 Writes common portions of the test parameter files (tree pop, plot, etc). More...
 
void WriteDimensionAnalysisCommonErrorStuff (std::fstream &oOut)
 Writes common portions of the test parameter files (tree pop, plot, etc). More...
 
clTree ** CreateDimensionAnalysisTrees (clTreePopulation *p_oPop)
 Creates the trees. More...
 

Function Documentation

◆ CreateDimensionAnalysisTrees()

clTree** CreateDimensionAnalysisTrees ( clTreePopulation *  p_oPop)

Creates the trees.

3 of each species are created (Species 1 to Species 19, Species 13 excepted). There is one of DBH 5 cm, one of DBH 50 cm, and one of DBH 100 cm. Pointers to the new trees are placed in the passed array.

Parameters
p_oPopTree population object.
Returns
Array of created trees, 54 trees long.

◆ WriteDimensionAnalysisCommonErrorStuff()

void WriteDimensionAnalysisCommonErrorStuff ( std::fstream &  oOut)

Writes common portions of the test parameter files (tree pop, plot, etc).

This ends with </behaviorList&gt. There are only two species for this file.

Parameters
oOutFile stream to write to.

◆ WriteDimensionAnalysisCommonStuff()

void WriteDimensionAnalysisCommonStuff ( std::fstream &  oOut)

Writes common portions of the test parameter files (tree pop, plot, etc).

This ends with </behaviorList&gt.

Parameters
oOutFile stream to write to.

◆ WriteDimensionAnalysisXMLErrorFile1()

const char* WriteDimensionAnalysisXMLErrorFile1 ( )

Writes an error file where an equation ID is unrecognized.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLErrorFile2()

const char* WriteDimensionAnalysisXMLErrorFile2 ( )

Writes an error file where a DBH units value is unrecognized.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLErrorFile3()

const char* WriteDimensionAnalysisXMLErrorFile3 ( )

Writes an error file where the biomass calculator is applied to a seedling.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLErrorFile4()

const char* WriteDimensionAnalysisXMLErrorFile4 ( )

Writes an error file where a biomass units value is unrecognized.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLErrorFile5()

const char* WriteDimensionAnalysisXMLErrorFile5 ( )

Writes an error file where a correction factor flag value is unrecognized.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLErrorFile6()

const char* WriteDimensionAnalysisXMLErrorFile6 ( )

Writes an error file where a dia meaning value is unrecognized.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLFile1()

const char* WriteDimensionAnalysisXMLFile1 ( )

Writes the parameter file for run 1.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All 18 used species use equation

  1. The first 9 use a correction factor; the second 9 don't.
    Returns
    Filename written.

◆ WriteDimensionAnalysisXMLFile2()

const char* WriteDimensionAnalysisXMLFile2 ( )

Writes the parameter file for run 2.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All 18 used species use equation

  1. The first 9 use a correction factor; the second 9 don't.
    Returns
    Filename written.

◆ WriteDimensionAnalysisXMLFile3()

const char* WriteDimensionAnalysisXMLFile3 ( )

Writes the parameter file for run 3.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All 18 used species use equation

  1. The first 9 use a correction factor; the second 9 don't.
    Returns
    Filename written.

◆ WriteDimensionAnalysisXMLFile4()

const char* WriteDimensionAnalysisXMLFile4 ( )

Writes the parameter file for run 4.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. The first 9 species use equation 4; the second 9 use equation 5.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLFile5()

const char* WriteDimensionAnalysisXMLFile5 ( )

Writes the parameter file for run 5.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. The first 9 species use equation 6; the second 9 use equation 7.

Returns
Filename written.

◆ WriteDimensionAnalysisXMLFile6()

const char* WriteDimensionAnalysisXMLFile6 ( )

Writes the parameter file for run 6.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All 18 used species use equation

  1. The first 9 use a correction factor; the second 9 don't.
    Returns
    Filename written.

◆ WriteDimensionAnalysisXMLFile7()

const char* WriteDimensionAnalysisXMLFile7 ( )

Writes the parameter file for run 7.

There are 19 species (Species 13 is not used). The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All 18 used species use equation

  1. The first 9 use a correction factor; the second 9 don't.
    Returns
    Filename written.

◆ WriteDimensionAnalysisXMLFile8()

const char* WriteDimensionAnalysisXMLFile8 ( )

Writes the parameter file for run 8.

There are 19 species but only the first 9 are used. The biomass calculator is the only behavior and is applied to saplings and adults of all used species. All used species use dia=DBH^2.

Returns
Filename written.