SORTIE C++ Test Documentation
Public Member Functions | Protected Member Functions | List of all members
clTestLightOrg Class Reference

Tests the clLightOrg class (currently not completely). More...

#include <TestLightOrg.h>

Inheritance diagram for clTestLightOrg:

Public Member Functions

void TestLightOrg ()
 Gathers all testing into one function.
 

Protected Member Functions

void TestGetLightExtinctionCoefficient (clSimManager *p_oSimManager)
 Tests light extinction coefficient management by taking a target tree and surrounding it with both live and snag neighbors to see if the amount of shade calculated by sail light comes out right.
 
void TestDoSetup (clSimManager *p_oSimManager)
 Tests the DoSetup() function of clLightOrg.
 
const char * WriteXMLFile1 ()
 Writes a parameter file to direct testing.
 
const char * WriteXMLFile2 ()
 Writes a parameter file to direct testing.
 
const char * WriteXMLErrorFile1 ()
 Writes a parameter file to direct error testing.
 
const char * WriteXMLErrorFile2 ()
 Writes a parameter file to direct error testing.
 
const char * WriteXMLErrorFile3 ()
 Writes a parameter file to direct error testing.
 

Detailed Description

Tests the clLightOrg class (currently not completely).

Member Function Documentation

void clTestLightOrg::TestDoSetup ( clSimManager *  p_oSimManager)
protected

Tests the DoSetup() function of clLightOrg.

Incompletely. This just tests to make sure that the snag data isn't required for a non-snag run, that the error of size classes overlapping is caught correctly, and that all light extinction coefficients are required to be between 0 and 1.

void clTestLightOrg::TestGetLightExtinctionCoefficient ( clSimManager *  p_oSimManager)
protected

Tests light extinction coefficient management by taking a target tree and surrounding it with both live and snag neighbors to see if the amount of shade calculated by sail light comes out right.

WriteXMLFile1() is used to set up the run. A single sapling of species 1 is created, along with four neighbors. Then sail light is run and the resulting shade is compared to expected. Incidentally, this is a good test of sail light as well.

void clTestLightOrg::TestLightOrg ( )

Gathers all testing into one function.

const char* clTestLightOrg::WriteXMLErrorFile1 ( )
protected

Writes a parameter file to direct error testing.

Snag age classes overlap.

Returns
Filename written.
const char* clTestLightOrg::WriteXMLErrorFile2 ( )
protected

Writes a parameter file to direct error testing.

One of the regular light extinction coefficients is not between 0 and 1.

Returns
Filename written.
const char* clTestLightOrg::WriteXMLErrorFile3 ( )
protected

Writes a parameter file to direct error testing.

One of the snag light extinction coefficients is not between 0 and 1.

Returns
Filename written.
const char* clTestLightOrg::WriteXMLFile1 ( )
protected

Writes a parameter file to direct testing.

Timestep length is 1 year. This contains one species. Sail light is applied to Species 1 saplings.

Returns
Filename written.
const char* clTestLightOrg::WriteXMLFile2 ( )
protected

Writes a parameter file to direct testing.

Has no snags, nor any snag light extinction coefficient parameters.

Returns
Filename written.

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