clGliLight Class Reference

GLI Light - Version 1.0. More...

#include <GLILight.h>

Inheritance diagram for clGliLight:

clGLIBase clLightBase clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clGliLight (clSimManager *p_oSimManager)
 Constructor.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads some extra parameters from the parameter file.
float CalcLightValue (clTree *p_oTree, clTreePopulation *p_oPop)
 Calculates a GLI value.


Detailed Description

GLI Light - Version 1.0.

This calculates a GLI (global light index) for a tree. The namestring for this behavior is "glilightshell". The parameter file call string is "glilight".

The sky brightness array used by this behavior is potentially identical to that for quadrat-based GLI light - class name clQuadratGliLight, namestring "quadratglilightshell". Before committing to the calculation of a brightness array, this behavior will ask that behavior if it's already done it and this behavior can just copy.

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)

Constructor & Destructor Documentation

clGliLight::clGliLight ( clSimManager p_oSimManager  ) 

Constructor.

The constructor will set the namestring.


Member Function Documentation

void clGliLight::DoShellSetup ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Reads some extra parameters from the parameter file.

Number of azimuth angles and number of altitude angles are required to be present in the "glilight" tag.

Parameters:
p_oDoc DOM tree of parsed parameter file.

Reimplemented from clLightBase.

float clGliLight::CalcLightValue ( clTree p_oTree,
clTreePopulation p_oPop 
) [virtual]

Calculates a GLI value.

Parameters:
p_oTree Tree for which to calculate GLI.
p_oPop Pointer to the tree population object.
Returns:
GLI, as a percentage of full sun between 0 and 100.

Implements clLightBase.


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

Generated on Tue Apr 19 13:56:10 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6