rs3.properties.beam.BeamCommon module#

class rs3.properties.beam.BeamCommon.BeamCommonBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getYoungsModulus() float#
setYoungsModulus(value: float)#
getPoissonsRatio() float#
setPoissonsRatio(value: float)#
getShearStrength() float#
setShearStrength(value: float)#
getArea() float#
setArea(value: float)#
getUnitWeight() float#
setUnitWeight(value: float)#
getPreTensioning() bool#
setPreTensioning(value: bool)#
getPreTensioningForce() float#
setPreTensioningForce(value: float)#
getIncludeWeightInStressAnalysis() bool#
setIncludeWeightInStressAnalysis(value: bool)#
getCompressiveStrength() float#
setCompressiveStrength(value: float)#
getTensileStrength() float#
setTensileStrength(value: float)#
getResidualCompressiveStrength() float#
setResidualCompressiveStrength(value: float)#
getResidualTensileStrength() float#
setResidualTensileStrength(value: float)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(YoungsModulus: float = None, PoissonsRatio: float = None, ShearStrength: float = None, Area: float = None, UnitWeight: float = None, PreTensioning: bool = None, PreTensioningForce: float = None, IncludeWeightInStressAnalysis: bool = None, CompressiveStrength: float = None, TensileStrength: float = None, ResidualCompressiveStrength: float = None, ResidualTensileStrength: float = None)#

Set properties using keyword arguments.

class rs3.properties.beam.BeamCommon.BeamCommonStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: IStageFactorBase

getAreaFactor() float#
getCompressiveStrengthFactor() float#
getResidualCompressiveStrengthFactor() float#
getPoissonsRatioFactor() float#
getPretensionForceFactor() float#
getTensileStrengthFactor() float#
getResidualTensileStrengthFactor() float#
getUnitWeightFactor() float#
getYoungsModulusFactor() float#
class rs3.properties.beam.BeamCommon.BeamCommonDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: BeamCommonStageFactorBase

setAreaFactor(value: float)#
setCompressiveStrengthFactor(value: float)#
setResidualCompressiveStrengthFactor(value: float)#
setPoissonsRatioFactor(value: float)#
setPretensionForceFactor(value: float)#
setTensileStrengthFactor(value: float)#
setResidualTensileStrengthFactor(value: float)#
setUnitWeightFactor(value: float)#
setYoungsModulusFactor(value: float)#
class rs3.properties.beam.BeamCommon.BeamCommonStageFactor(id: str, stageFactorId: str, client: Client)#

Bases: BeamCommonStageFactorBase

Examples

See Beam Script Examples.

class rs3.properties.beam.BeamCommon.BeamCommonDefinedStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: BeamCommonDefinedStageFactorBase

Examples

See Beam Script Examples.

class rs3.properties.beam.BeamCommon.BeamCommon(client: Client, id: str)#

Bases: BeamCommonBase

Common base class for all beam-type structural elements.

BeamCommon defines the shared properties that are applicable to both Standard beam and Truss.

Examples

See Beam Script Examples.

setMaterialType(value: MaterialType)#
getMaterialType() MaterialType#