Heureka API .NET Documentation
Tree Class Members
Fields  Properties  Methods 


The following tables list the members exposed by Tree.

Public Constructors
 NameDescription
Public ConstructorTree Constructor Creates a new tree for the row that the given record points to.  
Top
Public Fields
 NameDescription
Public FieldOverStoreyTree  
Public FieldSapling  
Top
Public Properties
 NameDescription
Public PropertyAgeBH Set and get breast height for current period  
Public PropertyAgeBHArray Real age at breast height, in years  
Public PropertyAgeToBH Age to breast height, years  
Public PropertyAgeTotal Total age, in years  
Public PropertyAgeTotalArray Biological age at breast height, in years  
Public PropertyBal Basal area of all larger trees on plot, in m2.  
Public PropertyBalArray Basal area of all larger trees on plot, in m2.  
Public PropertyBarkThickness Bark thickness (double), in cm.  
Public PropertyBarkThicknessArray BArk thickness (double), in cm.  
Public PropertyBasalArea Basal area, in cm2.  
Public PropertyBasalAreaArray Basal area, in cm2.  
Public PropertyBiomass Gets biomass for current period  
Public PropertyBiomassArray Gets the biomass array  
Public PropertyBreeded  
Public PropertyCalculationAgeBH Calculation age for growth functions, at breast height, in years  
Public PropertyCalculationAgeBHArray Calculation age for growth functions, at breast height, in years  
Public PropertyCropTreeProbablity Probability that tree will be crop tree. Gets/sets initial value for current period  
Public PropertyCropTreeProbablityArray Probability that tree will be crop tree. Before treatment. Only valid for saplings.  
Public PropertyCropTreeProbablityResidual Probability that tree will be crop tree. Gets/sets value for currrent period. Updated after cleaning.  
Public PropertyCropTreeProbablityResidualArray Probability that tree will be crop tree. Updated after cleaning.  
Public PropertyCrownDiameter Crown diameter (dm)  
Public PropertyCrownDiameterArray Gets or sets the crown diameter array.  
Public PropertyCrownLength Crown diameter (dm)  
Public PropertyCrownLengthArray Gets or sets the crown length array.  
Public PropertyDamageDegree Damage degree (sapling)  
Public PropertyDamageDegreeArray  
Public PropertyDatabaseOrigin Gets or sets if origin of tree is from database (ie prior to start om simulation)  
Public PropertyDiameter Diameter, in cm.  
Public PropertyDiameterArray Diameter, in cm.  
Public PropertyGPSEast East coordinate, m  
Public PropertyGPSNorth North coordinate, m  
Public PropertyGrowth Diameter growth of tree in current period, in cm  
Public PropertyGrowthArray Diameter growth of tree from current period to next, in cm  
Public PropertyHeight Height, in dm  
Public PropertyHeightArray Height, in dm  
Public PropertyHeightGrowth Height growth of tree from current period to next, in dm  
Public PropertyHeightGrowthArray Height growth of tree in current period, in dm  
Public PropertyInitialAge Initial age, in years  
Public PropertyInitialHeight Initial height, in dm  
Public PropertyInitialSapling This is true if the tree is a sapling that was created in period 0  
Public PropertyLayerId  
Public PropertyMortality Mortality, fraction of tree that dies from current time t to next time t+1  
Public PropertyMortalityArray Mortality, fraction of tree that dies. MortalityArray[t] = prop of stems of tree in time t that dies from t to t+1  
Public PropertyOriginalId Original Id of tree, e.g. id defined in another database (does not have to be unique).  
Public PropertyOriginalTreeGuid Original guid of the tree (will be different from TreeGuid when tree is cloned).  
Public PropertyPredictionUnit Prediction Unit Tree belongs to  
Public PropertySpecies Species  
Public PropertySpeciesGroup Species group  
Public PropertyStems Gets or sets number of stems this tree represents before treatment  
Public PropertyStemsArray Gets an array with the number of stems this tree represents before treatment in each period  
Public PropertyStemsCutNotExtracted Get or sets number of harvested stems for this tree  
Public PropertyStemsCutNotExtractedArray Number of stems cut bot not extracted, specifically understorey cleaning  
Public PropertyStemsHarvested Get or sets number of harvested stems for this tree  
Public PropertyStemsHarvestedArray Number of harvested stems for each tree (number per tree object within the prediction unit)  
Public PropertyStemsHighStumpArray  
Public PropertyStemsResidual Gets or sets number of stems this tree represents after treatment  
Public PropertyStemsResidualArray Gets an array with the number of stems this tree represents after treatment in each period  
Public PropertyStemsResidualBeforeUnderstoreyCleaning This property is only used to enable easy revert of understorey cleaning  
Public PropertyTreeCategory Category of tree  
Public PropertyTreeCategoryArray Category of tree  
Public PropertyTreeCategoryResidual Category of tree after treatment  
Public PropertyTreeCategoryResidualArray Category of tree after treatment  
Public PropertyTreeGuid Id of tree. A unique id nr for each tree  
Public PropertyTreeOrigin  
Public PropertyTreeType Type of tree  
Public PropertyTreeTypeArray Type of tree  
Public PropertyTreeTypeResidual Type of tree after treatment  
Public PropertyTreeTypeResidualArray Type of tree after treatment  
Public PropertyWindMortality Mortality, number of trees per ha that dies due to storm events from t to t+1  
Public PropertyWindMortalityArray Mortality, number of trees per ha that dies due to storm events from t to t+1  
Public PropertyVolume Volume of tree in dm3  
Public PropertyVolumeArray Volume of tree in dm3  
Public PropertyVolumeHighStump  
Top
Public Methods
 NameDescription
Public MethodCloneOverloaded.  Creates a deep copy  
Public MethodCopyValues  
Public Methodstatic (Shared in Visual Basic)CreateSaplingOverloaded.  Create a new instance of the Tree class, using a given species group and height  
Public Methodstatic (Shared in Visual Basic)CreateTreeOverloaded.  Create a new instance of the Tree class, using a given species group and diameter  
Public MethodGetAgeTotal Gets real total age, in years, in a given period  
Public MethodGetBiomass Gets biomass for a given period  
Public MethodGetCalculationAgeTotal Gets total age, in years, in a given period  
Public MethodGetDefaultAgeWhenPlanted Age of planted seedling.  
Public MethodGetDefaultHeightWhenPlanted Height of planted seedling.  
Public MethodGetStemsOverloaded.  Stems for current period.  
Public Methodstatic (Shared in Visual Basic)GetTreeAgeWhenPlanted  
Public Methodstatic (Shared in Visual Basic)GetTreeHeightWhenPlanted  
Public MethodGetTreeType TreeType for current period.  
Public MethodIsGPSEastNull Checks if east coordinate is null.  
Public MethodIsGPSNorthNull Checks if north coordinate is null  
Public MethodIsInitialAgeNull Checks if initial age is null  
Public MethodIsInitialHeightNull Checks if initial height is null  
Public MethodIsOfSpeciesOverloaded.  Returns true belongs to any of the species group in the given list.  
Public MethodIsOfSpeciesGroupOverloaded.  Returns true belongs to any of the species group in the given list.  
Public MethodIsOriginalIdNull Checks if original id is null  
Public MethodIsOverstoreyTreeOverloaded.  Checks if the tree is an overstorey tree.  
Public Methodstatic (Shared in Visual Basic)IsPlantedOrSown Gets if a TreeOrigin is planted or sown  
Public MethodIsRetainedTree Checks if the tree is a retained tree, either before or after treatment.  
Public MethodIsTypeOfOverloaded. Checks if the tree is of TreeType. TreeType to match (bit flag). If before not supplied, both before and after treatment is checked and if either of them has TreeType t then returns true (for CurrentPeriod)  
Public MethodIsValid  
Public MethodIsValidAndNotRemoved  
Public MethodKillTree Kill the tree in the current period  
Public MethodSetAgeBH Set age at breast for a certain period  
Public MethodSetBiomass  
Public MethodSetStems Sets stems in a given period  
Public MethodSetStemsResidual Sets stems residual in a given period  
Public Methodstatic (Shared in Visual Basic)ToExternalFormat Converts tree type to external format  
Public MethodToStringReturns a string that represents the current object.  
Public Methodstatic (Shared in Visual Basic)TryConvertFromExternalToInternalTreeTypeOverloaded.  Converts the String representation of a tree type from the external format to the internal format. A return value indicates whether the operation succeeded.  
Public MethodUpdateBasalArea Updates the basal area of the tree.  
Public MethodWasIngrownInPeriod  
Top
See Also

Reference

Tree Class
Slu.Heureka.DomainLayer.Forest Namespace

Send Feedback