Catchment Class |
Inheritance HierarchyNamespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.9.0.960
SyntaxThe Catchment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AntecedentWetness |
This property has been deprecated.
Obsolete |
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
| Area2d | Gets the 2d Area of the boundary. |
| AverageSlope |
This property has been deprecated use SWMMRunoffData.AverageSlope instead.
Obsolete |
| BoundaryPolyline2d | Gets the 2d boundary polyline. |
| BoundaryPolyline3d | Gets/Sets the 3d boundary polyline. |
| ChannelFlowSegments | Gets the count of Channel Flow Segments for TR-55 TOC method. |
| ChannelFlowTravelTime | Gets the Channel time(hours) of Sheet Flow Segments for TR-55 TOC method. |
| CompositeCurveNumber |
This property has been deprecated use SCSRunoffData.CompositeCurveNumber, SBUHRunoffData.CompositeCurveNumber, or SWMMRunoffData.CurveNumberData.CompositeCurveNumber instead.
Obsolete |
| Conductivity |
This property has been deprecated use SWMMRunoffData.GreenAmptData.Conductivity instead.
Obsolete |
| ContainingGroupId | Gets the containing group Id of the catchment area. |
| ContainingGroupName | Gets the containing catchment group name. |
| CurveNumber |
This property has been deprecated use CompositeCurveNumber instead.
Obsolete |
| CurveNumberDryingTime |
This property has been deprecated use SWMMRunoffData.CurveNumberData.DryingTime instead.
Obsolete |
| DecayConstant |
This property has been deprecated use SWMMRunoffData.HortonData.DecayConstant instead.
Obsolete |
| Description |
Gets or sets the Entity object's description.
(Inherited from Entity) |
| DischargePoint | Gets the discharge point of the catchment area. |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity) |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity) |
| DurationOfPeak |
This property has been deprecated use ModifiedRationalRunoffData.DurationOfPeak instead.
Obsolete |
| EquivalentWidth |
This property has been deprecated use SWMMRunoffData.EquivalentWidth instead.
Obsolete |
| Exclusionary | Gets the exclusionary flag of the catchment area. |
| FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity) |
| FlowPath | Gets the FlowPath of the Catchment. |
| FlowPathLength | Gets the flow path length of the catchment area. |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity) |
| HortonDryingTime |
This property has been deprecated use SWMMRunoffData.HortonData.DryingTime instead.
Obsolete |
| HydrologicallyMostDistantLength |
This property has been deprecated use FlowPathLength instead.
Obsolete |
| HydrologicallyMostDistantPoint | Gets the hydrologically most distant point of the catchment area. |
| HydrologicalSoilGroup |
This property has been deprecated.
Obsolete |
| ImperviousArea | Gets/Sets the Impervious Area as a decimal value. |
| ImperviousDeppressionStorageDepth |
This property has been deprecated use ImperviousDepressionStorageDepth instead.
Obsolete |
| ImperviousDepressionStorageDepth |
This property has been deprecated use SWMMRunoffData.ImperviousDepressionStorageDepth instead.
Obsolete |
| ImperviousManningsN |
This property has been deprecated use SWMMRunoffData.ImperviousManningsN instead.
Obsolete |
| ImperviousNoDepression |
This property has been deprecated use SWMMRunoffData.ImperviousNoDepression instead.
Obsolete |
| InfiltrationMethod |
This property has been deprecated use SWMMRunoffData.InfiltrationMethod instead.
Obsolete |
| InitialAbstractionDepth |
This property has been deprecated use SCSRunoffData.InitialAbstractionDepth instead.
Obsolete |
| InitialAbstractionFraction |
This property has been deprecated use SCSRunoffData.InitialAbstractionFraction instead.
Obsolete |
| InitialAbstractionType |
This property has been deprecated use SCSRunoffData.InitialAbstractionType instead.
Obsolete |
| InitialDeficit |
This property has been deprecated use SWMMRunoffData.GreenAmptData.InitialDeficit instead.
Obsolete |
| InternalRouting |
This property has been deprecated use SWMMRunoffData.InternalRouting instead.
Obsolete |
| IsCWSReferenceObject |
Gets whether the Entity is a Civil Worksharing reference object. A Civil Worksharing reference object is
a Civil object shared to Shared Space. It is not editable. But it can be updated to the new version in the Shared Space.
(Inherited from Entity) |
| IsCWSSourceObject |
Gets whether the Entity is a Civil Worksharing source object. A Civil Worksharing source object is
a Civil object shared to Shared Space. It is editable and can be updated to Shared Space.
(Inherited from Entity) |
| IsPartialReferenceObject |
Gets whether the surface is partial reference surface.
(Inherited from Entity) |
| IsReadOnlyReferenceObject |
Gets whether the Entity is a readonly reference object. A readonly reference object is
either a data shortcut referece object or a Civil Worksharing reference object.
(Inherited from Entity) |
 | IsReferencedSourceExisting |
For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing.
This indicates whether the reference object has source entity.
(Inherited from Entity) |
| IsReferenceObject |
Gets whether the Entity is a reference object. A reference object is
located in another drawing, and linked using a data shortcut or Vault.
If the entity is native to the current drawing this property returns false;
if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity) |
| IsReferenceStale |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity) |
| IsReferenceSubObject |
For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject.
For example, when iterating through the structure of a pipe network referenced from another drawing,
this property is true for each entity.
(Inherited from Entity) |
| IsReferenceValid |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity) |
| IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity) |
| ManningsCoefficient |
This property has been deprecated.
Obsolete |
| MaxInfiltrationRate |
This property has been deprecated use SWMMRunoffData.HortonData.MaxInfiltrationRate instead.
Obsolete |
| MaxInfiltrationVolume |
This property has been deprecated use SWMMRunoffData.HortonData.MaxInfiltrationVolume instead.
Obsolete |
| MinInfiltrationRate |
This property has been deprecated use SWMMRunoffData.HortonData.MinInfiltrationRate instead.
Obsolete |
| ModifiedRationalRunoffData | Gets the Modified Rational runoff method data from the catchment. Provides access to Modified Rational-specific parameters such as recession multiplier and duration of peak. |
| Name |
Gets or sets the Entity object's name.
(Inherited from Entity) |
| Perimeter2d | Gets the 2d Perimeter of the boundary polyline. |
| PerviousDeppressionStorageDepth |
This property has been deprecated use PerviousDepressionStorageDepth instead.
Obsolete |
| PerviousDepressionStorageDepth |
This property has been deprecated use SWMMRunoffData.PerviousDepressionStorageDepth instead.
Obsolete |
| PerviousManningsN |
This property has been deprecated use SWMMRunoffData.PerviousManningsN instead.
Obsolete |
| RationalRunoffData | Gets the Rational runoff method data from the catchment. Provides access to Rational-specific parameters such as recession multiplier. |
| RecessionMultiplier |
This property has been deprecated use RationalRunoffData.RecessionMultiplier or ModifiedRationalRunoffData.RecessionMultiplier instead.
Obsolete |
| ReferenceDischargeObjectId | Gets/Sets the reference discharge object id for the catchment area. |
| ReferenceDischargeObjectName | Gets the reference discharge object name for the catchment area. |
| ReferencePipeNetworkId | Gets the reference pipe network for the catchment area. |
| ReferencePipeNetworkName | Gets the reference pipe network for the catchment area. |
| ReferencePipeNetworkStructureId |
This property has been deprecated use ReferenceDischargeObjectId instead.
Obsolete |
| ReferencePipeNetworkStructureName |
This property has been deprecated use ReferenceDischargeObjectName instead.
Obsolete |
| ReferenceSurfaceId | Gets/Sets the reference surface for the catchment area. |
| ReferenceSurfaceName | Gets the reference surface for the catchment area. |
| RoutingPercentage |
This property has been deprecated use SWMMRunoffData.RoutingPercentage instead.
Obsolete |
| RunoffCoefficient | Gets/Sets the runoff coefficient for the catchment area. |
| RunoffMethod | Gets/Sets runoff method for the catchment area. |
| SBUHRunoffData | Gets the SBUH (Santa Barbara Urban Hydrograph) runoff method data from the catchment. Provides access to SBUH-specific parameters such as composite curve number. |
| SCSRunoffData | Gets the SCS (Soil Conservation Service) runoff method data from the catchment. Provides access to SCS-specific parameters such as hydrograph shape type, shape factor, initial abstraction, and composite curve number. |
| ShallowFlowSegments | Gets the count of Shallow Flow Segments for TR-55 TOC method. |
| ShallowFlowTravelTime | Gets the travel time(hours) of Shallow Flow Segments for TR-55 TOC method. |
| ShapeFactor |
This property has been deprecated use SCSRunoffData.ShapeFactor instead.
Obsolete |
| ShapeType |
This property has been deprecated use SCSRunoffData.ShapeType instead.
Obsolete |
| SheetFlowSegments | Gets the count of Sheet Flow Segments for TR-55 TOC method. |
| SheetFlowTravelTime | Gets the travel time(hours) of Sheet Flow Segments for TR-55 TOC method. |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity) |
| StyleId |
Gets / Sets the catchment style.
(Overrides EntityStyleId) |
| StyleName |
Gets or sets the Entity object's style name.
(Inherited from Entity) |
| SuctionHead |
This property has been deprecated use SWMMRunoffData.GreenAmptData.SuctionHead instead.
Obsolete |
| SWMMRunoffData | Gets the SWMM runoff method data from the catchment. Provides access to SWMM-specific parameters such as impervious area, average slope, equivalent width, infiltration method, and related data. |
| TimeOfConcentration | Gets/Sets the time of concentration for the catchment area. |
| TimeOfConcentrationCalculationMethod | Gets/Sets the time of concentration method for the catchment area. |
| TOCRunoffData | Gets the Time of Concentration (TOC) runoff method data from the catchment. |
| UnconnectedImperviousArea |
This property has been deprecated.
Obsolete |
Methods| Name | Description | |
|---|---|---|
 | ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity) |
 | Create | Creates a new catchment given a name, style id, reference surface id, polyline. |
| CreateCopy | Creates a copy of the catchment and assigns it to a new group. This is equivalent to a Copy Catchment To Group operation. To be consistent with the user interface, the user shall change the name of the new catchment (if desired) after the copy operation has been performed. |
| GetAvailableCatchmentLabelIds | Gets the ObjectIdCollection of all CatchmentLabels for the Catchment. |
| GetAvailableFlowSegmentLabelIds | Gets the ObjectIdCollection of all FlowSegmentLabels for the Catchment. |
| GetFlowPath |
Get the FlowPath of the Catchment.
Obsolete |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |
| SetFlowPath(FlowPath) |
Sets the FlowPath of the Catchment from another flow path.
Obsolete |
| SetFlowPath(Point3dCollection) |
Sets the FlowPath of the Catchment from an array of points.
Obsolete |
See Also