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

Tests the clAverageLight class. More...

#include <TestAverageLight.h>

Inheritance diagram for clTestAverageLight:

Public Member Functions

void TestAverageLight ()
 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 GLI Map behavior is not enabled.
 
void WriteTreeFile (std::fstream &oOut)
 Writes tree file.
 

Detailed Description

Tests the clAverageLight class.

Member Function Documentation

void clTestAverageLight::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 clTestAverageLight::NormalProcessingRun2 ( clSimManager *  p_oSimManager)
private

Tests normal processing - run 2.

This ensures that the calculation of mean GLI happens when there are no trees affecting GLI. WriteXMLFile2() does setup.

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

Tests normal processing - run 3.

This checks the calculation of mean GLI when the grid cells are even multiples of the GLI map. WriteXMLFile3() does setup.

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

Tests normal processing - run 4.

This checks the calculation of mean GLI when the grid cells are not even multiples of the GLI map. WriteXMLFile4() does setup.

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

Tests normal processing - run 5.

This checks the calculation of mean GLI when the grid cell sizes are not specified. WriteXMLFile5() does setup.

Parameters
p_oSimManagerSim Manager to do runs.
void clTestAverageLight::TestAverageLight ( )

Rolls together all the tests into one function.

void clTestAverageLight::TestErrorProcessing ( clSimManager *  p_oSimManager)
private

Tests error processing.

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

Writes tree file.

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

Writes an error file where the GLI Map behavior is not enabled.

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

Writes a parameter file for normal proceessing run 1.

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

Writes a parameter file for normal proceessing run 2.

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

Writes a parameter file for normal proceessing run 3.

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

Writes a parameter file for normal proceessing run 4.

Returns
Filename written.
const char* clTestAverageLight::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: