CantileverWallProfile#

Cantilever wall section profile in the project property library. Dimension keys are listed in CANTILEVER_DIMENSION_NAMES.

Proxy object representing a cantilever wall section profile in RSWall.

rswall.CantileverWallProfile.CANTILEVER_DIMENSION_NAMES = ('b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'h1', 'h2', 'h3')#

Valid dimension keys for cantilever section profiles (includes b6).

class rswall.CantileverWallProfile.CantileverWallProfile#

Bases: _ProxyObject

Cantilever wall section profile in the project property library.

Dimensions use names from CANTILEVER_DIMENSION_NAMES.

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 project native units.

Return type:

float

setUnitWeight(unitWeight)#

Set unit weight in project native units (allows 0; rejects negatives).

Return type:

None

Parameters:

unitWeight (float)

getElevationAtToe()#

Elevation at toe in project native length units.

Return type:

float

setElevationAtToe(elevationAtToe)#

Set elevation at toe in project native length units.

Return type:

None

Parameters:

elevationAtToe (float)

getDimension(dimensionName)#

Get a single cross-section dimension in project native length units.

Return type:

float

Parameters:

dimensionName (str)

setDimension(dimensionName, value)#

Set a single cross-section dimension in project native length units.

Return type:

None

Parameters:
getDimensions()#

Return all b/h dimension values 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)