#include <GLIPoints.h>
Inheritance diagram for clGLIPoints:
Public Member Functions | |
clGLIPoints (clSimManager *p_oSimManager) | |
Constructor. | |
~clGLIPoints () | |
Destructor. | |
void | GetData (xercesc::DOMDocument *p_oDoc) |
Does setup for this object. | |
void | Action () |
Calculates the GLI values. | |
float | CalcLightValue (clTree *p_oTree, clTreePopulation *p_oPop) |
Required overridden function - doesn't do anything. | |
Protected Member Functions | |
void | ReadParameterFileData (xercesc::DOMDocument *p_oDoc) |
Reads in needed parameter file data. | |
void | SetUpBrightnessArray () |
Sets up the light brightness array. | |
void | DoSetupCalculations () |
Performs setup calculations. | |
Protected Attributes | |
clGLIPoints::stcCoords * | mp_pointsList |
Structure for holding GLI points List of points for which to calculate GLI. | |
int | m_iNumPoints |
How many points are in mp_pointsList. | |
char | m_cFileName [MAX_FILENAME_SIZE] |
Points output file file name. | |
Classes | |
struct | stcCoords |
Structure for holding GLI points. More... |
This behavior creates a GLI value for each of a list of user-defined points. The user includes in the parameter file a points file with a set of X and Y coordinates and a height. For each timestep, this will calculate the GLI for each of those points and then write the results to a tab-delimited text file. This behavior does not need to be applied to any trees. Nothing else is done with the GLI values. This is an analysis behavior that prepares some calculations; the user can use the values however they see fit.
The namestring and parameter file call string for this behavior is "GLI Point Creator". This class is descended from clGLIBase so it can use its light calculation methods, but since the string "lightshell" is ommitted from this class's namestring, it should not be treated as a light behavior.
The sky brightness array used by this behavior is potentially identical to that for other GLI light behaviors. Before committing to the calculation of a brightness array, this behavior will ask those behaviors if their settings are identical. If they are, and that class has already calculated the brightness array, this behavior can just copy.
Copyright 2005 Charles D. Canham.
|
Constructor. Sets the namestring.
|
|
Destructor. Frees memory. |
|
Calculates the GLI values. For each point, this calculates its GLI and then writes the result to the output file. Reimplemented from clLightBase. |
|
Required overridden function - doesn't do anything.
Implements clLightBase. |
|
Performs setup calculations. This calculates the values for m_fAziChunkConverter, m_fRcpTanMinAng, and mp_fAziSlope. |
|
Does setup for this object. Calls the following functions:
Reimplemented from clLightBase. |
|
Reads in needed parameter file data. First this looks for the "gliPoints" tag and tries to read in all its data from that (in case the user has provided different sky grid settings to different light objects). If there's no sky grid data in the "gliPoints" tag, then this will get what it needs from the first tag it finds with these values. (The "gliPoints" tag, no matter what, must have the GLI points list and the filename of the output file.)
|
|
Sets up the light brightness array. This will check to see if it can share the brightness array with clGliLight or clQuadratGliLight, and if not, it creates the sky brightness array. |
|
Points output file file name. If it already exists, the file is overwritten |