Heureka API .NET Documentation
TreatmentUnit Class Members
Fields  Properties  Methods 


The following tables list the members exposed by TreatmentUnit.

Public Constructors
 NameDescription
Public ConstructorTreatmentUnit ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)SqlSelectInvTreatmentUnit SQL statement for selecting inventory treatment unit from database  
Public Fieldstatic (Shared in Visual Basic)SqlTreatmentUnitsInHierarchyFunction  
Public Fieldstatic (Shared in Visual Basic)SqlTreatmentUnitsInHierarchyQuery  
Top
Public Properties
 NameDescription
Public PropertyAdjustedAreaFactor Representative productive area, adjusted for no of inventory years in simulation, in ha  
Public PropertyAfter Values after treatment  
Public PropertyArea Gets or sets productive area, in ha  
Public PropertyAreaFactor Representative area not adjusted for number of inventory years in simulation, ha  
Public PropertyAreaGuid Guid of area that treatment unit is defined in  
Public PropertyBefore Values before treatment  
Public PropertyCorrectionFactors Gets correction factors.  
Public PropertyCurrentLandUseCode Get the land use code for the current period  
Public PropertyCurrentPeriod Current period, e.g. period being calculated.  
Public PropertyDescription Description of treatment unit (free text)  
Public PropertyForestDomain Forest domain  
Public PropertyForestDomainNo Forest domain  
Public PropertyHasDeadTrees Returns true if any of the predictionunits contains Dead Trees  
Public PropertyImpediment Proportion of impediment  
Public PropertyInitialAdjustedAreaFactor Gets productive area factor when treatmentunit was created, in ha  
Public PropertyInventoryYear InventoryYear  
Public PropertyIsCircular Indication if sample plot is circular. Only applicable if IsSamplePlot is true.  
Public PropertyIsImpedimentOnly True if 100% of treatmentunit is impediment  
Public PropertyIsSamplePlot Indication if sample plot  
Public PropertyIsSetAside Is Treatment Unit set aside for Nature Conservation  
Public PropertyLandUseArray Get the land use array generated from last growth  
Public PropertyLastReservationForIntensiveFertilization Gets last period that treatmentunit was reserved for intensive fertilization. If not reserved -1 is returned  
Public PropertyMaxPeriod Maximum no of periods  
Public PropertyMinFinalFellingAge Minimum elligble final felling age in period 0 (Lägsta slutavverkningsålder enl. SVL)  
Public PropertyNCFractionOfParent Fraction of parent's area used to create this treatmentunit set aside for nature conservation.  
Public PropertyOriginalArea Gets the area the treatment unit was created with  
Public PropertyOriginalTreatmentUnitGuid Id of the treatment unit.  
Public PropertyOverstoreyCorrectionFactors Gets overstorey correction factors.  
Public PropertyOwnerType Type of owner  
Public PropertyOwningArea Area that contains the treatment unit.  
Public PropertyOwningAreaDescription Area (parent) that the treatment unit belongs to  
Public PropertyParentAreaFellingYears  
Public PropertyParentTreatmentUnitGuid Gets or sets treatment unit guid of the parent treatment unit of this treatment unit  
Public PropertyPeriodLength Gets period length for current period, i.e. length in years from previous period. 5 if current period is 0.  
Public PropertyPlanningHorizon Gets or sets length of planning horizon  
Public PropertyPolygonCenter Gets center of polygon  
Public PropertyPredictionUnits Gets the prediction units for this treatment unit  
Public PropertyResult Result for the current period  
Public PropertyRootArea Gets the root area for the treatment unit  
Public PropertySetAsideType Gets or sets the relation between the parent treatment unit and the child  
Public PropertySiteData Gets site data.  
Public PropertyStandObjectData StandObjectData for treatmentunit.  
Public PropertyStandRegisterColumnAlias Column aliases for UserDefinedColumns in StandObjectData.  
Public PropertyStartPeriod Gets or sets start period  
Public PropertyTreatmentControlCategory Treatment control category  
Public PropertyTreatmentControlCategoryArray Treatment control category array  
Public PropertyTreatmentProposals Treatment proposals for treatmentunit  
Public PropertyTreatments Treatment history  
Public PropertyTreatmentUnitExternalData ExternalData for treatmentunit.  
Public PropertyTreatmentUnitGuid Id of the treatment unit.  
Public PropertyTreatmentUnitType Gets or sets treatment unit type  
Public PropertyTrialSerieRevisionDictionary Gets data on trial serie revisions (GG-försöken). Key is date of revision.  
Public PropertyTrialSerieRevisions Gets data on trial serie revisions (GG-försöken). List is sorted on revisionDate with earliest date first.  
Public PropertyYear Gets or sets the year for the current period, offset from start of simulation (inventory year), to the current period  
Top
Public Methods
 NameDescription
Public MethodAddGrowthAdjuster Adds a growth adjuster that will start adjusting growth from this period and onwards.  
Public MethodAddTreatmentProposal Adds a TreatmentProposal from a give source to this treatment unit  
Public MethodAdjustGrowth Adjusts growth if necessary.  
Public MethodBack Backs growth of treatment period to an earlier period  
Public MethodClearMergedPredictionUnits Clear the merged prediction unit. The original prediction units will be used instead.  
Public MethodClearResults Removes all results from this treatment unit  
Public MethodClone Creates a deep copy of the treatment unit.  
Public MethodCloneNoPredictionUnits Creates a deep copy of the treatment unit except for prediction units which are excluded in the copy  
Public MethodCompareTo Compares this treatment unit to another treatment unit by description  
Public MethodCopyResults Gets a deep copy of all results for all periods up to current period. If _before is null, results are created for currentPeriod before copying  
Public MethodFillSingleTreatmentUnit Forces the treatment unit to load its data from the database, but does not fill other treatment units in the same area.  
Public MethodFillTreatmentUnit Forces the treatment unit to load its data from the database, and also fills all other treatment units in the same area  
Public MethodFindPeriod Finds the period for the given year  
Public MethodFirstEstablishedForestPeriod Returns the period this unit became established tree within the specified periods, if any; otherwise, returns -1.  
Public MethodGetAfter Values after treatment for a given period  
Public MethodGetBefore Values before treatment for a given period  
Public MethodGetGrowthAdjusters Gets the growth adjusters for a specific period. Will return an empty list if no growth adjusters were found  
Public MethodGetLandUseCode Get the land use code for the supplied period. If period 0 and no Land use code is specified, look in ExternalData table. If no land use code can be found plot is assumed to be productive.  
Public MethodGetPeriodForYear  
Public MethodGetPeriodForYearOffset  
Public MethodGetPeriodLength Gets the period length of the given period, i.e. length in years from previous period. 5 if current period is 0.  
Public MethodGetPlotTypesOverloaded.  Gets plot types before treatment for current period.  
Public MethodGetPlotTypesAfter Gets plot types after treatment for given period.  
Public MethodGetProductionModelControlTable  
Public MethodGetResult Result for a given period  
Public MethodGetResults All results produced so far  
Public MethodGetTreatmentControlCategory Treatment control category for a given period  
Public MethodGetTreatmentModelControlTable  
Public MethodGetYear Gets the year for the given period.  
Public MethodGrow Grows the treatment unit for one period  
Public MethodIncreaseMaxPeriod Increases MaxPeriod on treatmentunit and all underlying objects  
Public MethodInitializePredictionUnitsOverloaded.  Initializes the treatment unit with a new collection of prediction units.  
Public MethodIsFilled Gets a value indicating if the treatment unit has been filled with data or not  
Public MethodIsProductive Check if this treatment unit's current LandUseCode is ForestProductive  
Public MethodIsReservedForIntensiveFertilization Validates if treatmentunit is reserved for intensive fertilization and that fertilization has not yet been started  
Public MethodLoadPredictionUnitsIfRequired Preloads all prediction units  
Public MethodMergePredictionUnits Merge all prediction units into one prediction unit for increased performance  
Public MethodReassignWeights Reassigns weights to all prediction units  
Public MethodRemoveReservationsForIntensiveFertilization Removes reservations made on treatment unit for intensive fertilization. All reservations for given period and there after are removed.  
Public MethodRemoveRetainedStatusOnTrees Removes the retained tree status on all trees in the treatment unit and also removes any RetainedTreeRemover growth adjuster  
Public MethodReservedForIntensiveFertilizationAtPeriod Checks if reservation was added at given period  
Public MethodReserveForIntensiveFertilization Reserves treatmentunit for intensive fertilization. Reservation is made at current period.  
Public MethodReset Resets treatment unit to initial period  
Public MethodSetBeforeToAfter Sets result before to same result as result after ("hides" any actions that has been done on the treatment unit).  
Public MethodToStringReturns a string that represents the current object.  
Public MethodUpdateAfter Updates the values in the treatment unit after treatment (each prediction unit must be updated first)  
Public MethodUpdateBefore Updates the values in the treatment unit before treatment (each prediction unit must be updated first)  
Public MethodUpdateBeforeInterpolated Updates the values in the treatment unit before treatment (each prediction unit must be updated first)  
Public MethodUpdateInterpolated Updates with interpolated values.  
Top
See Also

Reference

TreatmentUnit Class
Slu.Heureka.DomainLayer.Forest Namespace

Send Feedback