UniformLoad#

Project uniform-load library entry. Create via createUniformLoad().

class rswall.UniformLoad.UniformLoad#

Bases: _ProxyObject

Represents a uniformly distributed load in an RSWall project.

Magnitude is in project native stress units. Horizontal distance maps to OffsetToBeginning (project native length units).

property name: str#
getName()#

Fetch the current load name from the server.

Return type:

str

getDistribution()#

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

Return type:

str

getMagnitude()#

Uniform load magnitude in project native stress units.

Return type:

float

getHorizontalDistance()#

Horizontal offset to beginning of the distributed load (project length 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

getAssignedSegments()#

Wall/segment pairs this load is assigned to.

Return type:

List[Dict[str, str]]

setMagnitude(magnitude)#

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

Return type:

None

Parameters:

magnitude (float)

setHorizontalDistance(horizontal_distance)#

Set horizontal offset to beginning of the distributed load (project length units).

Return type:

None

Parameters:

horizontal_distance (float)

setDirection(direction)#

Set load direction.

Not available for uniformly distributed loads (matches the Manage Loads dialog, which hides Direction for uniform loads).

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)

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)