Underground |
Inheritance HierarchyCurve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesGeoEntity
Autodesk.Civil.DatabaseServicesStormWaterControl
Autodesk.Civil.DatabaseServicesUndergroundStorage
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesGeoEntity
Autodesk.Civil.DatabaseServicesStormWaterControl
Autodesk.Civil.DatabaseServicesUndergroundStorage
Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDrainageDesignMgd (in AeccDrainageDesignMgd.dll) Version: 13.9.960.0
SyntaxThe UndergroundStorage type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
| BottomElevation |
Gets the bottom elevation the facility.
(Inherited from StormWaterControl) |
| BottomInfiltrationRate | Gets or sets the rate of infiltration through the bottom of the filter area. |
| BoundaryPoints | Gets or sets the boundary points of the underground storage. |
| Depth |
Gets the facility depth.
(Inherited from StormWaterControl) |
| Description |
Sets the stormwater control's description.
(Inherited from StormWaterControl) |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity) |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity) |
| EnableInfiltration |
Gets or sets whether infiltration is enabled for the stormwater control.
(Inherited from StormWaterControl) |
| FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity) |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity) |
| Freeboard | Gets or sets the freeboard that controls how close to the specified Exceedance Level the water must reach before the Status (on the Summary) shows Flood Risk. |
| InfiltrationType | Gets or sets the infiltration type for infiltration calculation. |
| InitialDepth | Gets or sets the initial wetted depth within the facility. |
| 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) |
| Location |
Gets or sets the location. Normally, it would be the top boundary centroid point (Mean Center).
(Inherited from StormWaterControl) |
| Name |
Sets the stormwater control's name.
(Inherited from StormWaterControl) |
| PerimeterType | Gets or sets the perimeter shape for the side infiltration calculation. |
| Porosity | Gets the percentage of the underground storage that is available for storage as a decimal value. |
| SafetyFactor |
Gets or sets the safety factor that reduces the infiltration rate during the analysis to account for silting up or poor maintenance.
(Inherited from StormWaterControl) |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity) |
| SideInfiltrationRate |
Gets or sets the rate of infiltration through the sides of the filter area.
(Inherited from StormWaterControl) |
| StyleId |
Sets the stormwater control's style Id.
(Inherited from StormWaterControl) |
| StyleName |
Sets the stormwater control's style name.
(Inherited from StormWaterControl) |
| TopElevation |
Gets the top elevation the facility.
(Inherited from StormWaterControl) |
| TravelTimeLength | Gets the length to calculate the travel time. Used only for the purpose of calculating Time of Travel. Normally, it is indicating the maximum path length through the stormwater control. |
| VelocityRoughness | Gets or sets the roughness for Manning or Colebrook-White equation to calculate velocity. |
| VelocityType | Gets or sets the velocity calculation type for analysis. |
Methods| Name | Description | |
|---|---|---|
 | ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity) |
| ConnectToPipe(ObjectId, ConnectorPositionType) |
Connects the stormwater control to a specified pipe at the given position.
(Inherited from StormWaterControl) |
| ConnectToPipe(ObjectId, ConnectorPositionType, Vector2d) |
Connects the stormwater control to a specified pipe at the given position following the provided direction.
(Inherited from StormWaterControl) |
 | Create | Creates a new underground storage from Point2d collection and returns its id. |
| Disconnect |
Disconnects from a pipe.
(Inherited from StormWaterControl) |
| GetInflowPipes |
Gets an ObjectIdCollection containing all inflow pipes that connect the stormwater control at their end points.
(Inherited from StormWaterControl) |
| GetInletDetails |
Gets a InletDetailCollection containing all inlet details for the stormwater control.
(Inherited from StormWaterControl) |
| GetOutfallDetail |
Gets a OutfallDetail containing the outfall detail for the stormwater control.
(Inherited from StormWaterControl) |
| GetOutflowPipes |
Gets an ObjectIdCollection containing all outflow pipes that connect the stormwater control at their start points.
(Inherited from StormWaterControl) |
| GetOutletDetails |
Gets a OutletDetailCollection containing all outlet details for the stormwater control.
(Inherited from StormWaterControl) |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |
| GetStageDesign | Gets a StageDesignCollection containing the design table data for the underground storage. |
| GetStageStorage |
Gets a StageStorageCollection containing cross-sectional area and volume at each depth for the stormwater control.
(Inherited from StormWaterControl) |
| SetOutletDetails |
Sets an OutletDetailCollection containing all outlet details to the object.
(Inherited from StormWaterControl) |
| SetStageDesign | Sets the stage design table for the underground storage. |
See Also