Creates a new pipe that connects to two connectors.
Namespace: Autodesk.Revit.DB.PlumbingAssembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since: 2015
Syntax
C# |
---|
public static Pipe Create( Document document, ElementId pipeTypeId, ElementId levelId, Connector startConnector, Connector endConnector ) |
Visual Basic |
---|
Public Shared Function Create ( _ document As Document, _ pipeTypeId As ElementId, _ levelId As ElementId, _ startConnector As Connector, _ endConnector As Connector _ ) As Pipe |
Visual C++ |
---|
public: static Pipe^ Create( Document^ document, ElementId^ pipeTypeId, ElementId^ levelId, Connector^ startConnector, Connector^ endConnector ) |
Parameters
- document
- Type: Autodesk.Revit.DB..::..Document
The document.
- pipeTypeId
- Type: Autodesk.Revit.DB..::..ElementId
The ElementId of the new pipe type.
- levelId
- Type: Autodesk.Revit.DB..::..ElementId
The level ElementId for the new pipe.
- startConnector
- Type: Autodesk.Revit.DB..::..Connector
The first connector where the new pipe starts.
- endConnector
- Type: Autodesk.Revit.DB..::..Connector
The second point of the new pipe.
Return Value
The pipe.
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.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..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. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |
Autodesk.Revit.Exceptions..::..DisabledDisciplineException | None of the following disciplines is enabled: Mechanical Electrical Piping. |
Autodesk.Revit.Exceptions..::..InvalidOperationException | Thrown when the new pipe fails to connect with the connector. |