Share

Structure Methods

The Structure type exposes the following members.

Methods

 NameDescription
Public methodAddToProfileView Draws the part into the specified profile view.
(Inherited from Part)
Public methodAddToSectionView Draws the part into the specified section view.
(Inherited from Part)
Public methodApplyRules
(Inherited from Part)
Public methodComputeFingerPrint Compute FingerPrint of the Entity.
(Inherited from Entity)
Public methodConnectToPipe Connect this structure to the specified pipe.
Public methodDisconnect Disconnect from a pipe.
Public methodGetAvailableStructureLabelIds Gets an ObjectIdCollection of StructureLabels on the Structure.
Public methodGetConnectedCatchmentIds Gets the objectId collection of all connected catchments.
Public methodGetConnectedPipeNames Gets all the connected pipe names.
Public methodGetConnectedPressurePipeIds Gets the object id collection of all connected pressure pipes.
Public methodGetLabelIdsObsolete.
Gets an ObjectIdCollection of labels on the Structure.
Public methodGetOverriddenRuleIds Gets the overridden Rule ids which this part contains.
(Inherited from Part)
Public methodGetProfileViewsDisplayingMe Gets the object id collection of all the profile views in which this part was drawn.
(Inherited from Part)
Public methodCode exampleGetReferenceInfo For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity)
Public methodGetSectionViewsDisplayingMe Gets the object id collection of all the section views in which this part was drawn.
(Inherited from Part)
Public methodIsConnectedPipeFlowingIn Determines if the connected pipe is flowing into the structure
Public methodIsConnectedPipeFlowingOut Determines if the connected pipe is flowing out of the structure
Public methodIsPointInsideStructureRegion Returns true if the point is within the structure region.
Public methodRemoveFromAllProfileViews Remove the part from all the profile views in which it is drawn.
(Inherited from Part)
Public methodRemoveFromAllSectionViews Removes the part from all the section views in which it is drawn.
(Inherited from Part)
Public methodRemoveFromProfileView Remove the part from the specified profile view in which it is drawn.
(Inherited from Part)
Public methodRemoveFromSectionView Removes the part from the specified section view in which it is drawn.
(Inherited from Part)
Public methodResizeByPipeDepths Resize the structure by pipe depths.
Public methodResizeJunctionStructure Resize the Junction structure by rim and sump elevations.
Public methodSwapPartFamilyAndSize Swaps the part family and size.
(Inherited from Part)

See Also

Reference

Was this information helpful?