Catchment Class |
Inheritance HierarchySystemObject
SystemMarshalByRefObject
DisposableWrapper
RXObject
Drawable
DBObject
Entity
Curve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesCatchment
SystemMarshalByRefObject
DisposableWrapper
RXObject
Drawable
DBObject
Entity
Curve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesCatchment
Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.7.0.1190
SyntaxThe Catchment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AntecedentWetness | Gets/Sets the Antecedent Wetness |
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
| Area2d | Gets the 2d Area of the boundary |
| 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 | Gets the compiste curve number of the catchment area |
| ContainingGroupId | Gets the containing group Id of the catchment area |
| CurveNumber | Gets/Sets the Curve Number |
| 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) |
| 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. |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity) |
| HydrologicallyMostDistantLength | Gets the hydrologically most distant length of the catchment area |
| HydrologicallyMostDistantPoint | Gets the hydrologically most distant point of the catchment area |
| HydrologicalSoilGroup | Gets/Sets the Soil Group |
| ImperviousArea | Gets/Sets the Impervious Area |
| InitialAbstractionDepth | Gets and Sets the initial abstraction depth value for the catchment area |
| InitialAbstractionFraction | Gets and Sets the initial abstraction fraction value for the catchment area |
| InitialAbstractionType | Gets and Sets the initial abstraction type for the catchment area |
| 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) |
| 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 | Gets/Sets the mannings coefficient for the catchment area |
| Name |
Gets or sets the Entity object's name.
(Inherited from Entity) |
| Perimeter2d | Gets the 2d Perimeter of the boundary polyline |
| ReferencePipeNetworkId | Gets the reference pipe network for the catchment area |
| ReferencePipeNetworkName | Gets the reference pipe network for the catchment area |
| ReferencePipeNetworkStructureId | Gets/Sets the reference pipe network structure id for the catchment area |
| ReferencePipeNetworkStructureName | Gets the reference pipe network structure name for the catchment area |
| ReferenceSurfaceId | Gets/Sets the reference surface for the catchment area |
| ReferenceSurfaceName | Gets the reference surface for the catchment area |
| RunoffCoefficient | Gets/Sets the runoff coefficient for the catchment area |
| RunoffMethod | Gets runoff method for the catchment area |
| 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 | Gets and Sets the shape factor value for the catchment area |
| ShapeType | Gets and Sets the shape type for the catchment area |
| 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) |
| TimeOfConcentration | Gets the time of concentration for the catchment area |
| TimeOfConcentrationCalculationMethod | Gets/Sets the time of concentration method for the catchment area |
| UnconnectedImperviousArea | Gets/Sets the Unconnected Impervious Area Percent |
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 | Obsolete. Get the FlowPath of the Catchment. |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |
| SetFlowPath(FlowPath) | Obsolete. Sets the FlowPath of the Catchment from another flow path. |
| SetFlowPath(Point3dCollection) | Obsolete. Sets the FlowPath of the Catchment from an array of points |
See Also