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

Tests the clCompetitionHarvest class. More...

#include <TestCompetitionHarvest.h>

Inheritance diagram for clTestCompetitionHarvest:

Public Member Functions

void TestCompetitionHarvest ()
 Groups together all the other harvest testing functions into a comprehensive harvest test.
 

Protected Member Functions

void DoHarvestRun1 (clSimManager *p_oSimManager)
 Performs the first harvest run.
 
void DoHarvestRun2 (clSimManager *p_oSimManager)
 Performs the second harvest run.
 
void DoHarvestRun3 (clSimManager *p_oSimManager)
 Performs the third harvest run.
 
void DoErrorProcessing (clSimManager *p_oSimManager)
 Tests error processing.
 
const char * WriteXMLFile1 ()
 Writes a parameter file for run 1.
 
const char * WriteXMLFile1a ()
 Writes a parameter file for run 1, without the file written.
 
const char * WriteXMLFile2 ()
 Writes a parameter file for run 2.
 
const char * WriteXMLFile3 ()
 Writes a parameter file for run 3.
 
const char * WriteXMLErrorFile1 ()
 Writes a parameter file where the competition harvest behavior is applied to seedlings.
 
const char * WriteXMLErrorFile2 ()
 Writes a parameter file where the harvest type is fixed interval and the harvest interval is less than 1.
 
const char * WriteXMLErrorFile3 ()
 Writes a parameter file where the harvest type is fixed BA with proportion to cut but cut amount is not a proportion between 0 and 1.
 
const char * WriteXMLErrorFile4 ()
 Writes a parameter file where the species proportions to cut do not add up to 1.
 
const char * WriteXMLErrorFile5 ()
 Writes a parameter file where the harvest type is fixed BA but the minimum interval is less than 1.
 
const char * WriteXMLErrorFile6 ()
 Writes a parameter file where a value in max crowding radius is not greater than 0.
 
void WriteCommonErrorStuff (std::fstream &oOut)
 Writes common portions of the test parameter files (tree pop, plot, etc).
 

Detailed Description

Tests the clCompetitionHarvest class.

Member Function Documentation

void clTestCompetitionHarvest::DoErrorProcessing ( clSimManager *  p_oSimManager)
protected

Tests error processing.

Parameters
p_oSimManagerSim manager object.
void clTestCompetitionHarvest::DoHarvestRun1 ( clSimManager *  p_oSimManager)
protected

Performs the first harvest run.

Parameters
p_oSimManagerSim manager object.
void clTestCompetitionHarvest::DoHarvestRun2 ( clSimManager *  p_oSimManager)
protected

Performs the second harvest run.

Parameters
p_oSimManagerSim manager object.
void clTestCompetitionHarvest::DoHarvestRun3 ( clSimManager *  p_oSimManager)
protected

Performs the third harvest run.

Parameters
p_oSimManagerSim manager object.
void clTestCompetitionHarvest::TestCompetitionHarvest ( )

Groups together all the other harvest testing functions into a comprehensive harvest test.

void clTestCompetitionHarvest::WriteCommonErrorStuff ( std::fstream &  oOut)
protected

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

Ends with </allometry>.

Parameters
oOutFile stream to write to.
const char* clTestCompetitionHarvest::WriteXMLErrorFile1 ( )
protected

Writes a parameter file where the competition harvest behavior is applied to seedlings.

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

Writes a parameter file where the harvest type is fixed interval and the harvest interval is less than 1.

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

Writes a parameter file where the harvest type is fixed BA with proportion to cut but cut amount is not a proportion between 0 and 1.

Returns
Filename written.
const char* clTestCompetitionHarvest::WriteXMLErrorFile4 ( )
protected

Writes a parameter file where the species proportions to cut do not add up to 1.

Returns
Filename written.
const char* clTestCompetitionHarvest::WriteXMLErrorFile5 ( )
protected

Writes a parameter file where the harvest type is fixed BA but the minimum interval is less than 1.

Returns
Filename written.
const char* clTestCompetitionHarvest::WriteXMLErrorFile6 ( )
protected

Writes a parameter file where a value in max crowding radius is not greater than 0.

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

Writes a parameter file for run 1.

Returns
Filename written.
const char* clTestCompetitionHarvest::WriteXMLFile1a ( )
protected

Writes a parameter file for run 1, without the file written.

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

Writes a parameter file for run 2.

Returns
Filename written.
const char* clTestCompetitionHarvest::WriteXMLFile3 ( )
protected

Writes a parameter file for run 3.

Returns
Filename written.

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