rs3.properties.joint.BartonBandis module#

class rs3.properties.joint.BartonBandis.BartonBandisBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getJCS() → float#

setJCS(value: float)#

getJRC() → float#

setJRC(value: float)#

getNormalStiffness() → float#

setNormalStiffness(value: float)#

getShearStiffness() → float#

setShearStiffness(value: float)#

getResidualFrictionAngle() → float#

setResidualFrictionAngle(value: float)#

getDefineResidualStrength() → bool#

setDefineResidualStrength(value: bool)#

getProperties()#: Retrieve properties as a dictionary.

setProperties(JCS: float = None, JRC: float = None, NormalStiffness: float = None, ShearStiffness: float = None, ResidualFrictionAngle: float = None, DefineResidualStrength: bool = None)#: Set properties using keyword arguments.

class rs3.properties.joint.BartonBandis.BartonBandisStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: IStageFactorBase

getResidualFrictionAngleFactor() → float#

getJCSFactor() → float#

getJRCFactor() → float#

getNormalStiffnessFactor() → float#

getShearStiffnessFactor() → float#

class rs3.properties.joint.BartonBandis.BartonBandisDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: BartonBandisStageFactorBase

setResidualFrictionAngleFactor(value: float)#

setJCSFactor(value: float)#

setJRCFactor(value: float)#

setNormalStiffnessFactor(value: float)#

setShearStiffnessFactor(value: float)#

class rs3.properties.joint.BartonBandis.BartonBandisStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: BartonBandisStageFactorBase

Examples

See Joint Script Examples.

class rs3.properties.joint.BartonBandis.BartonBandisDefinedStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: BartonBandisStageFactor, BartonBandisDefinedStageFactorBase

Examples

See Joint Script Examples.

class rs3.properties.joint.BartonBandis.BartonBandis(client: Client, id: str)#

Bases: BartonBandisBase

Examples

See Joint Script Examples.

getAllowSlipStartFromStage() → int#

setAllowSlipStartFromStage(value: int)#