SORTIE Core C++ Documentation
Public Member Functions | Public Attributes | List of all members
clGliLight Class Reference

GLI Light - Version 1.0. More...

#include <GLILight.h>

Inheritance diagram for clGliLight:
clGLIBase clLightBase clBehaviorBase clWorkerBase

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.
 
- Public Member Functions inherited from clGLIBase
 clGLIBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clGLIBase ()
 Destructor.
 
float GetSinMinSunAng ()
 Gets the sine of the minimum sun angle.
 
float GetAziChunkConverter ()
 Gets the reciprocal of the size of a single azimuth sky grid division, in degrees.
 
float GetRcpTanMinAng ()
 Gets the reciprocal of the tangent of the minimum sun angle.
 
- Public Member Functions inherited from clLightBase
 clLightBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clLightBase ()
 Destructor.
 
void Action ()
 Performs all light calculations.
 
void RegisterTreeDataMembers ()
 Performs data member registrations for "Light".
 
clLightOrgGetLightOrg ()
 Gets the light org object.
 
float GetMinSunAngle ()
 Gets the altitude angle below which the sky is assumed to be dark.
 
float GetNumAziAng ()
 Gets the number of azimuth angles into which the sky hemisphere is divided.
 
float GetNumAltAng ()
 Gets the number of altitude angles into which the sky hemisphere is divided.
 
float GetMinAngRow ()
 Gets the row in the brightness array corresponding to the minimum solar angle.
 
float GetBrightness (int alt, int azi)
 
- Public Member Functions inherited from clBehaviorBase
virtual float GetBehaviorVersion ()
 Gets the behavior version number.
 
 clBehaviorBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clBehaviorBase ()
 Destructor.
 
virtual short int ValidateVersionNumber (float fTestVersion)
 Makes sure that the version number of a file passed is between the minimum and current version numbers.
 
virtual void SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
 Sets the species/type combos for a behavior.
 
virtual void SetNameData (std::string sNameString)
 Sets the string for the parameter file behavior.
 
virtual short int GetNewTreeInts ()
 Gets the number of new tree integer data members this behavior wants to register.
 
virtual short int GetNewTreeFloats ()
 Gets the number of new tree float data members this behavior wants to register.
 
virtual short int GetNewTreeChars ()
 Gets the number of new tree character data members this behavior wants to register.
 
virtual short int GetNewTreeBools ()
 Gets the number of new tree bool data members this behavior wants to register.
 
virtual short int GetNumSpeciesTypeCombos ()
 Gets the number of species/type combos to which this behavior applies.
 
virtual short int GetNumBehaviorSpecies ()
 Gets the number of unique tree species to which this behavior applies.
 
struct stcSpeciesTypeCombo GetSpeciesTypeCombo (short int iIndex)
 Gets one of this behavior's type/species combos.
 
virtual short int GetBehaviorSpecies (short int iIndex)
 Gets one of the behavior's species.
 
short int GetBehaviorListNumber ()
 Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
 
void SetBehaviorListNumber (short int iNumber)
 Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
 
std::string FormatSpeciesTypeQueryString ()
 Formats the string for species/types query.
 
virtual DOMElement * GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
 This will get the correct set of parameters for this behavior based on the behavior list position number.
 
- Public Member Functions inherited from clWorkerBase
 clWorkerBase (clSimManager *p_oSimManager)
 Constructor.
 
virtual ~clWorkerBase ()
 Destructor.
 
std::string GetName ()
 Gets the object's namestring.
 
clSimManagerGetSimManager ()
 
void DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
 Triggers the setup process.
 
virtual void TimestepCleanup ()
 Performs any necessary cleanup operations at the end of a timestep.
 
virtual void EndOfRunCleanup ()
 Performs any necessary cleanup operations at the end of a run.
 

Public Attributes

clLightOrg::fotocrowndpth m_iPhotoDepth
 Depth of fisheye photo in tree.
 

Additional Inherited Members

- Protected Member Functions inherited from clGLIBase
void AddTreeToGliFishEye (const float &fTargetX, const float &fTargetY, const float &fTargetHeight, clTree *p_oNeighbor, clPlot *p_oPlot, clTreePopulation *p_oPop, clAllometry *p_oAllom)
 Adds one shading neighbor to the fisheye photo array for a GLI calculation.
 
void GLIFisheyeNoCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, const float &fDistToNearEdge, clTree *p_oNeighbor, clPlot *p_oPlot, clAllometry *p_oAllom)
 Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees do not overlap.
 
void GLIFisheyeCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, clTree *p_oNeighbor, clPlot *p_oPlot, clAllometry *p_oAllom)
 Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees overlap.
 
- Protected Attributes inherited from clGLIBase
float m_fSinMinSunAng
 Sin of the min sun angle.
 
float m_fAziChunkConverter
 Reciprocal of the size of a single azimuth sky grid division, in degrees.
 
float m_fRcpTanMinAng
 1/tan (m_fMinSunAngle).
 
float * mp_fAziSlope
 For each azimuth chunk of sky, this holds the slope of the line to the middle of the chunk.
 
- Static Protected Attributes inherited from clLightBase
static clLightOrgmp_oLightOrg
 clLightOrg object - this pointer is held in common by all shells
 

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 2011 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Constructor & Destructor Documentation

clGliLight::clGliLight ( clSimManager p_oSimManager)

Constructor.

The constructor will set the namestring.

Parameters
p_oSimManagerSim manager.

Member Function Documentation

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

Calculates a GLI value.

Parameters
p_oTreeTree for which to calculate GLI.
p_oPopPointer to the tree population object.
Returns
GLI, as a percentage of full sun between 0 and 100.

Implements clLightBase.

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_oDocDOM tree of parsed parameter file.

Reimplemented from clLightBase.

Member Data Documentation

clLightOrg::fotocrowndpth clGliLight::m_iPhotoDepth

Depth of fisheye photo in tree.

Defaults to top of crown, and thus is not required in the parameter file. Old parameter fotodepth


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