EngForestService

Operations

Index Method Parameters Response Type Description
1 addEngForest
EngForestService___AddEngForest
EngForestServiceAddEngForestResponse
2 setEngForest
EngForestService___SetEngForest
EngForestServiceSetEngForestResponse
3 getEngForests
EngForestService___GetEngForests
EngForestServiceGetEngForestsResponse
4 calculateDisplacementHeights
EngForestService___CalculateDisplacementHeights
EngForestServiceCalculateDisplacementHeightsResponse

addEngForest

Parameters

Name Type Required Description
EngForestService___AddEngForest
EngForestServiceAddEngForest
Property Type Required Description
name String Y
Y

Response

Name Type Required Description
EngForestService___AddEngForestResponse
EngForestServiceAddEngForestResponse
Property Type Required Description
Result TApiEFSetupItem Y
Result.Handle Integer Y
Result.Name String Y
Result.Ndx Integer Y
Result.InputType TApifHitType Y
Result.RoughnessType TApiRouType Y
Result.RoughnessFromValue Double Y
Result.RoughnessToValue Double Y
Result.RoughnessHeightValue Double Y
Result.RoughnessLineObjectHandle Integer Y
Result.RoughnessAreaObjectHandle Integer Y
Result.HeightAreaObjectHandle Integer Y
Result.HeightLineObjectHandle Integer Y
Result.HeightGridObjectHandle Integer Y
Result.HeightGridObjectLayerId String Y
Result.ForestType TApiEFForestType Y
Result.TreeTopHeightFactor Double Y
Result.UpWindDistanceFactor Double Y
Result.DownWindDistanceFactor Double Y
Y

setEngForest

Parameters

Name Type Required Description
EngForestService___SetEngForest
EngForestServiceSetEngForest
Property Type Required Description
engForest TApiEFSetupItem Y
engForest.Handle Integer Y
engForest.Name String Y
engForest.Ndx Integer Y
engForest.InputType TApifHitType Y
engForest.RoughnessType TApiRouType Y
engForest.RoughnessFromValue Double Y
engForest.RoughnessToValue Double Y
engForest.RoughnessHeightValue Double Y
engForest.RoughnessLineObjectHandle Integer Y
engForest.RoughnessAreaObjectHandle Integer Y
engForest.HeightAreaObjectHandle Integer Y
engForest.HeightLineObjectHandle Integer Y
engForest.HeightGridObjectHandle Integer Y
engForest.HeightGridObjectLayerId String Y
engForest.ForestType TApiEFForestType Y
engForest.TreeTopHeightFactor Double Y
engForest.UpWindDistanceFactor Double Y
engForest.DownWindDistanceFactor Double Y
Y

Response

Name Type Required Description
EngForestService___SetEngForestResponse
EngForestServiceSetEngForestResponse
Property Type Required Description
Result Boolean Y
Y

getEngForests

Parameters

Name Type Required Description
EngForestService___GetEngForests
EngForestServiceGetEngForests
 Y

Response

Name Type Required Description
EngForestService___GetEngForestsResponse
EngForestServiceGetEngForestsResponse
Property Type Required Description
Result TApiEFSetupItems Y
Result.TApiEFSetupItem[] TApiEFSetupItem[] N
Result.TApiEFSetupItem[].Handle Integer Y
Result.TApiEFSetupItem[].Name String Y
Result.TApiEFSetupItem[].Ndx Integer Y
Result.TApiEFSetupItem[].InputType TApifHitType Y
Result.TApiEFSetupItem[].RoughnessType TApiRouType Y
Result.TApiEFSetupItem[].RoughnessFromValue Double Y
Result.TApiEFSetupItem[].RoughnessToValue Double Y
Result.TApiEFSetupItem[].RoughnessHeightValue Double Y
Result.TApiEFSetupItem[].RoughnessLineObjectHandle Integer Y
Result.TApiEFSetupItem[].RoughnessAreaObjectHandle Integer Y
Result.TApiEFSetupItem[].HeightAreaObjectHandle Integer Y
Result.TApiEFSetupItem[].HeightLineObjectHandle Integer Y
Result.TApiEFSetupItem[].HeightGridObjectHandle Integer Y
Result.TApiEFSetupItem[].HeightGridObjectLayerId String Y
Result.TApiEFSetupItem[].ForestType TApiEFForestType Y
Result.TApiEFSetupItem[].TreeTopHeightFactor Double Y
Result.TApiEFSetupItem[].UpWindDistanceFactor Double Y
Result.TApiEFSetupItem[].DownWindDistanceFactor Double Y
Y

calculateDisplacementHeights

Parameters

Name Type Required Description
EngForestService___CalculateDisplacementHeights
EngForestServiceCalculateDisplacementHeights
Property Type Required Description
engForestHandle Integer Y
siteDataHandle Integer Y
gps TApiGPs Y
gps.TApiGP[] TApiGP[] N
gps.TApiGP[].Lat Double Y
gps.TApiGP[].Lng Double Y
sectors Integer Y
Y

Response

Name Type Required Description
EngForestService___CalculateDisplacementHeightsResponse
EngForestServiceCalculateDisplacementHeightsResponse
Property Type Required Description
Result TApiDoubleMatrix Y
Result.TApiDoubleArray[] TApiDoubleArray[] N
Result.TApiDoubleArray[].double[] Double[] N
Y