SORTIE C++ Test Documentation
Public Member Functions | Private Member Functions | List of all members
clTestBasalAreaLight Class Reference

Tests the clBasalAreaLight class. More...

#include <TestBasalAreaLight.h>

Inheritance diagram for clTestBasalAreaLight:

Public Member Functions

void TestBasalAreaLight ()
 Rolls together all the tests into one function.
 

Private Member Functions

void NormalProcessingRun1 (clSimManager *p_oSimManager)
 Tests normal processing - run 1.
 
void NormalProcessingRun2 (clSimManager *p_oSimManager)
 Tests normal processing - run 2.
 
void NormalProcessingRun3 (clSimManager *p_oSimManager)
 Tests normal processing - run 3.
 
void NormalProcessingRun4 (clSimManager *p_oSimManager)
 Tests normal processing - run 4.
 
void NormalProcessingRun5 (clSimManager *p_oSimManager)
 Tests normal processing - run 5.
 
void TestErrorProcessing (clSimManager *p_oSimManager)
 Tests error processing.
 
const char * WriteXMLFile1 ()
 Writes a parameter file for normal proceessing run 1.
 
const char * WriteXMLFile2 ()
 Writes a parameter file for normal proceessing run 2.
 
const char * WriteXMLFile3 ()
 Writes a parameter file for normal proceessing run 3.
 
const char * WriteXMLFile4 ()
 Writes a parameter file for normal proceessing run 4.
 
const char * WriteXMLFile5 ()
 Writes a parameter file for normal proceessing run 5.
 
const char * WriteXMLErrorFile1 ()
 Writes an error file where the conifer "c" parameter = 0.
 
const char * WriteXMLErrorFile2 ()
 Writes an error file where the angiosperm "c" parameter = 0.
 
const char * WriteXMLErrorFile3 ()
 Writes an error file where the change threshold < 0.
 
const char * WriteXMLErrorFile4 ()
 Writes an error file where the minimum DBH < 0.
 
const char * WriteXMLErrorFile5 ()
 Writes an error file where the radius is negative.
 
void WriteCommonStuff (std::fstream &oOut)
 Writes common portions of the test parameter files (allometry and tree pop).
 

Detailed Description

Tests the clBasalAreaLight class.

Member Function Documentation

void clTestBasalAreaLight::NormalProcessingRun1 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 1.

This checks the calculation of mean GLI and verifies that new light level calculations are triggered correctly. WriteXMLFile1() does setup.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::NormalProcessingRun2 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 2.

This ensures that the calculation of mean GLI is bounded between 0 and 100. WriteXMLFile2() does setup.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::NormalProcessingRun3 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 3.

This checks to make sure grid cell sizes are honored and allows checking of the light level distribution. WriteXMLFile3() does setup. This produces an output file called "Density Light Distribution.txt".

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::NormalProcessingRun4 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 4.

This double-checks grid map reading. WriteXMLFile4() does setup.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::NormalProcessingRun5 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 5.

This double-checks radius. WriteXMLFile5() does setup.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::TestBasalAreaLight ( )

Rolls together all the tests into one function.

void clTestBasalAreaLight::TestErrorProcessing ( clSimManager *  p_oSimManager)
private

Tests error processing.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestBasalAreaLight::WriteCommonStuff ( std::fstream &  oOut)
private

Writes common portions of the test parameter files (allometry and tree pop).

Parameters
oOutFile stream to write to.
const char* clTestBasalAreaLight::WriteXMLErrorFile1 ( )
private

Writes an error file where the conifer "c" parameter = 0.

Returns
File name of the freshly written parameter file.
const char* clTestBasalAreaLight::WriteXMLErrorFile2 ( )
private

Writes an error file where the angiosperm "c" parameter = 0.

Returns
File name of the freshly written parameter file.
const char* clTestBasalAreaLight::WriteXMLErrorFile3 ( )
private

Writes an error file where the change threshold < 0.

Returns
File name of the freshly written parameter file.
const char* clTestBasalAreaLight::WriteXMLErrorFile4 ( )
private

Writes an error file where the minimum DBH < 0.

Returns
File name of the freshly written parameter file.
const char* clTestBasalAreaLight::WriteXMLErrorFile5 ( )
private

Writes an error file where the radius is negative.

Returns
File name of the freshly written parameter file.
const char* clTestBasalAreaLight::WriteXMLFile1 ( )
private

Writes a parameter file for normal proceessing run 1.

Returns
Filename written.
const char* clTestBasalAreaLight::WriteXMLFile2 ( )
private

Writes a parameter file for normal proceessing run 2.

Returns
Filename written.
const char* clTestBasalAreaLight::WriteXMLFile3 ( )
private

Writes a parameter file for normal proceessing run 3.

Returns
Filename written.
const char* clTestBasalAreaLight::WriteXMLFile4 ( )
private

Writes a parameter file for normal proceessing run 4.

Returns
Filename written.
const char* clTestBasalAreaLight::WriteXMLFile5 ( )
private

Writes a parameter file for normal proceessing run 5.

Returns
Filename written.

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