Corresponds to the clGLIPoints class. More...

Inheritance diagram for sortie.data.funcgroups.light.GLIPoints:

Public Member Functions
	GLIPoints (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString) throws ModelException
	Constructor. More...

void	addGLIPointsFile (String sFileName) throws ModelException
	Adds the points from a tab-delimited text GLI points file. More...

void	readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException
	Accepts an XML parent tag (empty, no data) from the parser. More...

void	validateSubData (TreePopulation oPop) throws ModelException
	Validates the data. More...

void	writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
	Overridden to write general light parameters only if hooked. More...

Public Member Functions inherited from sortie.data.funcgroups.light.GLIBase
	GLIBase (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString) throws ModelException
	Constructor. More...

boolean	isHookedBehavior ()

void	unhook ()
	Unhooks the behavior if necessary. More...

void	validateData (TreePopulation oPop) throws ModelException
	Validates the data. More...

ArrayList< BehaviorParameterDisplay >	formatDataForDisplay (TreePopulation oPop)
	Overridden to manage general light parameters. More...

void	writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
	Overridden to write general light parameters only if hooked. More...

BehaviorParameterDisplay	formatGeneralLightDataForDisplay (TreePopulation oPop)
	Formats the parameter table for general light. More...

ModelVector	getLightTransmissionCoefficient ()

abstract void	validateSubData (TreePopulation oPop) throws ModelException
	Validates the data. More...

void	readDataFromDisplay (ArrayList< BehaviorParameterDisplay > p_oData, TreePopulation oPop) throws ModelException
	Overridden to read general light parameters if necessary. More...

Public Member Functions inherited from sortie.data.funcgroups.Behavior
GUIManager	getGUIManager ()

	Behavior (GUIManager oManager, BehaviorTypeBase oParent, String sDescriptor, String sParFileTag, String sXMLRootString, String sHelpFileString)
	Constructor. More...

abstract void	validateData (TreePopulation oPop) throws ModelException
	Override this to implement data checking. More...

void	callSetupDialog (JDialog jParent, MainWindow oMain)
	Override this to call a specific setup dialog for this behavior. More...

int	getNumberOfDataObjects ()
	Gets the number of managed data objects. More...

ModelData	getDataObject (int iInd)
	Gets the managed data object at a particular index. More...

void	validate () throws ModelException
	Behavior performs an internal check to make sure its settings are consistent and logical. More...

void	setListPosition (int iListPosition) throws ModelException
	Sets the behavior list position. More...

int	getListPosition ()
	Gets the behavior list position. More...

String	getXMLParametersRoot ()
	Gets the XML parameter root string. More...

int	getNumberNewDataMembers ()

DataMember	getNewTreeDataMember (int iIndex) throws ModelException

void	setCanApplyTo (int iType, boolean bCanApply)
	Sets whether this behavior can apply to a given tree type. More...

String	getParameterFileBehaviorName ()
	Gets the parameter file name for this behavior. More...

double	getVersion ()
	Gets behavior's parameter file version. More...

double	getMinimumVersion ()
	Gets behavior's parameter file minimum version. More...

String	getDescriptor ()
	Gets the descriptor string. More...

String	getHelpFileString ()
	Gets the help file UD. More...

void	setDescriptor (String s)
	Sets the descriptor string. More...

int	getNumberOfCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

int	getNumberOfGrids ()
	Gets the number of grids to which this behavior applies. More...

void	deleteSpeciesTypeCombo (int iIndex) throws ModelException
	Deletes the SpeciesTypeCombo at the given index. More...

void	deleteSpeciesTypeCombo (SpeciesTypeCombo oCombo) throws ModelException
	Deletes a SpeciesTypeCombo. More...

void	clearSpeciesTypeCombos ()
	Empties the species/type combo list. More...

SpeciesTypeCombo	getSpeciesTypeCombo (int iIndex) throws ModelException
	Returns the SpeciesTypeCombo at the given index of the species/type combo list. More...

Grid	getGrid (int iIndex) throws ModelException
	Returns the Grid at the given index of the grid applies to list. More...

ModelData	getRequiredData (int iIndex)
	Returns the required data object at a given index. More...

int	getNumberOfRequiredDataObjects ()
	Gets the number of required data objects for this behavior. More...

void	addSpeciesTypeCombo (SpeciesTypeCombo oCombo) throws ModelException
	Adds a new species/type combo to the list to which this behavior applies. More...

void	addGrid (Grid oGrid, boolean bReplace)
	Adds a new Grid to the list to which this behavior applies. More...

void	addRequiredData (ModelData oData)
	Adds a piece of required data to the list. More...

boolean []	getWhichSpeciesUsed (TreePopulation oPop)
	Returns which species to which this behavior is applied. More...

boolean	setVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, ArrayList< String > p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, Attributes oParentAttributes, Attributes[] p_oAttributes) throws ModelException
	Sets a data vector's value. More...

boolean	setSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, Attributes oAttributes, Object oData) throws ModelException
	Sets a data object's value. More...

ModelData	findObjectByXMLTag (String sXMLTag)
	Finds an object based on its XML tag. More...

void	copySpecies (int iSpeciesCopyFrom, int iSpeciesCopyTo) throws ModelException
	Copies one species to another. More...

void	writeXML (BufferedWriter jOut, TreePopulation oPop) throws ModelException
	Writes the XML data to a parameter file for the behaviors owned by this object. More...

void	writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop) throws java.io.IOException, ModelException
	Writes a set of species-specific float values to a parameter file. More...

void	writeSpeciesSpecificValue (BufferedWriter jOut, ModelVector p_oData, TreePopulation oPop, boolean[] p_bFlags) throws java.io.IOException, ModelException
	Writes a set of species-specific values to a parameter file for a certain subset of species. More...

void	readXMLParentTag (String sXMLTag, Attributes oAttributes) throws ModelException
	Accepts an XML parent tag (empty, no data) from the parser. More...

void	changeOfSpeciesName (String sOldSpecies, String sNewSpecies)
	Performs any necessary tasks associated with changing the name of a species. More...

void	changeOfSpecies (int iOldNumSpecies, int[] p_iIndexer, String[] p_sNewSpecies) throws ModelException
	Triggered when there is a change in the species list. More...

boolean	getMustHaveTrees ()
	Gets whether this behavior must have trees. More...

ModelData	findObjectByDescriptor (String sDescriptor)
	Finds an object based on its descriptor. More...

void	writeBehaviorNode (BufferedWriter out, TreePopulation oPop) throws ModelException
	Writes behavior tags to the parameter file. More...

ArrayList< BehaviorParameterDisplay >	formatDataForDisplay (TreePopulation oPop)
	Formats data for display in a set of JTables. More...

String	getAppliedToForDisplay (TreePopulation oPop)
	Get which species/types this behavior applies to, in a display-friendly format truncated to 250 chars. More...

void	readDataFromDisplay (ArrayList< BehaviorParameterDisplay > oData, TreePopulation oPop) throws ModelException
	Reads in data from the parameter display window. More...

boolean	canBeDuplicated ()
	Whether or not this behavior can be duplicated in the run. More...

void	endOfParameterFileRead ()
	Called at the end of the parameter file read process. More...

void	changeOfPlotResolution (float fOldX, float fOldY, float fNewX, float fNewY) throws ModelException
	Performs any tasks associated with a change of plot resolution. More...

setupType	getSetupType ()

void	writeParametersToTextFile (FileWriter jOut, TreePopulation oPop) throws IOException
	Writes the parameters for the behavior to file, using the same system as the basic parameter display and entry system. More...

Protected Attributes
ModelInt	m_iNumPointsAltDiv
	Number of altitude divisions for GLI Points Creator, if different from GLI. More...

ModelInt	m_iNumPointsAziDiv
	Number of azimuth divisions for GLI Points Creator, if different from GLI. More...

ModelString	m_sGLIPointsInFile
	GLI points creator - filename of points input file. More...

ModelString	m_sGLIPointsOutFile
	GLI points creator - filename of points output file. More...

ModelFloat	m_fPointsMinSunAngle
	Minimum sun angle in radians for GLI points, if different from others. More...

ModelFloat	m_fAzimuthOfNorth
	Azimuth of north. More...

ArrayList< Points >	mp_oPoints = new ArrayList<Points>(0)
	Points objects, for GLI points. More...

Protected Attributes inherited from sortie.data.funcgroups.light.GLIBase
boolean	m_bHooked
	Whether this is the hooked behavior that will do this base class stuff. More...

Protected Attributes inherited from sortie.data.funcgroups.Behavior
GUIManager	m_oManager
	GUIManager object. More...

BehaviorTypeBase	m_oParent
	Parent manager. More...

ArrayList< ModelData >	mp_oAllData = new ArrayList<ModelData>()
	All data for this object. More...

ArrayList< SpeciesTypeCombo >	mp_oTreesAppliesTo = new ArrayList<SpeciesTypeCombo>(0)
	A set of SpeciesTypeCombo objects to which this behavior is applied - or none if it is not applied to trees. More...

ArrayList< Integer >	mp_iGridsAppliesTo = new ArrayList<Integer>(0)
	A set of hashcodes of the Grids to which this behavior is applied - or none if it is not applied to grids. More...

ArrayList< DataMember >	mp_oNewTreeDataMembers = new ArrayList<DataMember>(0)
	The new tree data members that this behavior adds, above and beyond the basic tree population data members. More...

boolean	m_bCanBeDuplicated = true
	Whether or not this behavior can have multiple copies in a run or not. More...

String	m_sDescriptor = ""
	This is what will be displayed as the name of a given behavior in the GUI. More...

String	m_sParFileTag = ""
	String which is used to identify this behavior in the parameter file. More...

String	m_sXMLRootString = ""
	XML tag to surround this behavior's data. More...

String	m_sHelpFileString = ""
	Help file topic identifier string. More...

boolean []	mp_bCanApplyToTreeType
	For each tree type, whether or not this behavior can be applied to it. More...

double	m_fVersion = 1.0
	Version of this behavior. More...

double	m_fMinVersion = 1.0
	Minimum version of this behavior. More...

int	m_iListPosition = -1
	This behavior's position in the behavior list. More...

setupType	m_iBehaviorSetupType

Additional Inherited Members
Static Public Member Functions inherited from sortie.data.funcgroups.light.GLIBase
static void	initialize ()
	Initializes the static members. More...

Static Public Member Functions inherited from sortie.data.funcgroups.Behavior
static void	setVectorValues (ModelVector oData, Float[] p_fValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Float[] p_fValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Double[] p_fValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Double[] p_fValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Integer[] p_iValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, String[] p_sValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, String[] p_sValuesToSet, boolean[] p_bAppliesTo)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector oData, Integer[] p_iValuesToSet)
	Sets the values for vector variables. More...

static void	setVectorValues (ModelVector p_oData, ArrayList< String > p_oValuesToSet, boolean[] p_bAppliesTo) throws ModelException
	Sets the values for vector variables. More...

static void	writeDataToFile (BufferedWriter ojOut, ModelData oData) throws java.io. IOException
	Writes a piece of data to an XML file. More...

static Object []	formatBlankHeaderRow (Object[][] p_oTable)
	Creates a blank header row for a table. More...

static Object [][]	formatDataAsComboBox (Object[][] p_oExisting, ModelEnum oToFormat)
	Adds a value with combo box formatting to an Object array for display in a JTable. More...

static String	formatComboBoxString (ModelEnum oToFormat)
	Formats a combo box string from a ModelEnum. More...

static void	addDataObjectToDisplayArrays (ModelData p_oDataObject, ArrayList< ModelData > p_oSingles, ArrayList< ArrayList< SpeciesSpecific >> p_oSpeciesSpecific, boolean[] p_bAppliesTo)
	Adds a data object to the arrays which will eventually display run parameters in a set of tables. More...

static Object [][]	addDataToArray (Object[][] p_oExistingArray, Object[] p_oAddArray)
	Adds an Object array to an existing Object array. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelFloat oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelInt oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelString oToFormat)
	Formats and adds a value into an Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat)
	Formats a vector of values into an object array and adds it to another Object array suitable for placing in a JTable. More...

static Object [][]	formatDataForTable (Object[][] p_oExisting, ModelVector oToFormat, boolean[] p_bWhichSpecies)
	Formats a vector of values into a plain vector suitable for placing in a JTable and adds it to a vector of vectors at the end. More...

static Object []	formatSpeciesHeaderRow (boolean[] p_bUsed, TreePopulation oPop)
	Creates an object array of strings consisting of species names, suitable for including in the parameter entry table. More...

static void	ensureSize (ArrayList<?> list, int size)
	Ensure an ArrayList is at least a specific size. More...

Public Attributes inherited from sortie.data.funcgroups.Behavior
boolean	m_bMustHaveTrees = true
	If true, and a tree has no species/type combos, it automatically becomes disabled. More...

Static Public Attributes inherited from sortie.data.funcgroups.light.GLIBase
static final String	sGeneralLightDescriptor = "General Light"

static final String	sGeneralLightParTag = "GeneralLight"

static final int	MID_CROWN = 0
	Value for fisheye photo taken at mid-crown - MUST match the enum value from the C++ code. More...

static final int	CROWN_TOP = 1
	Value for fisheye photo taken at crown top - MUST match the enum value from the C++ code. More...

Protected Member Functions inherited from sortie.data.funcgroups.Behavior
void	setSingleValue (ModelData oDataMember, Object oData) throws ModelException
	Sets the value of a single data member. More...

BehaviorParameterDisplay	formatTable (ArrayList< ModelData > p_oSingles, ArrayList< ArrayList< SpeciesSpecific >> p_oSpeciesSpecific, TreePopulation oPop)
	Turns vector groups of data objects into a set of tables for display. More...

Static Protected Member Functions inherited from sortie.data.funcgroups.Behavior
static boolean	boolArraysEqual (boolean[] p_bArrayOne, boolean[] p_bArrayTwo)
	Tests two boolean arrays for equality. More...

Static Protected Attributes inherited from sortie.data.funcgroups.light.GLIBase
static ModelVector	mp_fLightTransmissionCoefficient
	Species-specific - amount of light transmission. More...

static ModelVector	mp_fSnagClass1LightTransmissionCoefficient
	Species-specific - snag age class 1 amount of light transmission. More...

static ModelVector	mp_fSnagClass2LightTransmissionCoefficient
	Species-specific - snag age class 2 light transmission coefficient. More...

static ModelVector	mp_fSnagClass3LightTransmissionCoefficient
	Species-specific - snag age class 3 light transmission coefficient. More...

static ModelFloat	m_fBeamFractionOfGlobalRadiation
	Beam fraction of global radiation. More...

static ModelFloat	m_fClearSkyTransmissionCoefficient
	Clear sky transmission coefficient. More...

static ModelInt	m_iJulianDayGrowthStarts
	Start of growing season as Julian day. More...

static ModelInt	m_iJulianDayGrowthEnds
	End of growing season as Julian day. More...

static ModelInt	m_iSnagAgeClass1
	Upper age limit of snag size class 1. More...

static ModelInt	m_iSnagAgeClass2
	Upper age limit of snag size class 2. More...

Detailed Description

Corresponds to the clGLIPoints class.

Author: lora

8/3/15: Bug fix - input filename was being written to XML but shouldn't have been

Constructor & Destructor Documentation

◆ GLIPoints()

sortie.data.funcgroups.light.GLIPoints.GLIPoints	(	GUIManager	oManager,
		BehaviorTypeBase	oParent,
		String	sDescriptor,
		String	sParFileTag,
		String	sXMLRootString
	)		throws ModelException

Constructor.

Parameters

oManager	GUIManager object
oParent	Parent managing object.
sDescriptor	The name of the behavior for the user.
sParFileTag	String which is used to identify this behavior in the parameter file.
sXMLRootString	XML tag to surround this behavior's data.

Member Function Documentation

◆ addGLIPointsFile()

void sortie.data.funcgroups.light.GLIPoints.addGLIPointsFile ( String sFileName ) throws ModelException

Adds the points from a tab-delimited text GLI points file.

Any existing points are overwritten.

Parameters

sFileName File name of points file

Exceptions

ModelException

if:

A GLI coordinate is outside the plot
There's a negative GLI height

◆ readXMLParentTag()

void sortie.data.funcgroups.light.GLIPoints.readXMLParentTag	(	String	sXMLTag,
		Attributes	oAttributes
	)		throws ModelException

Accepts an XML parent tag (empty, no data) from the parser.

This function watches for tag li_GLIPoint.

Parameters

sXMLTag	The XML tag.
oAttributes	The attributes of this object.

Exceptions

ModelException if data is missing or invalid.

◆ validateSubData()

void sortie.data.funcgroups.light.GLIPoints.validateSubData ( TreePopulation oPop ) throws ModelException

Validates the data.

Parameters

oPop	TreePopulation object

Exceptions

ModelException

in any of the following cases:

If any of the following are not greater than zero:
- m_iNumPointsAltDiv
- m_iNumPointsAziDiv
- m_fPointsMinSunAngle

◆ writeXML()

void sortie.data.funcgroups.light.GLIPoints.writeXML	(	BufferedWriter	jOut,
		TreePopulation	oPop
	)		throws ModelException

Overridden to write general light parameters only if hooked.

Member Data Documentation

◆ m_fAzimuthOfNorth

ModelFloat sortie.data.funcgroups.light.GLIPoints.m_fAzimuthOfNorth

protected

Initial value:

= new ModelFloat(0,

"Azimuth of North, in rad", "li_AziOfNorth")

Azimuth of north.

◆ m_fPointsMinSunAngle

ModelFloat sortie.data.funcgroups.light.GLIPoints.m_fPointsMinSunAngle

protected

Initial value:

= new ModelFloat(0,

"Minimum Solar Angle for GLI Points Creator, in rad", "li_minSunAngle")

Minimum sun angle in radians for GLI points, if different from others.

◆ m_iNumPointsAltDiv

ModelInt sortie.data.funcgroups.light.GLIPoints.m_iNumPointsAltDiv

protected

Initial value:

= new ModelInt(0,
      "Number of Altitude Sky Divisions for GLI Points Creator",
  "li_numAltGrids")

Number of altitude divisions for GLI Points Creator, if different from GLI.

◆ m_iNumPointsAziDiv

ModelInt sortie.data.funcgroups.light.GLIPoints.m_iNumPointsAziDiv

protected

Initial value:

= new ModelInt(0,
      "Number of Azimuth Sky Divisions for GLI Points Creator",
  "li_numAziGrids")

Number of azimuth divisions for GLI Points Creator, if different from GLI.

◆ m_sGLIPointsInFile

ModelString sortie.data.funcgroups.light.GLIPoints.m_sGLIPointsInFile

protected

Initial value:

= new ModelString("",

"GLI Points Input File", "")

GLI points creator - filename of points input file.

◆ m_sGLIPointsOutFile

ModelString sortie.data.funcgroups.light.GLIPoints.m_sGLIPointsOutFile

protected

Initial value:

= new ModelString("",

"GLI Points Output File", "li_GLIPointsFilename")

GLI points creator - filename of points output file.

◆ mp_oPoints

ArrayList<Points> sortie.data.funcgroups.light.GLIPoints.mp_oPoints = new ArrayList<Points>(0)

protected

Points objects, for GLI points.

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

GLIPoints.java

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GLIPoints()

Member Function Documentation

◆ addGLIPointsFile()

◆ readXMLParentTag()

◆ validateSubData()

◆ writeXML()

Member Data Documentation

◆ m_fAzimuthOfNorth

◆ m_fPointsMinSunAngle

◆ m_iNumPointsAltDiv

◆ m_iNumPointsAziDiv

◆ m_sGLIPointsInFile

◆ m_sGLIPointsOutFile

◆ mp_oPoints