RS3Scripting 4.42.0__py3-none-any.whl

rs3/properties/material/hydraulic/FEAGroundwater/Brooks.py

@@ -0,0 +1,71 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.HydraulicStageFactorService_pb2_grpc as HydraulicStageFactorService_pb2_grpc
+class BrooksBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getPoreSizeIndex(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("PoreSizeIndex")
+    def setPoreSizeIndex(self, value: float):
+        self._propertyAccessor.setDoubleProperty("PoreSizeIndex", value)
+    def getBubblingPressure(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("BubblingPressure")
+    def setBubblingPressure(self, value: float):
+        self._propertyAccessor.setDoubleProperty("BubblingPressure", value)
+    def getProperties(self):
+        return {
+            "PoreSizeIndex": self.getPoreSizeIndex(),
+            "BubblingPressure": self.getBubblingPressure(),
+        }
+    def setProperties(self, PoreSizeIndex: float = None, BubblingPressure: float = None):
+        if PoreSizeIndex is not None:
+            self.setPoreSizeIndex(PoreSizeIndex)
+        if BubblingPressure is not None:
+            self.setBubblingPressure(BubblingPressure)
+class BrooksStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, HydraulicStageFactorService_pb2_grpc.HydraulicStageFactorServiceStub(client.channel))
+    def getPoreSizeIndexFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_PoreSizeIndex")
+    def getBubblingPressureFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_BubblingPressure")
+class BrooksDefinedStageFactorBase(BrooksStageFactorBase):
+    def setPoreSizeIndexFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_PoreSizeIndex", value)
+    def setBubblingPressureFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_BubblingPressure", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.PropertyEnums import *
+from rs3.properties.stageFactors.StageFactorBaseInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.hydraulic.FEAGroundwater.HydraulicParametersCommon import HydraulicParametersCommon, HydraulicParametersCommonStageFactor, HydraulicParametersCommonDefinedStageFactor
+
+class BrooksStageFactor(BrooksStageFactorBase, HydraulicParametersCommonStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, id: str, stageFactorId: str, client: Client):
+        super().__init__(id, stageFactorId, client)
+        
+class BrooksDefinedStageFactor(BrooksDefinedStageFactorBase, BrooksStageFactor, HydraulicParametersCommonDefinedStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    pass
+
+class Brooks(BrooksBase, HydraulicParametersCommon):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[BrooksDefinedStageFactor, BrooksStageFactor](id, client, BrooksDefinedStageFactor, BrooksStageFactor)
+        

rs3/properties/material/hydraulic/FEAGroundwater/Custom.py

@@ -0,0 +1,79 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import BasePropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.HydraulicStageFactorService_pb2_grpc as HydraulicStageFactorService_pb2_grpc
+class CustomBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._basePropertyAccessor = BasePropertyAccessor(client, id)
+    def getMv(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("MV")
+    def setMv(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("MV", value)
+    def getPermeabilityK2K1Ratio(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("K2K1Ratio")
+    def setPermeabilityK2K1Ratio(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("K2K1Ratio", value)
+    def getPermeabilityK3K1Ratio(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("K3K1Ratio")
+    def setPermeabilityK3K1Ratio(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("K3K1Ratio", value)
+    def getProperties(self):
+        return {
+            "Mv": self.getMv(),
+            "PermeabilityK2K1Ratio": self.getPermeabilityK2K1Ratio(),
+            "PermeabilityK3K1Ratio": self.getPermeabilityK3K1Ratio(),
+        }
+    def setProperties(self, Mv: float = None, PermeabilityK2K1Ratio: float = None, PermeabilityK3K1Ratio: float = None):
+        if Mv is not None:
+            self.setMv(Mv)
+        if PermeabilityK2K1Ratio is not None:
+            self.setPermeabilityK2K1Ratio(PermeabilityK2K1Ratio)
+        if PermeabilityK3K1Ratio is not None:
+            self.setPermeabilityK3K1Ratio(PermeabilityK3K1Ratio)
+class CustomStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, stub):
+        super().__init__(id, stageFactorID, client, stub)
+    def getPermeabilityK2K1RatioFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_K2K1Ratio")
+    def getPermeabilityK3K1RatioFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_K3K1Ratio")
+class CustomDefinedStageFactorBase(CustomStageFactorBase):
+    def setPermeabilityK2K1RatioFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_K2K1Ratio", value)
+    def setPermeabilityK3K1RatioFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_K3K1Ratio", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.PropertyEnums import *
+from rs3.properties.material.hydraulic.FEAGroundwater.HydraulicMethodVectors import HydraulicMethodVectors
+from rs3.properties.stageFactors.StageFactorBaseInterfaces import AbsoluteStageFactorInterface
+class CustomStageFactor(CustomStageFactorBase):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, id: str, stageFactorId: str, client: Client):
+        super().__init__(id, stageFactorId, client, HydraulicStageFactorService_pb2_grpc.HydraulicStageFactorServiceStub(client.channel))
+class CustomDefinedStageFactor(CustomStageFactor, CustomDefinedStageFactorBase):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    pass
+class Custom(CustomBase, HydraulicMethodVectors):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, objectId: str):
+        super().__init__(client, objectId)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[CustomDefinedStageFactor, CustomStageFactor](objectId, client, CustomDefinedStageFactor, CustomStageFactor)
+        
+    def setHydraulicMethodType(self, hydraulicMethodType : HydraulicMethodType):
+        self._basePropertyAccessor.setEnumValue("MethodType", hydraulicMethodType.value)
+    def getHydraulicMethodType(self) -> HydraulicMethodType:
+        return self._basePropertyAccessor.getEnumValue("MethodType", HydraulicMethodType)

rs3/properties/material/hydraulic/FEAGroundwater/FEAGroundwater.py

@@ -0,0 +1,85 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.PropertyEnums import *
+from rs3.CommonEnums import *
+from rs3.properties.material.hydraulic.FEAGroundwater.Brooks import Brooks
+from rs3.properties.material.hydraulic.FEAGroundwater.Fredlund import Fredlund
+from rs3.properties.material.hydraulic.FEAGroundwater.Simple import Simple
+from rs3.properties.material.hydraulic.FEAGroundwater.Gardner import Gardner
+from rs3.properties.material.hydraulic.FEAGroundwater.VanGenuchten import VanGenuchten
+from rs3.properties.material.hydraulic.FEAGroundwater.Custom import Custom
+from rs3.properties.material.hydraulic._PropertyAccessor import PropertyAccessor as NewPropertyAccessor
+import rs3.generatedFiles.MaterialHydraulicDataService_pb2_grpc as MaterialHydraulicDataService_pb2_grpc
+import rs3.generatedFiles.MaterialHydraulicDataService_pb2 as MaterialHydraulicDataService_pb2
+class FEAGroundwater(_ProxyObject):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = NewPropertyAccessor(client, id)
+        self._stub = MaterialHydraulicDataService_pb2_grpc.MaterialHydraulicDataServiceStub(client.channel)
+        self.Brooks = Brooks(client, id)
+        self.Fredlund = Fredlund(client, id)
+        self.Simple = Simple(client, id)
+        self.Gardner = Gardner(client, id)
+        self.VanGenuchten = VanGenuchten(client, id)
+        self.Custom = Custom(client, id)
+                
+    def setHydraulicModelType(self, hydraulicModelType : HydraulicModelType, customHydraulicModelName : str = ""):
+        """
+        Set the hydraulic model type for the current material.
+
+        If setting a standard hydraulic model, specify the `hydraulicModelType` as one of the predefined `HydraulicModelType` enum values.  
+
+        If setting a custom hydraulic model, set `hydraulicModelType` to `HydraulicModelType.CUSTOM` and provide a non-empty `customHydraulicModelName`.
+        The method will send the custom name to the service instead of using the standard enum property.
+
+        Args:
+            hydraulicModelType (HydraulicModelType):
+                The type of hydraulic model to set.
+                - Standard models: use the corresponding `HydraulicModelType` enum.
+                - Custom model: use `HydraulicModelType.CUSTOM`.
+            customHydraulicModelName (str, optional):
+                The name of the custom hydraulic model, required when `hydraulicModelType` is `CUSTOM`. Ignored for standard models.
+
+        Raises:
+            ValueError: If `hydraulicModelType` is `CUSTOM` and no `customHydraulicModelName` is provided.
+        """
+        if hydraulicModelType == HydraulicModelType.CUSTOM and customHydraulicModelName is None:
+            raise ValueError("Custom hydraulic moodel name is required.")
+        elif hydraulicModelType == HydraulicModelType.CUSTOM and customHydraulicModelName is not None:
+            request = MaterialHydraulicDataService_pb2.SetCustomHydraulicModelTypeRequest(objectId=self._objectId, value=customHydraulicModelName)
+            self._client.callFunction(self._stub.SetCustomHydraulicModelType, request)
+        else:
+            self._propertyAccessor.setIntProperty("ModelType", hydraulicModelType.value)
+    def getHydraulicModelType(self) -> HydraulicModelType | str:
+        """
+        Retrieve the current hydraulic model type for the material.
+
+        - If the current model is a **standard hydraulic model**, this method returns the corresponding `HydraulicModelType` enum value.
+        - If the current model is a **custom hydraulic model**, this method returns the custom hydraulic model name as a string.
+
+        Returns:
+            HydraulicModelType | str:
+                - `HydraulicModelType` enum for standard models.
+                - `str` for the custom hydraulic model name.
+
+        Raises:
+            ValueError: If the response does not contain a valid value.
+        """
+        request = MaterialHydraulicDataService_pb2.GetCustomHydraulicModelTypeRequest(objectId=self._objectId)
+        response : MaterialHydraulicDataService_pb2.GetCustomHydraulicModelTypeResponse = self._client.callFunction(self._stub.GetCustomHydraulicModelType, request)
+        
+        field = response.value.WhichOneof("value")
+
+        if field == "intValue":
+            return HydraulicModelType(response.value.intValue)
+        elif field == "stringValue":
+            return response.value.stringValue
+        else:
+            raise ValueError("No valid value found in response.")

rs3/properties/material/hydraulic/FEAGroundwater/Fredlund.py

@@ -0,0 +1,82 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.HydraulicStageFactorService_pb2_grpc as HydraulicStageFactorService_pb2_grpc
+class FredlundBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getA(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("FredXingA")
+    def setA(self, value: float):
+        self._propertyAccessor.setDoubleProperty("FredXingA", value)
+    def getB(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("FredXingB")
+    def setB(self, value: float):
+        self._propertyAccessor.setDoubleProperty("FredXingB", value)
+    def getC(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("FredXingC")
+    def setC(self, value: float):
+        self._propertyAccessor.setDoubleProperty("FredXingC", value)
+    def getProperties(self):
+        return {
+            "A": self.getA(),
+            "B": self.getB(),
+            "C": self.getC(),
+        }
+    def setProperties(self, A: float = None, B: float = None, C: float = None):
+        if A is not None:
+            self.setA(A)
+        if B is not None:
+            self.setB(B)
+        if C is not None:
+            self.setC(C)
+class FredlundStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, HydraulicStageFactorService_pb2_grpc.HydraulicStageFactorServiceStub(client.channel))
+    def getAFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_FredXingA")
+    def getBFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_FredXingB")
+    def getCFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_FredXingC")
+class FredlundDefinedStageFactorBase(FredlundStageFactorBase):
+    def setAFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_FredXingA", value)
+    def setBFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_FredXingB", value)
+    def setCFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_FredXingC", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.PropertyEnums import *
+from rs3.properties.stageFactors.StageFactorBaseInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.hydraulic.FEAGroundwater.HydraulicParametersCommon import HydraulicParametersCommon, HydraulicParametersCommonStageFactor, HydraulicParametersCommonDefinedStageFactor
+
+class FredlundStageFactor(FredlundStageFactorBase, HydraulicParametersCommonStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, id: str, stageFactorId: str, client: Client):
+        super().__init__(id, stageFactorId, client)
+        
+class FredlundDefinedStageFactor(FredlundDefinedStageFactorBase, FredlundStageFactor, HydraulicParametersCommonDefinedStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    pass
+
+class Fredlund(FredlundBase, HydraulicParametersCommon):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[FredlundDefinedStageFactor, FredlundStageFactor](id, client, FredlundDefinedStageFactor, FredlundStageFactor)
+        

rs3/properties/material/hydraulic/FEAGroundwater/Gardner.py

@@ -0,0 +1,72 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.HydraulicStageFactorService_pb2_grpc as HydraulicStageFactorService_pb2_grpc
+class GardnerBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getA(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("GardnerA")
+    def setA(self, value: float):
+        self._propertyAccessor.setDoubleProperty("GardnerA", value)
+    def getN(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("GardnerN")
+    def setN(self, value: float):
+        self._propertyAccessor.setDoubleProperty("GardnerN", value)
+    def getProperties(self):
+        return {
+            "A": self.getA(),
+            "N": self.getN(),
+        }
+    def setProperties(self, A: float = None, N: float = None):
+        if A is not None:
+            self.setA(A)
+        if N is not None:
+            self.setN(N)
+class GardnerStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, HydraulicStageFactorService_pb2_grpc.HydraulicStageFactorServiceStub(client.channel))
+    def getAFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_GardnerA")
+    def getNFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_GardnerN")
+class GardnerDefinedStageFactorBase(GardnerStageFactorBase):
+    def setAFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_GardnerA", value)
+    def setNFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_GardnerN", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.PropertyEnums import *
+from rs3.properties.stageFactors.StageFactorBaseInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.hydraulic.FEAGroundwater.HydraulicParametersCommon import HydraulicParametersCommon, HydraulicParametersCommonStageFactor, HydraulicParametersCommonDefinedStageFactor
+
+class GardnerStageFactor(GardnerStageFactorBase, HydraulicParametersCommonStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, id: str, stageFactorId: str, client: Client):
+        super().__init__(id, stageFactorId, client)
+        
+class GardnerDefinedStageFactor(GardnerDefinedStageFactorBase, GardnerStageFactor, HydraulicParametersCommonDefinedStageFactor):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    pass
+
+class Gardner(GardnerBase, HydraulicParametersCommon):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[GardnerDefinedStageFactor, GardnerStageFactor](id, client, GardnerDefinedStageFactor, GardnerStageFactor)
+        
+        

rs3/properties/material/hydraulic/FEAGroundwater/HydraulicMethodVectors.py

@@ -0,0 +1,97 @@
+from rs3.CommonEnums import *
+from rs3._client import Client
+from rs3._proxyObject import _ProxyObject
+import rs3.generatedFiles.CommonMessages_pb2 as CommonMessages_pb2
+import rs3.generatedFiles.MaterialHydraulicDataService_pb2_grpc as MaterialHydraulicDataService_pb2_grpc
+import rs3.generatedFiles.MaterialHydraulicDataService_pb2 as MaterialHydraulicDataService_pb2
+class HydraulicMethodVectors(_ProxyObject):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._stub = MaterialHydraulicDataService_pb2_grpc.MaterialHydraulicDataServiceStub(client.channel)
+              
+    def setK1DirectionType(self, value : LinearDirectionType):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DirectionType", value=CommonMessages_pb2.PropertyValue(enumValue=value.value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK1DirectionType(self) -> LinearDirectionType:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DirectionType")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return LinearDirectionType(response.value.enumValue)
+    
+    def setK1Trend(self, value : float):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DegTrend", value=CommonMessages_pb2.PropertyValue(doubleValue=value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK1Trend(self) -> float:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DegTrend")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return response.value.doubleValue
+    
+    def setK1Plunge(self, value : float):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DegPlunge", value=CommonMessages_pb2.PropertyValue(doubleValue=value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK1Plunge(self) -> float:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="DegPlunge")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return response.value.doubleValue
+    
+    def setK1Vector(self, value : tuple[float, float, float]):
+        """
+        Set (x, y, z) of the K1 vector.
+        """
+        vector = CommonMessages_pb2.Vector3D(x=value[0], y=value[1], z=value[2])
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="Vector", value=CommonMessages_pb2.PropertyValue(vector3DValue=vector))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK1Vector(self) -> tuple[float, float, float]:
+        """
+        Get (x, y, z) of the K1 vector.
+        """
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K1Orientation", propertyName="Vector")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return (response.value.vector3DValue.x, response.value.vector3DValue.y, response.value.vector3DValue.z)
+    
+    def setK2DirectionType(self, value : LinearDirectionType):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DirectionType", value=CommonMessages_pb2.PropertyValue(enumValue=value.value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK2DirectionType(self) -> LinearDirectionType:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DirectionType")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return LinearDirectionType(response.value.enumValue)
+    
+    def setK2Trend(self, value : float):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DegTrend", value=CommonMessages_pb2.PropertyValue(doubleValue=value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK2Trend(self) -> float:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DegTrend")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return response.value.doubleValue
+    
+    def setK2Plunge(self, value : float):
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DegPlunge", value=CommonMessages_pb2.PropertyValue(doubleValue=value))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK2Plunge(self) -> float:
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="DegPlunge")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return response.value.doubleValue
+    
+    def setK2Vector(self, value : tuple[float, float, float]):
+        """
+        Set (x, y, z) of the K2 vector.
+        """
+        vector = CommonMessages_pb2.Vector3D(x=value[0], y=value[1], z=value[2])
+        request = MaterialHydraulicDataService_pb2.SetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="Vector", value=CommonMessages_pb2.PropertyValue(vector3DValue=vector))
+        self._client.callFunction(self._stub.SetLinearDirection, request)
+
+    def getK2Vector(self) -> tuple[float, float, float]:
+        """
+        Get (x, y, z) of the K2 vector.
+        """
+        request = MaterialHydraulicDataService_pb2.GetLinearDirectionRequest(objectId=self._objectId, upperPropertyName="K2Orientation", propertyName="Vector")
+        response : MaterialHydraulicDataService_pb2.GetLinearDirectionResponse = self._client.callFunction(self._stub.GetLinearDirection, request)
+        return (response.value.vector3DValue.x, response.value.vector3DValue.y, response.value.vector3DValue.z)
+    

rs3/properties/material/hydraulic/FEAGroundwater/HydraulicParametersCommon.py

@@ -0,0 +1,157 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import BasePropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.HydraulicStageFactorService_pb2_grpc as HydraulicStageFactorService_pb2_grpc
+class HydraulicParametersCommonBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._basePropertyAccessor = BasePropertyAccessor(client, id)
+    def getPermeabilityK(self) -> float:
+        """
+        Get isotropic permeability.
+        """
+        return self._basePropertyAccessor.getDoubleProperty("PermeabilityForLinearIsotropic")
+    def setPermeabilityK(self, value: float):
+        """
+        Set isotropic permeability.
+        """
+        self._basePropertyAccessor.setDoubleProperty("PermeabilityForLinearIsotropic", value)
+    def getPermeabilityK1(self) -> float:
+        """
+        Get anisotropic permeability.
+        """
+        return self._basePropertyAccessor.getDoubleProperty("Permeability")
+    def setPermeabilityK1(self, value: float):
+        """
+        Set anisotropic permeability.
+        """
+        self._basePropertyAccessor.setDoubleProperty("Permeability", value)
+    def getMv(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("MV")
+    def setMv(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("MV", value)
+    def getWCSat(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("WCSat")
+    def setWCSat(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("WCSat", value)
+    def getWCRes(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("WCRes")
+    def setWCRes(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("WCRes", value)
+    def getPermeabilityK2K1Ratio(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("K2K1Ratio")
+    def setPermeabilityK2K1Ratio(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("K2K1Ratio", value)
+    def getPermeabilityK3K1Ratio(self) -> float:
+        return self._basePropertyAccessor.getDoubleProperty("K3K1Ratio")
+    def setPermeabilityK3K1Ratio(self, value: float):
+        self._basePropertyAccessor.setDoubleProperty("K3K1Ratio", value)
+    def getProperties(self):
+        return {
+            "PermeabilityK": self.getPermeabilityK(),
+            "PermeabilityK1": self.getPermeabilityK1(),
+            "Mv": self.getMv(),
+            "WCSat": self.getWCSat(),
+            "WCRes": self.getWCRes(),
+            "PermeabilityK2K1Ratio": self.getPermeabilityK2K1Ratio(),
+            "PermeabilityK3K1Ratio": self.getPermeabilityK3K1Ratio(),
+        }
+    def setProperties(self, PermeabilityK: float = None, PermeabilityK1: float = None, Mv: float = None, WCSat: float = None, WCRes: float = None, PermeabilityK2K1Ratio: float = None, PermeabilityK3K1Ratio: float = None):
+        if PermeabilityK is not None:
+            self.setPermeabilityK(PermeabilityK)
+        if PermeabilityK1 is not None:
+            self.setPermeabilityK1(PermeabilityK1)
+        if Mv is not None:
+            self.setMv(Mv)
+        if WCSat is not None:
+            self.setWCSat(WCSat)
+        if WCRes is not None:
+            self.setWCRes(WCRes)
+        if PermeabilityK2K1Ratio is not None:
+            self.setPermeabilityK2K1Ratio(PermeabilityK2K1Ratio)
+        if PermeabilityK3K1Ratio is not None:
+            self.setPermeabilityK3K1Ratio(PermeabilityK3K1Ratio)
+class HydraulicParametersCommonStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, stub):
+        super().__init__(id, stageFactorID, client, stub)
+    def getPermeabilityKFactor(self) -> float:
+        """
+        Get isotropic permeability factor.
+        """
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_Permeability")
+    def getPermeabilityK1AngleFactor(self) -> float:
+        """
+        Get anisotropic permeability angle factor.
+        """
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_K1Angle")
+    def getMvFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_MV")
+    def getWCSatFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_WCSat")
+    def getWCResFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_WCRes")
+    def getPermeabilityK2K1RatioFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_K2K1Ratio")
+    def getPermeabilityK3K1RatioFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("GW_K3K1Ratio")
+class HydraulicParametersCommonDefinedStageFactorBase(HydraulicParametersCommonStageFactorBase):
+    def setPermeabilityKFactor(self, value: float):
+        """
+        Set isotropic permeability factor.
+        """
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_Permeability", value)
+    def setPermeabilityK1AngleFactor(self, value: float):
+        """
+        Set anisotropic permeability angle factor.
+        """
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_K1Angle", value)
+    def setMvFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_MV", value)
+    def setWCSatFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_WCSat", value)
+    def setWCResFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_WCRes", value)
+    def setPermeabilityK2K1RatioFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_K2K1Ratio", value)
+    def setPermeabilityK3K1RatioFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("GW_K3K1Ratio", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.PropertyEnums import *
+from rs3.properties.stageFactors.StageFactorBaseInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.hydraulic.FEAGroundwater.HydraulicMethodVectors import HydraulicMethodVectors
+import rs3.generatedFiles.MaterialHydraulicDataService_pb2_grpc as MaterialHydraulicDataService_pb2_grpc
+
+class HydraulicParametersCommonStageFactor(HydraulicParametersCommonStageFactorBase):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, id : str, stageFactorID : str, client : Client, stub):
+        super().__init__(id, stageFactorID, client, stub)
+        
+class HydraulicParametersCommonDefinedStageFactor(HydraulicParametersCommonStageFactor, HydraulicParametersCommonDefinedStageFactorBase):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    pass
+
+class HydraulicParametersCommon(HydraulicParametersCommonBase, HydraulicMethodVectors):
+    """
+	Examples:
+		See :ref:`material_hydraulic_example`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._stub = MaterialHydraulicDataService_pb2_grpc.MaterialHydraulicDataServiceStub(client.channel)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[HydraulicParametersCommonDefinedStageFactor, HydraulicParametersCommonStageFactor](id, client, HydraulicParametersCommonDefinedStageFactor, HydraulicParametersCommonStageFactor)
+    
+    def setHydraulicMethodType(self, hydraulicMethodType : HydraulicMethodType):
+        self._basePropertyAccessor.setEnumValue("MethodType", hydraulicMethodType.value)
+    def getHydraulicMethodType(self) -> HydraulicMethodType:
+        return self._basePropertyAccessor.getEnumValue("MethodType", HydraulicMethodType)    
+