rs2.modeler.properties.material.strength.Shansep module#

class rs2.modeler.properties.material.strength.Shansep.Shansep(server: Client, ID, documentProxyID)#

Bases: PropertyProxy

getMaterialType() MaterialType#
setMaterialType(value: MaterialType)#
getUseMaterialDependentStress() bool#
setUseMaterialDependentStress(value: bool)#
getUseMaximumShearStrength() bool#
setUseMaximumShearStrength(value: bool)#
getUseTensileStrength() bool#
setUseTensileStrength(value: bool)#
getAParameter() float#
setAParameter(value: float)#
getSParameter() float#
setSParameter(value: float)#
getMParameter() float#
setMParameter(value: float)#
getMaximumShearStrength() float#
setMaximumShearStrength(value: float)#
getPeakTensileStrength() float#
setPeakTensileStrength(value: float)#
getResidualAParameter() float#
setResidualAParameter(value: float)#
getResidualSParameter() float#
setResidualSParameter(value: float)#
getResidualMParameter() float#
setResidualMParameter(value: float)#
getResidualMaximumShearStrength() float#
setResidualMaximumShearStrength(value: float)#
getResidualTensileStrength() float#
setResidualTensileStrength(value: float)#
getApplySSRShearStrengthReduction() bool#
setApplySSRShearStrengthReduction(value: bool)#
getStressHistoryType() StressHistoryTypes#
setStressHistoryType(value: StressHistoryTypes)#
getOCRDefinitionMethod() StressHistoryDefinitionMethods#
setOCRDefinitionMethod(value: StressHistoryDefinitionMethods)#
getOCR() float#
setOCR(value: float)#
getPcDefinitionMethod() StressHistoryDefinitionMethods#
setPcDefinitionMethod(value: StressHistoryDefinitionMethods)#
getPc() float#
setPc(value: float)#
setShansepMaterialDependentVerticalStress(materialDependentVerticalStress: list[tuple[str, float]])#
materialDependentVerticalStress is a list of (materialName,verticalStressFactor) pairs.

A factor of 1 means that the entire weight is used in the vertical stress computation. A factor of 0 means no weight is used. If a material is not provided, it automatically has a factor of 1.

getShansepMaterialDependentVerticalStress() list[tuple[str, float]]#
returns a list of (materialName,verticalStressFactor) pairs.

A factor of 1 means that the entire weight is used in the vertical stress computation. A factor of 0 means no weight is used. If a material is not listed below it automatically has a factor of 1.

setShansepStressHistory(stressHistory: list[tuple[float, float]])#

Depending on the stressHistory type and definition method, stressHistory is specified as (Depth or Elevation, OCR or Pc).

getShansepStressHistory() list[tuple[float, float]]#

Returns the Stress History. Depending on the stressHistory type and definition method, stressHistory is specified as a list of tuples (Depth or Elevation, OCR or Pc).

setProperties(MaterialType: MaterialType = None, UseMaterialDependentStress: bool = None, UseMaximumShearStrength: bool = None, UseTensileStrength: bool = None, AParameter: float = None, SParameter: float = None, MParameter: float = None, MaximumShearStrength: float = None, PeakTensileStrength: float = None, ResidualAParameter: float = None, ResidualSParameter: float = None, ResidualMParameter: float = None, ResidualMaximumShearStrength: float = None, ResidualTensileStrength: float = None, ApplySSRShearStrengthReduction: bool = None, StressHistoryType: StressHistoryTypes = None, OCRDefinitionMethod: StressHistoryDefinitionMethods = None, OCR: float = None, PcDefinitionMethod: StressHistoryDefinitionMethods = None, Pc: float = None)#
getProperties()#