rs3.properties.liningComposition.LiningComposition module#

class rs3.properties.liningComposition.LiningComposition.CompositeLinerLayer(linerName: str = '', hasUpperJoint: bool = False, hasLowerJoint: bool = False, installationStage: int = 0, isRemoved: bool = False, removalStage: int = -1, upperJointName: str = '', lowerJointName: str = '')#

Bases: object

linerName: str = ''#
hasUpperJoint: bool = False#
hasLowerJoint: bool = False#
installationStage: int = 0#
isRemoved: bool = False#
removalStage: int = -1#
upperJointName: str = ''#
lowerJointName: str = ''#
setLinerByName(name)#
setUpperJoint(hasUpperJoint: bool, upperJointName: str = '')#
setLowerJoint(hasLowerJoint: bool, lowerJointName: str = '')#
setInstallationStage(installationStage: int)#
setRemovalStage(isRemoved: bool, removalStage: int)#
to_tuple()#
class rs3.properties.liningComposition.LiningComposition.LiningCompositionProperty(client: Client, liningCompositionID: str)#

Bases: _ProxyObject

Define the liners and joint interfaces that belong to a lining.

Examples

See Composite Liner Script Examples.

getCompositeName() → str#
setCompositeName(name: str)#
getLayerComposition() → list[CompositeLinerLayer]#

Retrieves the current composite liner configuration for the object.

Returns:

Each CompositeLinerLayer represents one lining composition layer in the composite liner structure.

The CompositeLinerLayer contains the following fields:

  • linerName (str): Name of the liner.

  • hasUpperJoint (bool): Whether an upper joint is present.

  • upperJointName (str): Name of the upper joint if hasUpperJoint is True. Otherwise, it shows as None.

  • hasLowerJoint (bool): Whether a lower joint is present.

  • lowerJointName (str): Name of the lower joint if hasLowerJoint is True. Otherwise, it shows as None.

  • installationStage (int): The construction stage at which the liner is installed.

  • isRemoved (bool): Whether the liner is removed.

  • removalStage (int): The construction stage at which the liner is removed; should be -1 if never get removed.

Return type:

list of CompositeLinerLayer

setLayerComposition(value: list[CompositeLinerLayer])#

Sets or updates the composite liner configuration for the object.

Parameters:

  • value – A list of CompositeLinerLayer, each CompositeLinerLayer representing a set of liner and interface element(s) in sequence. Each item must contain:

  • linerName (-) – Name of the liner.

  • hasUpperJoint (-) – True if an upper joint exists.

  • upperJointName (-) – Name of the upper joint (must be a valid and unique joint name in the current RS3 project if hasUpperJoint is True). Otherwise, the value should be “None”.

  • hasLowerJoint (-) – True if a lower joint exists.

  • lowerJointName (-) – Name of the lower joint (must be a valid and unique joint name in the current RS3 project if hasLowerJoint is True). Otherwise, the value should be “None”.

  • installationStage (-) – Stage at which the liner is installed.

  • isRemoved (-) – Whether the liner is removed.

  • removalStage (-) – Stage at which the liner is removed; must be -1 if isRemoved is False.

Notes

  • If hasUpperJoint or hasLowerJoint is True, the corresponding joint name must be a valid and uniquely defined joint in RS3.

  • If isRemoved is False, removalStage must be -1.

  • The first liner in the list is considered the primary liner; its installationStage cannot be changed.

  • No two adjacent items in the list may both be joints (i.e., no two consecutive InterfaceData elements).

  • A predecessor liner cannot be removed while any successor liner is still active (installed and not yet removed).

getLayerCompositionTuple() → list[tuple[str, bool, str, bool, str, int, bool, int]]#

Retrieves the current composite liner configuration for the object.

Returns:

Each tuple represents one layer or joint in the composite liner structure.

The tuple contains the following fields:

  • linerName (str): Name of the liner.

  • hasUpperJoint (bool): Whether an upper joint is present.

  • upperJointName (str): Name of the upper joint if hasUpperJoint is True. Otherwise, it shows as None.

  • hasLowerJoint (bool): Whether a lower joint is present.

  • lowerJointName (str): Name of the lower joint if hasLowerJoint is True. Otherwise, it shows as None.

  • installationStage (int): The construction stage at which the liner is installed.

  • isRemoved (bool): Whether the liner is removed.

  • removalStage (int): The construction stage at which the liner is removed; should be -1 if never get removed.

Return type:

list of tuples

setLayerCompositionTuple(value: list[tuple[str, bool, str, bool, str, int, bool, int]])#

Sets or updates the composite liner configuration for the object.

Parameters:

  • value – A list of tuples, each tuple representing a set of one liner and interface element(s) in sequence.

  • contain (Each tuple must) –

    • linerName (str): Name of the liner.

    • hasUpperJoint (bool): True if an upper joint exists.

    • upperJointName (str): Name of the upper joint (must be a valid and unique joint name in the current RS3 project if hasUpperJoint is True). Otherwise, the value should be “None”.

    • hasLowerJoint (bool): True if a lower joint exists.

    • lowerJointName (str): Name of the lower joint (must be a valid and unique joint name in the current RS3 project if hasLowerJoint is True). Otherwise, the value should be “None”.

    • installationStage (int): Stage at which the liner is installed.

    • isRemoved (bool): Whether the liner is removed.

    • removalStage (int): Stage at which the liner is removed; must be -1 if isRemoved is False.

Notes

  • If hasUpperJoint or hasLowerJoint is True, the corresponding joint name must be a valid and uniquely defined joint in RS3.

  • If isRemoved is False, removalStage must be -1.

  • The first liner in the list is considered the primary liner; its installationStage cannot be changed.

  • No two adjacent items in the list may both be joints (i.e., no two consecutive InterfaceData elements).

  • A predecessor liner cannot be removed while any successor liner is still active (installed and not yet removed).