ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMFloodSimulationLayer Class
Properties Methods Events


In This Topic
    CIMFloodSimulationLayer Class Members
    In This Topic

    The following tables list the members exposed by CIMFloodSimulationLayer.

    Public Constructors
    Public Properties
     NameDescription
    Public Property Gets or sets a value indicating whether layer can be draped on integrated mesh. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the area of interest. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the symbol for the area of interest. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the attribution text that appears on a map that draws this layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the blending mode for the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating the preset mode for the simulation layer.  
    Public Property Gets or sets identifier the layer's charts. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the color ramp for shading the water.  
    Public Property Gets or sets a value indicating whether water is contained in the area of interest or allowed to leave through the edges.  
    Public Property Gets or sets the current time (in decimal hours) as an offset from the start of the simulation at which to start playing. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets an array of URIs for the layers that will contribute to the DEM for flood simulation.  
    Public Property Gets or sets the description. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the display cache type. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the display value range.  
    Public Property Gets or sets the simulation duration in decimal hours. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the downscaling factor for loading raster elevation tiles. The cell size is multiplied by this value to change elevation level of detail. The minimum value of 1 uses the most accurate elevation with the slowest performance. Higher values increase the performance speed with less accurate elevation. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets a value indicating whether to enable any type of effects on the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the evaporation rate in millimeters per hour.  
    Public Property Gets or sets a value indicating whether this layer is expanded in the contents pane. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the URI of the simulation data storage that include water sources, barriers and culverts.  
    Public Property Gets or sets the infiltration max raster.  
    Public Property Gets or sets the infiltration rate raster.  
    Public Property Gets or sets the initial water depth raster.  
    Public Property Gets or sets a value indicating whether this is the currently active simulation. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the 3D layer properties. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer effects for the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer elevation. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the URIs of the layers used as masks. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer's scale visibility options. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer template. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the map layer type. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the manually set cell resolution in map units. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the maximum number of cells allowed on any edge of the area of interest. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the maximum display cache age. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the maximum scale for layer draw (set as the denominator of the scale's representative fraction). (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the metadata URI. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the minimum scale for layer draw (set as the denominator of the scale's representative fraction). (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the name. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a value indicating whether weather effects are controlled by the simulation while playing.  
    Public Property Gets or sets the speed to play as a multiplier of the base speed. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the simulation playback time step in decimal hours. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the pop-up info. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the rainfall rate display units.  
    Public Property Gets or sets an array of rainfall rates (in millimeters per hour) over durations (in seconds).  
    Public Property Gets or sets the time (in seconds) to transition between rainfall rates.  
    Public Property Gets or sets a value indicating whether layer should be rasterized when exporting. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the amount of time to wait between refreshing the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the units for the amount of time to wait between refreshing the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the amount of simulated time between cache slices in seconds. Only used when UseDefaultNumberOfCacheSlices is false. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets identifier that will be used to identify the layer in server. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not to show legends. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not to show pop-ups. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the time the source was last modified, as of the last sync. Used to detect when another sync is needed. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the source portal URI of the item. Set if sourced from an external item such as an item on a portal. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the source URI of the item. Set if sourced from an external item such as an item on a portal. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the simulation start time. The end time will be the start time plus the duration. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets the roughness value raster.  
    Public Property Gets or sets the transparency of the layer as a percentage. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the URI of the definition. Typically set by the system and used as an identifier. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a value indicating whether to automatically determine the cell resolution. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets a value indicating whether to use the default number of stored cache slices. (Inherited from ArcGIS.Core.CIM.CIMSimulationLayer)
    Public Property Gets or sets a value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the value range type for playing the simulation.  
    Public Property Gets or sets a value indicating whether or not this layer is visible. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the fixed time extent for layer visibility. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the color class breaks for shading the water.  
    Public Property Gets or sets the water display type.  
    Public Property Gets or sets an identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMFloodSimulationLayer.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMFloodSimulationLayer with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMFloodSimulationLayer and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also