PipeCreate(Document, ElementId, ElementId, Connector, Connector) Method |
Creates a new pipe that connects to two connectors.
Namespace: Autodesk.Revit.DB.PlumbingAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic static Pipe Create(
Document document,
ElementId pipeTypeId,
ElementId levelId,
Connector startConnector,
Connector endConnector
)
Public Shared Function Create (
document As Document,
pipeTypeId As ElementId,
levelId As ElementId,
startConnector As Connector,
endConnector As Connector
) As Pipe
public:
static Pipe^ Create(
Document^ document,
ElementId^ pipeTypeId,
ElementId^ levelId,
Connector^ startConnector,
Connector^ endConnector
)
static member Create :
document : Document *
pipeTypeId : ElementId *
levelId : ElementId *
startConnector : Connector *
endConnector : Connector -> Pipe
Parameters
- document Document
-
The document.
- pipeTypeId ElementId
-
The ElementId of the new pipe type.
- levelId ElementId
-
The level ElementId for the new pipe.
- startConnector Connector
-
The first connector where the new pipe starts.
- endConnector Connector
-
The second point of the new pipe.
Return Value
Pipe
The pipe.
ExceptionsException | Condition |
---|
ArgumentException |
The pipe type pipeTypeId is not valid pipe type.
-or-
The ElementId levelId is not a Level.
-or-
The connector domain is not Domain.Piping.
-or-
The points of startConnector and endConnector are too close: for MEPCurve, the minimum length is 1/10 inch.
|
ArgumentNullException |
A non-optional argument was null
|
InvalidOperationException |
Thrown when the new pipe fails to connect with the connector.
|
Remarks
The new pipe will have the same diameter and system type as the start connector. The creation will also connect the new pipe
to two component who owns the specified connectors. If necessary, additional fitting(s) are included to make a valid connection.
If the new pipe can not be connected to the next component (e.g., mismatched direction, no valid fitting, and etc), the new pipe
will still be created at the specified connector position, and an InvalidOperationException is thrown.
See Also