MSEWallUnit#

MSE/SRW wall unit library entry. Unit type and shear model options are module-level string constants (not Python enums).

Proxy object representing an MSE / SRW wall unit in RSWall.

rswall.MSEWallUnit.UNIT_TYPE_MODULAR = 'MODULAR'#

modular.

Type:

MSE wall unit type string

rswall.MSEWallUnit.UNIT_TYPE_WRAP_AROUND = 'WRAP_AROUND'#

wrap-around.

Type:

MSE wall unit type string

rswall.MSEWallUnit.SHEAR_TYPE_CONSTANT = 'CONSTANT'#

constant.

Type:

Interlayer shear model string

rswall.MSEWallUnit.SHEAR_TYPE_LINEAR = 'LINEAR'#

linear.

Type:

Interlayer shear model string

rswall.MSEWallUnit.SHEAR_TYPE_BILINEAR = 'BILINEAR'#

bilinear.

Type:

Interlayer shear model string

class rswall.MSEWallUnit.MSEWallUnit#

Bases: _ProxyObject

MSE/SRW wall unit library entry.

Unit type and shear model options are module-level string constants (for example UNIT_TYPE_MODULAR, 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, unit type, 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:
getUnitType()#

Return MODULAR or WRAP_AROUND.

Return type:

str

setUnitType(unitType)#

Set unit type to MODULAR or WRAP_AROUND.

Return type:

None

Parameters:

unitType (str)

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 (0 for WRAP_AROUND).

Return type:

float

setDepth(depth)#

Set depth in project native length units (must be > 0; not valid for WRAP_AROUND).

Return type:

None

Parameters:

depth (float)

getCenterOfGravity()#

Center of gravity in project native length units (0 for WRAP_AROUND).

Return type:

float

setCenterOfGravity(centerOfGravity)#

Set center of gravity (non-negative; not valid for WRAP_AROUND).

Return type:

None

Parameters:

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

In CONSTANT shear mode this is the UI “Shear capacity” field (InterlayerMinShearStrength).

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 currently tagged on this wall unit.

When a preset was loaded (via the UI or applyManufacturerPreset), these fields record which catalog entry the engineering values came from. When no preset is applied (UI empty / "None" selection), the RPC returns empty strings for guid/shortName/tooltip and hasSelection=False so clients can treat the strings as null.

Returns:

hasSelection - bool, True when a manufacturer preset is active guid - the preset GUID (empty string when not set) shortName - catalog type label, e.g. “28 in (710 mm) solid - R28T” tooltip - human-readable label, e.g. “RediRock - 28 in (710 mm) solid - R28T”

Return type:

Dict with keys

applyManufacturerPreset(guid)#

Apply a built-in manufacturer library preset to this wall unit by GUID.

Reads the preset engineering values (geometry, unit weight, interlayer shear strength) from the built-in catalog and writes all of them to the wall unit in a single operation. The three manufacturer tracking fields are also set so that getManufacturerSelection() immediately reflects the new preset.

All engineering values are overwritten; manually-entered values are replaced. The wall unit type (MODULAR / WRAP_AROUND) is not changed. User-defined manufacturer files from the UI dialog are not supported here.

Parameters:

guid (str) – The preset GUID from getManufacturerLibraryOptions().

Returns:

success - True on success shortName - catalog type label, e.g. “28 in (710 mm) solid - R28T” tooltip - human-readable label, e.g. “RediRock - 28 in (710 mm) solid - R28T”

Return type:

Dict with keys

clearManufacturerSelection()#

Clear the manufacturer preset tag from this wall unit.

After clearing, getManufacturerSelection() returns empty strings for guid/shortName/tooltip and hasSelection=False (clients may map those strings to null). Engineering values already written to the wall unit (geometry, shear strength, etc.) are NOT reverted.

Return type:

None