CreateFloodContinuousWaterRise

Creates a set of polygons showing the land area covered by water when the water level is rising at a constant rate over a certain period of time (rate of rise and rise interval set by user).

 

JavaScript
CreateFloodContinuousWaterRise(       OriginX,       OriginY,       Radius,       WaterRiseRate,       SampleInterval,       TimeSampleIntervalHours,       StartTime,       EndTime,       GroupID,       Description)

 

C#
int CreateFloodContinuousWaterRise(       double OriginX,       double OriginY,       double Radius,       double WaterRiseRate,       double SampleInterval,       double TimeSampleIntervalHours,       object StartTime,       object EndTime,       int GroupID,       string Description)

 

C++
HRESULT CreateFloodContinuousWaterRise(       double OriginX,       double OriginY,       double Radius,       double WaterRiseRate,       double SampleInterval,       double TimeSampleIntervalHours,       VARIANT StartTime,       VARIANT EndTime,       LONG_PTR GroupID,       BSTR Description,       LONG_PTR * pTreeItemId)

Parameters

OriginX

The flood origin’s x-coordinate (longitude).

OriginY

The flood origin’s y-coordinate (latitude).

Radius

The radius of the area on which the flood analysis is being performed.

WaterRiseRate

The rate the water is rising (meters per hour).

SampleInterval

The distance between terrain sample points. The smaller the sample interval, the more accurate the calculation, but the longer it takes to calculate.

TimeSampleIntervalHours

The time between terrain samples within the time period between the StartTime and EndTime. A shorter sample size is more accurate but slower to calculate.

StartTime

The date and time the water begins to rise.

EndTime

The date and time the water stops rising.

GroupID                                                                                                                             

The Project Tree group in which the flood analysis object is created. If it is set to zero, the object is created under the root. You can obtain the GroupID by one of the following methods:

§   Create the group using IProjectTree6.CreateGroup.

§  Find the group, if you know the name, using IProjectTree6.FindItem.

§  Traverse the Tree using IProjectTree6 methods such as GetNextItem(), until you come to the desired GroupID.

Description

The name of the flood analysis object as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

pTreeItemId

The Project Tree ID of the flood polygon set.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP	The group ID entered does not represent a valid group in the project tree.
TE_E_INFOTREE_ITEMNOTGROUP	The item entered is not a group and therefore cannot be used as a group.
TE_E_INFOTREE_CANTUSEROOT	Can not use tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	ItemID is a group so an object cannot be retrieved.