Pipe Class

A pipe network part serving to move fluids from one point to another.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    DisposableWrapper
      RXObject
        Drawable
          DBObject
            Entity
              Curve
                Entity
                  Autodesk.Civil.DatabaseServicesEntity
                    Autodesk.Civil.DatabaseServicesGeoEntity
                      Autodesk.Civil.DatabaseServicesPart
                        Autodesk.Civil.DatabaseServicesPipe

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292

Syntax

C++

Copy

public sealed class Pipe : Part

Public NotInheritable Class Pipe
	Inherits Part

public ref class Pipe sealed : public Part

The Pipe type exposes the following members.

Properties

	Name	Description
	Application	Gets the Application. Not currently implemented. (Inherited from Entity)
	AverageLoss	Gets or sets the pipe average loss. Thrown when newValue is less than 0.0.
	Bearing	Gets the horizontal bearing for straight pipes, and chord bearing for curved pipes.
	ConnectedPartCount	Gets the number of parts that connects to the part (Inherited from Part)
	CoverOfEndpoint	Gets the end point's cover of pipe.
	CoverOfStartPoint	Gets the start point's cover of pipe.
	CrossSectionalShape	Gets the pipe’s cross sectional shape, such as circular, egg-shaped, elliptical, or rectangular.
	Curve2d	Gets the pipe curve geometry in plan.
	CurveGeometry	Gets or sets the pipe curve geometry.
	Description	Gets or sets the Entity object's description. (Inherited from Entity)
	DisplayName	Gets the Entity object's display name. (Inherited from Entity)
	Document	Gets the Document. Not currently implemented. (Inherited from Entity)
	Domain	Gets the part's domain. (Inherited from Part)
	EndOffset	Gets the offset of the ending point for the pipe object.
	EndPoint	Gets or sets the endpoint of the Pipe.
	EndStation	Gets the station of the ending point for the pipe object.
	EndStructureId	Gets the end structure id of the Pipe. If no connected structure, return ObjectId::Null.
	EnergyGradeLineDown	Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in a downstream direction and that contain hydraulic property data.
	EnergyGradeLineUp	Gets or sets the elevation of the energy grade line for pipe networks flowing in an upstream direction and that contain hydraulic property data.
	EntryLoss	Gets or sets the pipe entry loss. Thrown when newValue is less than 0.0.
	ExitLoss	Gets or sets the pipe exit loss. Thrown when newValue is less than 0.0.
	FingerPrint	Gets or sets FingerPrint of the Entity. (Inherited from Entity)
	FlowDirection	Gets the current flow direction of the pipe, relative to the start and endpoint of the pipe.
	FlowDirectionMethod	Gets or sets the method that is used to determine the flow for this pipe.
	FlowRate	Gets or sets the pipe flow rate.
	FolderId	Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder (Inherited from Entity)
	HasManningCoefficient	Gets a boolean value that pipe has manning coefficient or not
	HoldOnResizeType	Gets or sets how Structure should hold when resized.
	HydraulicGradeLineDown	Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in a downstream direction and that contain hydraulic property data.
	HydraulicGradeLineUp	Gets or sets the elevation of the hydraulic grade line for pipe networks flowing in an upstream direction and that contain hydraulic property data.
	InnerDiameterOrWidth	Gets the inner diameter or inner width of the pipe.
	InnerHeight	Gets the inner height of the pipe in drawing units.
	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)
	JunctionLoss	Gets or sets the pipe junction loss.
	KnownFlow	Gets or sets the the known flow to a network part. This value is used by the Analyze Gravity Network command in addition to any flow resulting from a catchment. (Inherited from Part)
	Length2D	Gets the two-dimensional length of the pipe, measured from from pipe start to pipe end.
	Length2DCenterToCenter	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.
	Length2DToInsideEdge	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.
	Length3D	Gets the three-dimensional length of the pipe, measured from from pipe start to pipe end.
	Length3DCenterToCenter	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.
	Length3DToInsideEdge	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.
	ManningCoefficient	Gets the manning coefficient
	Material	Gets the material defined for this part. (Inherited from Part)
	MaximumCover	Gets the maximum depth of cover along the entire length of pipe, from the top outside of the pipe to the reference surface.
	MinimumCover	Gets the minimum depth of cover along the entire length of pipe, from the top outside of the pipe to the reference surface.
	Name	Gets part's name. (Inherited from Part)
	NetworkId	Gets the object id of the network to which this part belongs (Inherited from Part)
	NetworkName	Gets the name of the network to which this part belongs (Inherited from Part)
	OuterDiameterOrWidth	Gets the outer diameter or outer width of the pipe.
	OuterHeight	Gets the outer height of the pipe in drawing units.
	OverrideRuleSet	Gets or sets whether to use overridden rules. (Inherited from Part)
	ParamsBool	Gets the boolean parameters collection. (Inherited from Part)
	ParamsDouble	Gets the double parameters collection. (Inherited from Part)
	ParamsLong	Gets the long parameters collection. (Inherited from Part)
	ParamsString	Gets the string parameters collection. (Inherited from Part)
	PartData	Gets or sets the part data record. (Inherited from Part)
	PartDefId	Gets the object id of PartDef. (Inherited from Part)
	PartDescription	Gets the part’s description in content catalog. (Inherited from Part)
	PartFamilyId	Gets the part family Id (Inherited from Part)
	PartFamilyName	Gets the part family name (Inherited from Part)
	PartSizeName	Gets the part size name. (Inherited from Part)
	PartSubType	Gets the part’s subtype. (Inherited from Part)
	PartType	Gets the type of the network park. (Inherited from Part)
	Position	Gets or sets the position of the network part. (Inherited from Part)
	ProfileViewPartId	Gets the object id of the part's counterpart in profile views. (Inherited from Part)
	Radius	Gets the radius of the pipe.
	RefAlignmentId	Gets or sets the object id of the alignment which this part references. (Inherited from Part)
	RefAlignmentName	Gets the name of the alignment which this part references (Inherited from Part)
	RefSurfaceId	Gets or sets the object id of the surface that this part references. (Inherited from Part)
	RefSurfaceName	Gets the name of the surface which this part references. (Inherited from Part)
	ReturnPeriod	Gets or sets the pipe return period.
	RuleSetStyleId	Gets or sets the object id of RuleSetStyle. (Inherited from Part)
	RuleSetStyleName	Gets or sets RuleSetStyle by name. (Inherited from Part)
	SectionViewPartId	Gets the object id of the part's counterpart in section views. (Inherited from Part)
	ShowToolTip	Gets or sets whether to show tooltips for the Entity. (Inherited from Entity)
	Slope	Gets the pipe’s slope in absolute value.
	Solid3dBody	Gets the 3d solid body of the part. (Inherited from Part)
	StartOffset	Gets the offset of the starting point for the pipe object.
	StartPoint	Gets or sets the start point of the Pipe.
	StartStation	Gets the station of the starting point for the pipe object.
	StartStructureId	Gets the start structure id of the Pipe. If no connected structure, return ObjectId::Null.
	StyleId	Sets the Pipe's style Id. (Overrides EntityStyleId)
	StyleName	Gets or sets the Entity object's style name. (Inherited from Entity)
	SubEntityType	Gets the type of the pipe.
	SurfaceId	Obsolete. Gets or sets the object id of the surface that this part references. (Inherited from Part)
	WallThickness	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)

Top

Methods

	Name	Description
	AddToProfileView	Draws the part into the specified profile view. (Inherited from Part)
	AddToSectionView	Draws the part into the specified section view. (Inherited from Part)
	AdjustEndpoint	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.
	ApplyRules	(Inherited from Part)
	ComputeFingerPrint	Compute FingerPrint of the Entity. (Inherited from Entity)
	ConnectToPipe	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.
	ConnectToStructure	Connect one pipe to another structure. If needed, disconnect the original one and move the pipe to that structure for connecting.
	Disconnect	Disconnect pipe.
	GetAvailablePipeLabelIds	Gets an ObjectIdCollection of available PipeLabels.
	GetAvailableSpanningPipeLabelIds	Gets an ObjectIdCollection of SpanningPipeLabels.
	GetClosestPointTo	Obsolete. Gets the closest point found to the given point on a pipe.
	GetLabelIds	Obsolete. Gets an ObjectIdCollection of labels on the pipe.
	GetOverriddenRuleIds	Gets the overridden Rule ids which this part contains. (Inherited from Part)
	GetParamAtPoint	Gets the scale on the pipe for the given point.
	GetPipeLabelIds	Gets an ObjectIdCollection of labels on the pipe.
	GetPointAtParam	Gets a 3d point for the given parameter.
	GetProfileViewsDisplayingMe	Gets the object id collection of all the profile views in which this part was drawn. (Inherited from Part)
	GetProject2dPointVertically	Returns true if get the Project2dPoint successfully, otherwise false.
	GetReferenceInfo	For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information. (Inherited from Entity)
	GetSectionViewsDisplayingMe	Gets the object id collection of all the section views in which this part was drawn. (Inherited from Part)
	IsMaxCoverViolated	Returns true if the Maximum Cover is violated.
	IsMinCoverViolated	Returns true if the Minimum Cover is violated.
	RemoveFromAllProfileViews	Remove the part from all the profile views in which it is drawn. (Inherited from Part)
	RemoveFromAllSectionViews	Removes the part from all the section views in which it is drawn. (Inherited from Part)
	RemoveFromProfileView	Remove the part from the specified profile view in which it is drawn. (Inherited from Part)
	RemoveFromSectionView	Removes the part from the specified section view in which it is drawn. (Inherited from Part)
	ResizeByInnerDiameterOrWidth	Resize the pipe by inner diameter or width.
	SetSlopeHoldEnd	Sets the slope of the pipe away from the pipe’s end point.
	SetSlopeHoldStart	Sets the slope of the pipe away from the pipe’s start point.
	SwapPartFamilyAndSize	Swaps the part family and size. (Inherited from Part)

Top

Remarks

Pipe objects represent the conduits of the pipe network. Pipes are created using the Network object's AddLinePipe() and AddCurvePipe() methods. Both methods require you to specify a particular part family and a particular part size filter object (both identified by ObjectId) as well as the geometry information (line or curve) of the pipe. The order of the start and end points of the geometry may have meaning in describing flow direction. To make a new pipe a meaningful part of a pipe Network, it must be connected to structures or other pipes using the ConnectToStructure() or ConnectToPipe() methods.

Reference

Autodesk.Civil.DatabaseServices Namespace