The Pipe 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 methodAdjustEndpoint
Adjusts the location where the pipe endpoint connects within the connected structure. You can adjust the the pipe to connect to the structure's center, inner wall or outer wall. You can also specify a positive offset.
Public methodApplyRules (Inherited from Part.)
Public methodComputeFingerPrint
Compute FingerPrint of the Entity.
(Inherited from Entity.)
Public methodConnectToPipe
Connect one pipe to another pipe. If needed, disconnect the original one and move the pipe to that pipe for connecting and add a structure.
Public methodConnectToStructure
Connect one pipe to another structure. If needed, disconnect the original one and move the pipe to that structure for connecting.
Public methodDisconnect
Disconnect pipe.
Public methodGetAvailablePipeLabelIds
Gets an ObjectIdCollection of available PipeLabels.
Public methodGetAvailableSpanningPipeLabelIds
Gets an ObjectIdCollection of SpanningPipeLabels.
Public methodGetClosestPointTo Obsolete.
Gets the closest point found to the given point on a pipe.
Public methodGetLabelIds Obsolete.
Gets an ObjectIdCollection of labels on the pipe.
Public methodGetOverriddenRuleIds
Gets the overridden Rule ids which this part contains.
(Inherited from Part.)
Public methodGetParamAtPoint
Gets the scale on the pipe for the given point.
Public methodGetPipeLabelIds
Gets an ObjectIdCollection of labels on the pipe.
Public methodGetPointAtParam
Gets a 3d point for the given parameter.
Public methodGetProfileViewsDisplayingMe
Gets the object id collection of all the profile views in which this part was drawn.
(Inherited from Part.)
Public methodGetProject2dPointVertically
Returns true if get the Project2dPoint successfully, otherwise false.
Public methodGetReferenceInfo
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 methodIsMaxCoverViolated
Returns true if the Maximum Cover is violated.
Public methodIsMinCoverViolated
Returns true if the Minimum Cover is violated.
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 methodResizeByInnerDiameterOrWidth
Resize the pipe by inner diameter or width.
Public methodSetSlopeHoldEnd
Sets the slope of the pipe away from the pipe’s end point.
Public methodSetSlopeHoldStart
Sets the slope of the pipe away from the pipe’s start point.
Public methodSwapPartFamilyAndSize
Swaps the part family and size.
(Inherited from Part.)

Properties

  NameDescription
Public propertyApplication
Gets the Application. Not currently implemented.
(Inherited from Entity.)
Public propertyBearing
Gets the horizontal bearing for straight pipes, and chord bearing for curved pipes.
Public propertyConnectedPartCount
Gets the number of parts that connects to the part
(Inherited from Part.)
Public propertyCoverOfEndpoint
Gets the end point's cover of pipe.
Public propertyCoverOfStartPoint
Gets the start point's cover of pipe.
Public propertyCrossSectionalShape
Gets the pipe’s cross sectional shape, such as circular, egg-shaped, elliptical, or rectangular.
Public propertyCurve2d
Gets the pipe curve geometry in plan.
Public propertyDescription
Gets or sets the Entity object's description.
(Inherited from Entity.)
Public propertyDisplayName
Gets the Entity object's display name.
(Inherited from Entity.)
Public propertyDocument
Gets the Document. Not currently implemented.
(Inherited from Entity.)
Public propertyDomain
Gets the part's domain.
(Inherited from Part.)
Public propertyEndOffset
Gets the offset of the ending point for the pipe object.
Public propertyEndPoint
Gets or sets the endpoint of the Pipe.
Public propertyEndStation
Gets the station of the ending point for the pipe object.
Public propertyEndStructureId
Gets the end structure id of the Pipe. If no connected structure, return ObjectId::Null.
Public propertyEnergyGradeLineDown
Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in a downstream direction and that contain hydraulic property data.
Public propertyEnergyGradeLineUp
Gets or sets the elevation of the energy grade line for pipe networks flowing in an upstream direction and that contain hydraulic property data.
Public propertyFingerPrint
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.)
Public propertyFlowDirection
Gets the current flow direction of the pipe, relative to the start and endpoint of the pipe.
Public propertyFlowDirectionMethod
Gets or sets the method that is used to determine the flow for this pipe.
Public propertyFlowRate
Gets or sets the pipe flow rate.
Public propertyFolderId
Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.)
Public propertyHoldOnResizeType
Gets or sets how Structure should hold when resized.
Public propertyHydraulicGradeLineDown
Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in a downstream direction and that contain hydraulic property data.
Public propertyHydraulicGradeLineUp
Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in an upstream direction and that contain hydraulic property data.
Public propertyInnerDiameterOrWidth
Gets the inner diameter or inner width of the pipe.
Public propertyInnerHeight
Gets the inner height of the pipe in drawing units.
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 propertyJunctionLoss
Gets or sets the pipe junction loss.
Public propertyLength2D
Gets the two-dimensional length of the pipe, measured from from pipe start to pipe end.
Public propertyLength2DCenterToCenter
Gets the two-dimensional length of the pipe, measured from the center of the connected starting structure to the center of the connected ending structure.
Public propertyLength2DToInsideEdge
Gets the two-dimensional length of the pipe, measured from the inside edge of the connected starting structure to the inside edge of the connected ending structure.
Public propertyLength3D
Gets the three-dimensional length of the pipe, measured from from pipe start to pipe end.
Public propertyLength3DCenterToCenter
Gets the three-dimensional length of the pipe, measured from the center of the connected starting structure to the center of the connected ending structure.
Public propertyLength3DToInsideEdge
Gets the three-dimensional length of the pipe,measured from the inside edge of the connected starting structure to the inside edge of the connected ending structure.
Public propertyMaterial
Gets the material defined for this part.
(Inherited from Part.)
Public propertyMaximumCover
Gets the maximum depth of cover along the entire length of pipe, from the top outside of the pipe to the reference surface.
Public propertyMinimumCover
Gets the minimum depth of cover along the entire length of pipe, from the top outside of the pipe to the reference surface.
Public propertyName
Gets part's name.
(Inherited from Part.)
Public propertyNetworkId
Gets the object id of the network to which this part belongs
(Inherited from Part.)
Public propertyNetworkName
Gets the name of the network to which this part belongs
(Inherited from Part.)
Public propertyOuterDiameterOrWidth
Gets the outer diameter or outer width of the pipe.
Public propertyOuterHeight
Gets the outer height of the pipe in drawing units.
Public propertyOverrideRuleSet
Gets or sets whether to use overridden rules.
(Inherited from Part.)
Public propertyParamsBool
Gets the boolean parameters collection.
(Inherited from Part.)
Public propertyParamsDouble
Gets the double parameters collection.
(Inherited from Part.)
Public propertyParamsLong
Gets the long parameters collection.
(Inherited from Part.)
Public propertyParamsString
Gets the string parameters collection.
(Inherited from Part.)
Public propertyPartData
Gets or sets the part data record.
(Inherited from Part.)
Public propertyPartDefId
Gets the object id of PartDef.
(Inherited from Part.)
Public propertyPartDescription
Gets the part’s description.
(Inherited from Part.)
Public propertyPartFamilyId
Gets the part family Id
(Inherited from Part.)
Public propertyPartFamilyName
Gets the part family name
(Inherited from Part.)
Public propertyPartSizeName
Gets the part size name.
(Inherited from Part.)
Public propertyPartSubType
Gets the part’s subtype.
(Inherited from Part.)
Public propertyPartType
Gets the type of the network park.
(Inherited from Part.)
Public propertyPosition
Gets or sets the position of the network part.
(Inherited from Part.)
Public propertyProfileViewPartId
Gets the object id of the part's counterpart in profile views.
(Inherited from Part.)
Public propertyRadius
Gets the radius of the pipe.
Public propertyRefAlignmentId
Gets or sets the object id of the alignment which this part references.
(Inherited from Part.)
Public propertyRefAlignmentName
Gets the name of the alignment which this part references
(Inherited from Part.)
Public propertyRefSurfaceId
Gets or sets the object id of the surface that this part references.
(Inherited from Part.)
Public propertyRefSurfaceName
Gets the name of the surface which this part references.
(Inherited from Part.)
Public propertyReturnPeriod
Gets or sets the pipe return period.
Public propertyRuleSetStyleId
Gets or sets the object id of RuleSetStyle.
(Inherited from Part.)
Public propertyRuleSetStyleName
Gets or sets RuleSetStyle by name.
(Inherited from Part.)
Public propertySectionViewPartId
Gets the object id of the part's counterpart in section views.
(Inherited from Part.)
Public propertyShowToolTip
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.)
Public propertySlope
Gets the pipe’s slope in absolute value.
Public propertySolid3dBody
Gets the 3d solid body of the part.
(Inherited from Part.)
Public propertyStartOffset
Gets the offset of the starting point for the pipe object.
Public propertyStartPoint
Gets or sets the start point of the Pipe.
Public propertyStartStation
Gets the station of the starting point for the pipe object.
Public propertyStartStructureId
Gets the start structure id of the Pipe. If no connected structure, return ObjectId::Null.
Public propertyStyleId
Sets the Pipe's style Id.
(Overrides Entity..::..StyleId.)
Public propertyStyleName
Gets or sets the Entity object's style name.
(Inherited from Entity.)
Public propertySubEntityType
Gets the type of the pipe.
Public propertySurfaceId Obsolete.
Gets or sets the object id of the surface that this part references.
(Inherited from Part.)
Public propertyWallThickness
Gets the wall thickness for this structure, measured from the inside edge of the structure to the outside edge of the structure.
(Inherited from Part.)

See Also