Heureka API .NET Documentation
ApiState Class Members
Properties  Methods 


The following tables list the members exposed by ApiState.

Public Properties
 NameDescription
Public PropertyBasalAreaHa Gets or sets the basal area per ha.  
Public PropertyBefore True if this instance represents the state before treatment. Otherwise it's the state after a treatment  
Public PropertyDate Inventory or projected date  
Public PropertyDescription A description for this layer  
Public PropertyHasIngrownTreesLayer  
Public PropertyHasTreatmentData Returns true if treatment data is available in this state  
Public PropertyHasValueData Returns true if treatment data is available in this state  
Public PropertyHeurekaPeriod Heureka period index  
Public PropertyIngrownTreesLayer Gets the ingrown trees layer, if present. Otherwise returns null  
Public PropertyIngrownTreesLayerID Gets the Guid of the Ingrown trees layer  
Public PropertyMainSpecies Main crop species (huvudträdslag)  
Public PropertyMeanAge Gets or sets the mean age = basal area weighted mean age of trees for established stands, and mean arithmetic tree age of main species for young stands  
Public PropertyMeanDiameterDgvExclOverstorey Gets the mean basal area weighted mean diameter (cm)  
Public PropertyMeanHeightAllSpeciesExclOverstorey Gets the mean height of the trees (basal area weighted for established stand, arithemtic for young stands)  
Public PropertyTreatmentData If this is the state after a treatment, this property contains the treatment data of that treatment  
Public PropertyTreeLayersRead-only collection of ApiTreeLayerData  
Public PropertyTreesPerHa Gets or sets the number of trees per ha.  
Public PropertyValueData If this is the state after a treatment, this property contains the value data of that treatment (revenues, timber volumes, harvest residue extractions etc)  
Public PropertyVolumeHa Gets or sets the volume per ha.  
Top
Public Methods
 NameDescription
Public MethodAddTreeLayerUse this method to add an ApiTreeLayerData to the compartment  
Public MethodAddTreeLayersUse this method to add a list of ApiTreeLayerData to the compartment  
Public MethodDeepClone Creates a deep clone of an ApiState, except the refrence to the AiCompartment  
Public MethodGetLayerOverloaded. Gets the layer with a given layer id (Guid).  
Public MethodGetLayersOverloaded. Gets all layers with a given Slu.Heureka.DomainLayer.CommonForestModels.SpeciesCode.  
Public MethodSumLayersOverloaded.  Sums all layers whose LayerSpeciesCode is in the speciesCodeslist  
Public MethodSumTreesOverloaded. Creates an ApiTreeLayerDataobject for all trees that belong to any of the species in the provided species group list.  
Public MethodToStringReturns a string that represents the current object.  
Public MethodUpdateTotals Calculate totals and sums over added tree layers. Overstorey layers are excluded. TODO: Varför då?????  
Top
See Also

Reference

ApiState Class
Slu.Heureka.HeurekaAPI.Data Namespace

Send Feedback