Pipe.Create(Document, ElementId, ElementId, Connector, Connector)
Method
Description:
Creates a new pipe that connects to two connectors.
Creates a new pipe that connects to two connectors.
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.
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.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
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
Type | Description |
---|---|
Pipe | The pipe. |
Exceptions
Exception | 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. |