LineLoad.Create(Document, ElementId, Curve, XYZ, XYZ, LineLoadType)
Method
Description:
Creates a new custom line load within the project.
Creates a new custom line load within the project.
Remarks:
The curve must be bounded. The curve can be:
The curve must be bounded. The curve can be:
- Line
- Arc
- Ellipse
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | Document to which new line load will be added. |
hostElemId | ElementId | The analytical host element for the line Load. |
curve | Curve | Curve of the line load. |
forceVector1 | XYZ | The applied 3d force vector. |
momentVector1 | XYZ | The applied 3d moment vector. |
symbol | LineLoadType | The symbol of the LineLoad. Set <span class="keyword"><span data-languagespecifictext="cpp=nullptr|vb=Nothing|nu=null" id="LST709F2CB7_1"></span></span> to use default type. |
Return Value
Type | Description |
---|---|
LineLoad | If successful, returns the newly created LineLoad, otherwise. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The element hostElemId does not exist in the document -or- hostElemId is not permitted for this type of load. -or- The provided curve is not supported. -or- The input curve is not bound. |
ArgumentNullException | A non-optional argument was null |
ArgumentsInconsistentException | Thrown when all force and moment vectors are equal zero. |
InvalidOperationException | Thrown if type could not be set for newly created line load. |