PointLoad#

Project point-load library entry. Create via createPointLoad().

class rswall.PointLoad.PointLoad#

Bases: _ProxyObject

Represents a point load in an RSWall project.

Magnitude is in project native force units. Horizontal distance maps to Offset (project native length units). Bearing width and analysis width use project native length units.

property name: str#
getName()#

Fetch the current load name from the server.

Return type:

str

getDistribution()#

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

Return type:

str

getMagnitude()#

Point load magnitude in project native force units.

Return type:

float

getDirection()#

Load direction (for example Horizontal or Vertical).

Return type:

str

getClassification()#

Load classification ID; UI labels like ‘Earth surcharge’ 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 location is on the backslope side.

Return type:

bool

getBearingWidth()#

Bearing width along the section in project native length units.

Return type:

float

getAnalysisWidth()#

Analysis depth into the section in project native length units.

Return type:

float

getAssignedSegments()#

Wall/segment pairs this load is assigned to.

Return type:

List[Dict[str, str]]

setMagnitude(magnitude)#

Set point load magnitude in project native force units (non-negative; 0 allowed).

Return type:

None

Parameters:

magnitude (float)

setDirection(direction)#

Set load direction.

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).

Return type:

None

Parameters:

  • horizontal_distance (float)

  • on_backslope (bool | None)

setOnBackslope(on_backslope)#

Set whether the load location is on the backslope side.

Return type:

None

Parameters:

on_backslope (bool)

setBearingWidth(bearing_width)#

Set bearing width along the section in project native length units (non-negative; 0 = no spread).

Return type:

None

Parameters:

bearing_width (float)

setAnalysisWidth(analysis_width)#

Set analysis depth into the section in project native length units.

Return type:

None

Parameters:

analysis_width (float)

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)