Document.NewFlexPipe(IList<XYZ>, FlexPipeType)
Method
Description:
Adds a new flexible pipe into the document, using a point array and pipe type.
Adds a new flexible pipe into the document, using a point array and pipe type.
Parameters
Parameter | Type | Description |
---|---|---|
points | IList | The point array indicating the path of the flexible pipe, including the end points. |
pipeType | FlexPipeType | The type of the flexible pipe. |
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 |
---|---|
ArgumentNullException | Thrown when the input argument points is. |
InvalidOperationException | Thrown when the flexible pipe cannot be created or regenerate fails. |
ArgumentException | Thrown if the flexible pipe type does not exist in the given document. |