GabionWallUnit#

Gabion wall unit library entry. Shear model options are module-level string constants (not Python enums).

Proxy object representing a gabion wall unit in RSWall.

rswall.GabionWallUnit.SHEAR_TYPE_CONSTANT = 'CONSTANT'#

constant.

Type:

Interlayer shear model string

rswall.GabionWallUnit.SHEAR_TYPE_LINEAR = 'LINEAR'#

linear.

Type:

Interlayer shear model string

rswall.GabionWallUnit.SHEAR_TYPE_BILINEAR = 'BILINEAR'#

bilinear.

Type:

Interlayer shear model string

class rswall.GabionWallUnit.GabionWallUnit#

Bases: _ProxyObject

Gabion wall unit library entry.

Shear model options are module-level string constants such as SHEAR_TYPE_CONSTANT.

property name: str#

Get the cached unit name.

getUnitDetails()#

Read the full wall unit state in one call.

Return type:

Dict[str, Any]

Returns:

Dict with geometry, weight, and interlayer shear fields.

getColour()#

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

Return type:

Tuple[int, int, int, int]

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

Set unit 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:
getHeight()#

Height in project native length units.

Return type:

float

setHeight(height)#

Set height in project native length units (must be > 0).

Return type:

None

Parameters:

height (float)

getWidth()#

Width in project native length units.

Return type:

float

setWidth(width)#

Set width in project native length units (must be > 0).

Return type:

None

Parameters:

width (float)

getDepth()#

Depth in project native length units.

Return type:

float

setDepth(depth)#

Set depth in project native length units (must be > 0).

Return type:

None

Parameters:

depth (float)

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)

getInterlayerShearStrengthType()#

Return CONSTANT, LINEAR, or BILINEAR.

Return type:

str

setInterlayerShearStrengthType(shearType)#

Set interlayer shear strength type (CONSTANT, LINEAR, or BILINEAR).

Return type:

None

Parameters:

shearType (str)

getMinShearCapacity()#

Minimum shear capacity in project native linear-force units.

Return type:

float

setMinShearCapacity(minShearCapacity)#

Set minimum shear capacity in project native linear-force units (non-negative).

Return type:

None

Parameters:

minShearCapacity (float)

getMaxShearCapacity()#

Maximum shear capacity in project native linear-force units.

Return type:

float

setMaxShearCapacity(maxShearCapacity)#

Set maximum shear capacity in project native linear-force units (non-negative).

Return type:

None

Parameters:

maxShearCapacity (float)

getTangentShearCapacity()#

Tangent shear capacity for BILINEAR type (native linear-force units).

Return type:

float

setTangentShearCapacity(tangentShearCapacity)#

Set tangent shear capacity for BILINEAR type (non-negative).

Return type:

None

Parameters:

tangentShearCapacity (float)

getFrictionAngle()#

Interlayer friction angle in degrees.

Return type:

float

setFrictionAngle(frictionAngle)#

Set interlayer friction angle in degrees (non-negative).

Return type:

None

Parameters:

frictionAngle (float)

getFrictionAngle2()#

Second friction angle for BILINEAR type, in degrees.

Return type:

float

setFrictionAngle2(frictionAngle2)#

Set second friction angle for BILINEAR type, in degrees (non-negative).

Return type:

None

Parameters:

frictionAngle2 (float)

setName(name)#

Set the wall unit display name.

Return type:

None

Parameters:

name (str)

getManufacturerSelection()#

Return the manufacturer preset tagged on this wall unit.

Return type:

Dict[str, Any]

Returns:

Dict with hasSelection, guid, shortName, tooltip (empty strings when unset).

applyManufacturerPreset(guid)#

Apply a built-in gabion manufacturer preset by GUID.

Writes geometry, unit weight (CSV Weight is direct), and interlayer shear from the shipped catalog. User-defined manufacturer files are not supported.

Parameters:

guid (str) – Preset GUID from Wall.getGabionManufacturerLibraryOptions().

Return type:

Dict[str, Any]

Returns:

Dict with success, shortName, tooltip.

clearManufacturerSelection()#

Clear the manufacturer preset tag; engineering values are not reverted.

Return type:

None