The Catchment type exposes the following members.

Methods

  NameDescription
Public methodComputeFingerPrint
Compute FingerPrint of the Entity.
(Inherited from Entity.)
Public methodStatic memberCreate
Creates a new catchment given a name, style id, reference surface id, polyline.
Public methodStatic memberCreateCopy
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.
Public methodGetAvailableCatchmentLabelIds
Gets the ObjectIdCollection of all CatchmentLabels for the Catchment.
Public methodGetAvailableFlowSegmentLabelIds
Gets the ObjectIdCollection of all FlowSegmentLabels for the Catchment.
Public methodGetFlowPath
Get the FlowPath of the Catchment.
Public methodGetReferenceInfo
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.)
Public methodSetFlowPath(Point3dCollection)
Sets the FlowPath of the Catchment from an array of points
Public methodSetFlowPath(FlowPath)
Sets the FlowPath of the Catchment from another flow path.

Properties

  NameDescription
Public propertyAntecedentWetness
Gets/Sets the Antecedent Wetness
Public propertyApplication
Gets the Application. Not currently implemented.
(Inherited from Entity.)
Public propertyArea2d
Gets the 2d Area of the boundary
Public propertyBoundaryPolyline2d
Gets the 2d boundary polyline
Public propertyBoundaryPolyline3d
Gets/Sets the 3d boundary polyline
Public propertyContainingGroupId
Gets the containing group Id of the catchment area
Public propertyCurveNumber
Gets/Sets the Curve Number
Public propertyDescription
Gets or sets the Entity object's description.
(Inherited from Entity.)
Public propertyDischargePoint
Gets the discharge point of the catchment area
Public propertyDisplayName
Gets the Entity object's display name.
(Inherited from Entity.)
Public propertyDocument
Gets the Document. Not currently implemented.
(Inherited from Entity.)
Public propertyExclusionary
Gets the exclusionary flag of the catchment area
Public propertyFingerPrint
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.)
Public propertyFolderId
Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.)
Public propertyHydrologicallyMostDistantLength
Gets the hydrologically most distant length of the catchment area
Public propertyHydrologicallyMostDistantPoint
Gets the hydrologically most distant point of the catchment area
Public propertyHydrologicalSoilGroup
Gets/Sets the Soil Group
Public propertyImperviousArea
Gets/Sets the Impervious Area
Public propertyIsReferencedSourceExisting
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.)
Public propertyIsReferenceObject
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.)
Public propertyIsReferenceStale
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.)
Public propertyIsReferenceSubObject
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.)
Public propertyIsReferenceValid
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.)
Public propertyIsUsed
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.)
Public propertyManningsCoefficient
Gets/Sets the mannings coefficient for the catchment area
Public propertyName
Gets or sets the Entity object's name.
(Inherited from Entity.)
Public propertyPerimeter2d
Gets the 2d Perimeter of the boundary polyline
Public propertyReferencePipeNetworkId
Gets the reference pipe network for the catchment area
Public propertyReferencePipeNetworkName
Gets the reference pipe network for the catchment area
Public propertyReferencePipeNetworkStructureId
Gets/Sets the reference pipe network structure id for the catchment area
Public propertyReferencePipeNetworkStructureName
Gets the reference pipe network structure name for the catchment area
Public propertyReferenceSurfaceId
Gets/Sets the reference surface for the catchment area
Public propertyReferenceSurfaceName
Gets the reference surface for the catchment area
Public propertyRunoffCoefficient
Gets/Sets the runoff coefficient for the catchment area
Public propertyShowToolTip
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.)
Public propertyStyleId
Gets / Sets the catchment style
(Overrides Entity..::..StyleId.)
Public propertyStyleName
Gets or sets the Entity object's style name.
(Inherited from Entity.)
Public propertyTimeOfConcentration
Gets the time of concentration for the catchment area
Public propertyTimeOfConcentrationCalculationMethod
Gets/Sets the time of concentration method for the catchment area
Public propertyUnconnectedImperviousArea
Gets/Sets the Unconnected Impervious Area Percent

See Also