LineLoad#

Project line-load library entry. Create via createLineLoad(). Valid direction and classification strings come from getValidLoadDirections() and getValidLoadClassifications().

class rswall.LineLoad.LineLoad#

Bases: _ProxyObject

Represents a line load in an RSWall project.

Wraps a line load on the server. Use the granular getters and setters for individual properties (magnitude, direction, classification, depth, horizontal distance, backslope location, bearing width, and segment assignment).

property name: str#
getName()#

Fetch the current load name from the server.

Return type:

str

getDistribution()#

Load distribution type (Line, Uniform, or Point).

Return type:

str

getMagnitude()#

Line load magnitude in project native linear force units.

Return type:

float

getDirection()#

Load direction (for example Horizontal or Vertical).

Return type:

str

getClassification()#

Load classification ID (‘Live’, ‘Permanent’, ‘Earth’, ‘Unclassified’). UI labels like ‘Earth surcharge’ are accepted on set.

Return type:

str

getDepth()#

Load depth in project native length units.

Return type:

float

getHorizontalDistance()#

Horizontal distance from the wall reference in project native length units.

Return type:

float

isOnBackslope()#

True if the load backslope location is on the backslope side.

Return type:

bool

getBearingWidth()#

Bearing width in project native length units.

Return type:

float

getAssignedSegments()#

Wall/segment pairs this load is assigned to.

Returns a list of dicts with keys wallName and segmentName.

Return type:

List[Dict[str, str]]

setMagnitude(magnitude)#

Set the load magnitude.

Parameters:

magnitude (float) – Magnitude in project native linear force units. Must be non-negative (0 allowed).

Return type:

None

setDirection(direction)#

Set load direction (for example Horizontal).

Return type:

None

Parameters:

direction (str)

setClassification(classification)#

Set load classification (canonical ID or UI label like ‘Earth surcharge’).

Return type:

None

Parameters:

classification (str)

setDepth(depth)#

Set load depth in project native length units.

Return type:

None

Parameters:

depth (float)

setHorizontalDistance(horizontal_distance, on_backslope=None)#

Set horizontal distance from the wall reference (project native length units).

If on_backslope is omitted, the current backslope location is left unchanged by reading it first, then applying both fields in one request.

Return type:

None

Parameters:

  • horizontal_distance (float)

  • on_backslope (bool | None)

setOnBackslope(on_backslope)#

Set whether the load backslope location is on the backslope side.

Return type:

None

Parameters:

on_backslope (bool)

setBearingWidth(bearing_width)#

Set the bearing width.

Parameters:

bearing_width (float) – Width in project native length units. Must be non-negative (0 means no bearing spread).

Return type:

None

setName(name)#

Set the load name.

Return type:

None

Parameters:

name (str)

assignToSegment(wall_name, segment_name)#

Assign this load to a wall segment.

Return type:

None

Parameters:

  • wall_name (str)

  • segment_name (str)

unassignFromSegment(wall_name, segment_name)#

Remove this load from a wall segment.

Return type:

None

Parameters:

  • wall_name (str)

  • segment_name (str)