GravityWallProfile#

Gravity wall section profile in the project property library. Dimension keys are listed in GRAVITY_DIMENSION_NAMES.

Proxy object representing a gravity wall section profile in RSWall.

rswall.GravityWallProfile.GRAVITY_DIMENSION_NAMES = ('b1', 'b2', 'b3', 'b4', 'b5', 'h1', 'h2', 'h3')#

Valid dimension keys for GravityWallProfile.getDimension() / GravityWallProfile.setDimension().

class rswall.GravityWallProfile.GravityWallProfile#

Bases: _ProxyObject

Gravity wall section profile in the project property library.

Dimensions use names from GRAVITY_DIMENSION_NAMES. Lengths and unit weight are in project-native units.

property name: str#

Get the cached profile name.

getProfileDetails()#

Read the full profile state in one call.

Returns:

name, colour, unitWeight, elevationAtToe, dimensions

Return type:

Dict with keys

getColour()#

Return profile colour as (red, green, blue, alpha) 0-255.

Return type:

Tuple[int, int, int, int]

setColour(red, green, blue, alpha=255)#

Set profile colour using RGBA components (0-255).

Return type:

None

Parameters:
getColor()#

Alias for getColour().

Return type:

Tuple[int, int, int, int]

setColor(red, green, blue, alpha=255)#

Alias for setColour().

Return type:

None

Parameters:
getUnitWeight()#

Unit weight in the project’s unit-weight system (as used by RSWall).

Return type:

float

setUnitWeight(unitWeight)#

Set unit weight in the project’s unit-weight system (as used by RSWall).

Matches the dialog: 0 is allowed; negatives are rejected. Further validation is enforced by RSWall and returned as RPC errors.

Return type:

None

Parameters:

unitWeight (float)

getElevationAtToe()#

Elevation at toe in the project’s length units (as used by RSWall).

Return type:

float

setElevationAtToe(elevationAtToe)#

Set elevation at toe in the project’s length units (as used by RSWall).

Return type:

None

Parameters:

elevationAtToe (float)

getDimension(dimensionName)#

Get a cross-section dimension in the project’s length units.

Pass/receive the numeric value in the same unit system as the open RSWall project (do not convert locally). Range checks are enforced by RSWall; RPC errors are re-raised to the caller.

Return type:

float

Parameters:

dimensionName (str)

setDimension(dimensionName, value)#

Set a cross-section dimension in the project’s length units.

Expect the numeric value in the open project’s length unit system (same convention as RSWall). Dialog/RPC range validation lives in RSWall; failures surface here as grpc.RpcError.

Return type:

None

Parameters:
getDimensions()#

Return all b/h dimensions as a name-to-value dict (project length units).

Return type:

Dict[str, float]

setName(name)#

Set the profile display name.

Return type:

None

Parameters:

name (str)