Inheritance diagram for javawrapper::LightBehaviors:
Public Member Functions | |
LightBehaviors (GUIManager oManager) throws ModelException | |
Constructor. | |
void | AddGLIPointsFile (String sFileName) throws ModelException |
Adds the points from a tab-delimited text GLI points file. | |
void | DoSetup (TreePopulation oPop) throws ModelException |
Resets the points list. | |
boolean | SetVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, java.util.Vector p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, Attributes oParentAttributes, Attributes[] p_oAttributes) throws ModelException |
Overridden to make sure that only light values that apply to light behaviors are set. | |
void | WriteXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException |
Writes the settings in XML to a parameter file. | |
void | ValidateData (TreePopulation oPop) throws ModelException |
Validates the data prior to its use in, for instance, a parameter file. | |
void | ReadXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException |
Accepts an XML parent tag (empty, no data) from the parser. | |
boolean | SetSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, Attributes oAttributes, Object oData) throws ModelException |
Makes sure values go to the correct behavior. | |
Behavior | GetBehaviorByXMLTag (String sXMLTag) |
Traps for the behavior replacement of radial light with constant GLI. | |
Static Public Attributes | |
static final int | MID_CROWN = 0 |
Value for fisheye photo taken at mid-crown - MUST match the enum value from the C++ code. | |
static final int | CROWN_TOP = 1 |
Value for fisheye photo taken at crown top - MUST match the enum value from the C++ code. | |
static final int | ALL_HEIGHT = 0 |
Value for sail light shading neighbor crown depths being approximated as extending the full height of the tree - MUST match the enum value from the C++ code. | |
static final int | FRAC_HEIGHT = 1 |
Value for sail light shading neighbor crown depths having their normal depth - MUST match the enum value from the C++ code. | |
Protected Attributes | |
ModelVector | mp_fLightTransmissionCoefficient |
Species-specific - light transmission coefficient. | |
ModelVector | mp_fSnagClass1LightTransmissionCoefficient |
Species-specific - snag age class 1 light transmission coefficient. | |
ModelVector | mp_fSnagClass2LightTransmissionCoefficient |
Species-specific - snag age class 2 light transmission coefficient. | |
ModelVector | mp_fSnagClass3LightTransmissionCoefficient |
Species-specific - snag age class 3 light transmission coefficient. | |
ModelVector | mp_iBasalAreaLightWhatType |
Basal area light - tree type: angiosperm (0) or conifer (1). | |
ModelFloat | m_fBeamFractionOfGlobalRadiation |
Beam fraction of global radiation. | |
ModelFloat | m_fClearSkyTransmissionCoefficient |
Clear sky transmission coefficient. | |
ModelFloat | m_fGLIMinSunAngle |
Minimum sun angle in radians. | |
ModelFloat | m_fQuadratMinSunAngle |
Minimum sun angle in radians for quadrat, if different from GLI. | |
ModelFloat | m_fMapMinSunAngle |
Minimum sun angle in radians for GLI map, if different from others. | |
ModelFloat | m_fPointsMinSunAngle |
Minimum sun angle in radians for GLI points, if different from others. | |
ModelFloat | m_fQuadratLightHeight |
Height at which GLI is calculated in quadrats. | |
ModelFloat | m_fMapLightHeight |
Height at which GLI is calculated for GLI Map Creator. | |
ModelFloat | m_fSailLightMaxShadingRadius |
Maximum shading radius for sail light. | |
ModelFloat | m_fSailLightMaskAngle |
Minimum sun angle in degrees. | |
ModelFloat | m_fFilterLightTransmissionCoefficient |
Light transmission coefficient for the light filter. | |
ModelFloat | m_fFilterHeight |
Height of light filter, in meters. | |
ModelFloat | m_fStmLightMaxRadius |
Storm light - max radius of storm neighbors, in meters. | |
ModelFloat | m_fStmLightSlope |
Storm light - slope of light function. | |
ModelFloat | m_fStmLightIntercept |
Storm light - intercept of light function. | |
ModelFloat | m_fStmLightMinCanopyTrees |
Storm light - minimum number of trees for full canopy. | |
ModelFloat | m_fStmLightRandPar |
Storm light - standard deviation or clumping parameter. | |
ModelFloat | m_fBasalAreaLightA |
Basal area light "a" parameter for calculating mean GLI from basal area. | |
ModelFloat | m_fBasalAreaLightConiferB |
Basal area light conifer "b" parameter for calculating mean GLI from basal area. | |
ModelFloat | m_fBasalAreaLightConiferC |
Basal area light conifer "c" parameter for calculating mean GLI from basal area. | |
ModelFloat | m_fBasalAreaLightAngiospermB |
Basal area light angiosperm "b" parameter for calculating mean GLI from basal area. | |
ModelFloat | m_fBasalAreaLightAngiospermC |
Basal area light angiosperm "c" parameter for calculating mean GLI from basal area. | |
ModelFloat | m_fBasalAreaLightSigma |
Basal area light sigma parameter for lognormal PDF. | |
ModelFloat | m_fBasalAreaLightMinDBH |
Basal area light minimum DBH (cm) for a tree counting towards the basal area. | |
ModelFloat | m_fBasalAreaLightChangeThreshold |
Basal area light basal threshold, in square meters, for new trees in grid cell for recalculating GLI. | |
ModelFloat | m_fBasalAreaSearchRadius |
Basal area light search radius for neighbors. | |
ModelFloat | m_fConstantGLIValue |
Constant GLI - constant GLI value. | |
ModelString | m_sGLIPointsInFile = new ModelString("", "GLI Points Input File", "") |
GLI points creator - filename of points input file. | |
ModelString | m_sGLIPointsOutFile = new ModelString("", "GLI Points Output File", "li_GLIPointsFilename") |
GLI points creator - filename of points output file. | |
ModelInt | m_iStmLightMaxDmgTime |
Storm light - max time (years) for damaged trees to influence. | |
ModelInt | m_iStmLightMaxSnagDmgTime |
Storm light - max time (years) for snags to influence. | |
ModelInt | m_iNumGLIAziDiv |
Number of azimuth divisions in sky hemisphere for GLI light calculations. | |
ModelInt | m_iNumGLIAltDiv |
Number of altitude divisions in sky hemisphere for GLI light calculations. | |
ModelInt | m_iNumQuadratAziDiv |
Number of azimuth divisions for quadrat, if different from GLI. | |
ModelInt | m_iNumMapAziDiv |
Number of azimuth divisions for GLI Map Creator, if different from GLI. | |
ModelInt | m_iNumPointsAziDiv |
Number of azimuth divisions for GLI Points Creator, if different from GLI. | |
ModelInt | m_iNumQuadratAltDiv |
Number of altitude divisions for quadrat, if different from GLI. | |
ModelInt | m_iNumMapAltDiv |
Number of altitude divisions for GLI Map Creator, if different from GLI. | |
ModelInt | m_iNumPointsAltDiv |
Number of altitude divisions for GLI Points Creator, if different from GLI. | |
ModelInt | m_iJulianDayGrowthStarts |
Start of growing season as Julian day. | |
ModelInt | m_iJulianDayGrowthEnds |
End of growing season as Julian day. | |
ModelInt | m_iSnagAgeClass1 |
Upper age limit of snag size class 1. | |
ModelInt | m_iSnagAgeClass2 |
Upper age limit of snag size class 2. | |
ModelEnum | m_iHeightOfFishEyePhoto |
Height of fisheye photo - valid values are MID_CROWN and CROWN_TOP. | |
ModelEnum | m_iCrownFractionOfHeight |
What fraction of the height of a shading neighbor its crown covers - valid values are ALL_HEIGHT or FRAC_HEIGHT. | |
Vector | mp_oPoints = new Vector(0) |
Points objects, for GLI points. |
Copyright: Copyright (c) 2003 Charles D. Canham
Company: Institute of Ecosystem Studies
javawrapper::LightBehaviors::LightBehaviors | ( | GUIManager | oManager | ) | throws ModelException [inline] |
Constructor.
oManager | GUIManager object. |
ModelException | If something goes wrong in setup. |
void javawrapper::LightBehaviors::AddGLIPointsFile | ( | String | sFileName | ) | throws ModelException [inline] |
Adds the points from a tab-delimited text GLI points file.
Any existing points are overwritten.
sFileName | File name of points file |
ModelException | if:
|
void javawrapper::LightBehaviors::DoSetup | ( | TreePopulation | oPop | ) | throws ModelException [inline, virtual] |
Resets the points list.
oPop | Tree population |
ModelException | Not thrown. |
Implements javawrapper::WorkerBase.
boolean javawrapper::LightBehaviors::SetVectorValueByXMLTag | ( | String | sXMLTag, | |
String | sXMLParentTag, | |||
java.util.Vector | p_oData, | |||
String[] | p_sChildXMLTags, | |||
boolean[] | p_bAppliesTo, | |||
Attributes | oParentAttributes, | |||
Attributes[] | p_oAttributes | |||
) | throws ModelException [inline] |
Overridden to make sure that only light values that apply to light behaviors are set.
There are other behaviors with light values (like Puerto Rico establishment), and this will make sure that those parameters are not "stolen" by light.
sXMLTag | Parent XML tag of data vector whose value is to be set. | |
sXMLParentTag | The immediate parent tag that sXMLTag is within. | |
p_oData | Vector of data values appropriate to the data type | |
p_sChildXMLTags | The XML tags of the child elements | |
p_bAppliesTo | Array of booleans saying which of the vector values should be set. This is important in the case of species-specifics - the vector index is the species number but not all species are set. | |
oParentAttributes | Attributes of parent tag. May be useful when overridding this for unusual tags. | |
p_oAttributes | Attributes passed from parser. This may be needed when overriding this function. Basic species-specific values are already handled by this function. |
ModelException | if the value could not be assigned to the data object. |
void javawrapper::LightBehaviors::WriteXML | ( | BufferedWriter | jOut, | |
TreePopulation | oPop | |||
) | throws ModelException [inline] |
Writes the settings in XML to a parameter file.
Overridden because light is special.
jOut | File to write to. | |
oPop | Tree population. |
ModelException | If the file is bad. |
Reimplemented from javawrapper::BehaviorTypeBase.
void javawrapper::LightBehaviors::ValidateData | ( | TreePopulation | oPop | ) | throws ModelException [inline, virtual] |
Validates the data prior to its use in, for instance, a parameter file.
oPop | TreePopulation object |
ModelException | in any of the following cases:
|
Implements javawrapper::WorkerBase.
void javawrapper::LightBehaviors::ReadXMLParentTag | ( | String | sXMLTag, | |
Attributes | oAttributes | |||
) | throws ModelException [inline] |
Accepts an XML parent tag (empty, no data) from the parser.
This function watches for tag li_GLIPoint.
sXMLTag | The XML tag. | |
oAttributes | The attributes of this object. |
ModelException | if data is missing or invalid. |
Reimplemented from javawrapper::WorkerBase.
boolean javawrapper::LightBehaviors::SetSingleValueByXMLTag | ( | String | sXMLTag, | |
String | sXMLParentTag, | |||
Attributes | oAttributes, | |||
Object | oData | |||
) | throws ModelException [inline] |
Makes sure values go to the correct behavior.
We override this function because some values (number of azimuth angles, number of altitude angles, and minimum sun angle) can apply to any of three behaviors, so we want to make sure they are assigned to the correct one.
sXMLTag | XML tag of object to assign. | |
sXMLParentTag | The immediate parent tag that sXMLTag is within. | |
oAttributes | Ignored. | |
oData | Data to assign. |
ModelException | not thrown here. |
Reimplemented from javawrapper::WorkerBase.
Behavior javawrapper::LightBehaviors::GetBehaviorByXMLTag | ( | String | sXMLTag | ) | [inline] |
Traps for the behavior replacement of radial light with constant GLI.
This could be removed by 6.10 or so.
sXMLTag | String The XML tag for which to find a behavior. |
Reimplemented from javawrapper::BehaviorTypeBase.