Core_Model_Tester/TestConditOmegaCalculator.h at master · LMurphy186232/Core_Model_Tester · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
//---------------------------------------------------------------------------
// TestConditOmegaCalculator
//---------------------------------------------------------------------------
#if !defined(TestConditOmegaCalculator_H)
#define TestConditOmegaCalculator_H

#include <fstream>

class clTreePopulation;
class clPlot;
class clGrid;

/**
 * Creates the set of testing trees.
 * @param p_oPop Tree population
 * @param p_oPlot Plot object
 * @param fOffset Any offset to be applied to the tree coordinates
 */
void CreateTrees(clTreePopulation *p_oPop, clPlot *p_oPlot, float fOffset);

/**
 * Checks the results of the Condit's Omega grid for the first run.
 * @param p_oGrid Condit's Omega grid.
 */
void CheckConditOmegaCalculatorRun1Results(clGrid *p_oGrid);

/**
 * Writes the parameter file for normal processing. There are 4 species;
 * timestep length is 1 year; there is only one behavior, the Condit's Omega
 * calculator behavior.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLFile1();

/**
 * Writes the parameter file for normal processing. There are 4 species;
 * timestep length is 1 year; there is only one behavior, the Condit's Omega
 * calculator behavior.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLFile2();

/**
 * Writes the parameter file for normal processing. There are 4 species;
 * timestep length is 1 year; there is only one behavior, the Condit's Omega
 * calculator behavior.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLFile3();

/**
 * Writes the parameter file for normal processing. There are 4 species;
 * timestep length is 1 year; there is only one behavior, the Condit's Omega
 * calculator behavior.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLFile4();

/**
 * Writes an error file where the max distance is less than the increment.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLErrorFile1();

/**
 * Writes an error file where the max distance is less than zero.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLErrorFile2();

/**
 * Writes an error file where the increment is less than zero.
 * @return Filename written.
 */
const char* WriteConditOmegaCalculatorXMLErrorFile3();

/**
 * Writes common portions of the test parameter files between the plot and
 * the analysis parameters.
 * @param oOut File stream to write to.
 */
void WriteConditOmegaCalculatorCommonStuff(std::fstream &oOut);

//---------------------------------------------------------------------------
#endif // TestConditOmegaCalculator_H