FlexPipe.Create(Document, ElementId, ElementId, ElementId, IList<XYZ>)
Method
Description:
Creates a new flexible pipe into the document, using a point array and flex pipe type.
Creates a new flexible pipe into the document, using a point array and flex pipe type.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document. |
systemTypeId | ElementId | The id of the piping system type. |
pipeTypeId | ElementId | The id of the flexible pipe. |
levelId | ElementId | The level id for the flexible pipe. |
points | IList | The point array indicating the path of the flexible pipe, including the end point. |
Return Value
Type | Description |
---|---|
FlexPipe | If creation was successful then a new flexible pipe is returned, otherwise an exception with failure information will be thrown. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The systemTypeId is not valid piping system type. -or- The type pipeTypeId is not valid flexible pipe type. -or- The ElementId levelId is not a Level. -or- The valid number of points is less than two. In order to create a flex curve, at least two points are required. Note the duplicate points don't take into account. |
ArgumentNullException | A non-optional argument was null |