dlubal.api 2.9.7.dev1__tar.gz → 2.9.8__tar.gz

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dlubal.api
-Version: 2.9.7.dev1
+Version: 2.9.8
 Summary: Python Client Library for Dlubal Software APIs powered by gRPC
 Author: Dlubal Software
 Author-email: api@dlubal.com
@@ -35,7 +35,7 @@ Dynamic: summary
 
 This package version is fully compatible with the following **Dlubal App version**:
 
-✅ **X.09.0007.33.6b7db549a00**
+✅ **X.09.0008.218.5212249d26f**
 
 ## Overview
 The `dlubal.api` package is the next-generation Python client library for interacting with Dlubal Software APIs, leveraging modern **gRPC technology** to deliver high-speed communication, scalability, and improved performance. This API enables **seamless automation** and **remote access** to Dlubal software like **RFEM 6**, with near future support for **RSTAB 9** and **RSECTION 1**.

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/README.md

@@ -8,7 +8,7 @@
 
 This package version is fully compatible with the following **Dlubal App version**:
 
-✅ **X.09.0007.33.6b7db549a00**
+✅ **X.09.0008.218.5212249d26f**
 
 ## Overview
 The `dlubal.api` package is the next-generation Python client library for interacting with Dlubal Software APIs, leveraging modern **gRPC technology** to deliver high-speed communication, scalability, and improved performance. This API enables **seamless automation** and **remote access** to Dlubal software like **RFEM 6**, with near future support for **RSTAB 9** and **RSECTION 1**.

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/dlubal/api/rfem/application.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 from dlubal.api.common.connection import _ApiKey, check_ssl, init_channel
 from dlubal.api.rfem.packing import pack_object, pack_object_list, unpack_object, unpack_object_list, get_internal_value
-from dlubal.api.common.exceptions import exception_handler
 from dlubal.api.common.table import Table
 from dlubal.api.common.table_data_pb2 import TableData
 from dlubal.api.rfem.results import ResultsId
@@ -12,9 +11,11 @@ import grpc
 
 from collections.abc import Iterable
 from pandas import DataFrame
+from importlib.metadata import version
 import dlubal.api.common.model_id_pb2
 import dlubal.api.rfem.application_pb2
 import dlubal.api.rfem.application_pb2_grpc
+import dlubal.api.rfem.object_type_pb2
 import google.protobuf.empty_pb2
 
 
@@ -31,12 +32,22 @@ class Application:
         Initialize the RFEM client and connect to gRPC server.
 
         Args:
-            api_key_value (str, optional): Value of the API key. It can be found in Extranet under My Data. Every API key starts with 'ak' (default is None).
-            api_key_name (str, optional): Name of the API key stored or to be stored. Can be any string of letters and numbers starting with 'ak', 51 characters long.
-            url (str, optional): URL number.
-            port (int, optional): Port number.
-            ssl (bool, optional): False if NOT using SSL auth. True if using the installed version of SSL certificate, or path to .crt certificate if using a file.
-            ssl_file (str, optional): Path to SSL certificate file (.crt, .pem).
+            api_key_value (str, optional):
+                Value of the API key.
+                It can be found in Extranet under My Data.
+                Every API key starts with 'ak' (default is None).
+            api_key_name (str, optional):
+                Name of the API key stored or to be stored.
+                Can be any string of letters and numbers starting with 'ak', 51 characters long.
+            url (str, optional):
+                URL number.
+            port (int, optional):
+                Port number.
+            ssl (bool, optional):
+                False if NOT using SSL auth.
+                True if using the installed version of SSL certificate, or path to .crt certificate if using a file.
+            ssl_file (str, optional):
+                Path to SSL certificate file (.crt, .pem).
         '''
         self.url = url
         self.port = port
@@ -46,6 +57,7 @@ class Application:
         self.api_key = _ApiKey(api_key_name, api_key_value)
         self.channel = init_channel(self.api_key.value, self.url, self.port, self.ssl, self.ssl_file)
         self.stub = dlubal.api.rfem.application_pb2_grpc.ApplicationStub(self.channel) if self.channel else None
+        self.__check_versions()
 
     def __enter__(self):
         '''
@@ -72,6 +84,33 @@ class Application:
                 return False
             raise RuntimeError(f"Unexpected error: {str(exc_value)}") from None
 
+    def __check_versions(self):
+        '''
+        Check if version of package is compatible with version of RFEM, RSTAB, or RSECTION.
+        '''
+        app_info = self.get_application_info()
+        app_version = app_info.version.split('.')
+        app_major = int(app_version[1])
+        app_minor = int(app_version[2])
+
+        try:
+            dlubal_api_v = version('dlubal.api')
+            dlubal_api_vs = version('dlubal.api').split('.')
+            dlubal_api_major = int(dlubal_api_vs[1])
+            dlubal_api_minor = int(dlubal_api_vs[2])
+        except(ImportError, ModuleNotFoundError):
+            print("dlubal.api version not found.")
+            print("Package is not installed in the current environment.")
+            print("It appears you may be running the application directly from source code.\n")
+            return
+
+        # If the versions differ, print a warning
+        if app_major != dlubal_api_major or app_minor != dlubal_api_minor:
+            print('\033[93mWARNING:\033[0m')
+            print(f'Version mismatch between dlubal.api client package \033[91m{dlubal_api_v}\033[0m and server application {app_info.name}.')
+            print(f'To ensure full compatibility, please use the client version 2.{app_major}.{app_minor}.')
+            print(f'To update, run: \033[92mpython.exe -m pip install --upgrade dlubal.api==2.{app_major}.{app_minor}\033[0m\n')
+
     # Functions using packing
 
     def get_object(self, obj, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
@@ -79,8 +118,11 @@ class Application:
         Retrieves a single object from the model using only the `no` argument in the object arguments.
 
         Args:
-            obj (obj): An object to be retrieved defined by its number. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            obj (obj):
+                An object to be retrieved defined by its number.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             :ref:`rfem_objects`: A retrieved object.
@@ -88,13 +130,16 @@ class Application:
         result = self.stub.get_object_impl(pack_object(obj, model_id))
         return unpack_object(result, type(obj))
 
-    def get_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
+    def get_object_list(self, objs: list, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         '''
         Retrieves a list of objects from the model.
 
         Args:
-            objs (obj): An object dict to be retrieved. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            objs (list[obj]):
+                An object list to be retrieved.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             :ref:`rfem_objects`: A list of retrieved objects.
@@ -110,25 +155,33 @@ class Application:
         Creates a single object in the model.
 
         Args:
-            obj (obj): An object to be created. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            obj (obj):
+                An object to be created.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
            ObjectId: ID of the created object
         '''
         return self.stub.create_object_impl(pack_object(obj, model_id))
 
-    def create_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None, return_object_id=False):
+    def create_object_list(self, objs:list, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None, return_object_id=False):
         '''
         Creates a list of objects in the model.
 
         Args:
-            objs (list[obj]): A list of objects to be created. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
-            return_object_id (bool): Specifies whether to return the list of object IDs.
+            objs (list[obj]):
+                A list of objects to be created.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
+            return_object_id (bool):
+                Specifies whether to return the list of object IDs.
 
         Returns:
-            ObjectIdList (:ref:`ObjectIdList` | None): List of IDs of the created objects if `return_object_id` is True, otherwise None.
+            ObjectIdList (:ref:`ObjectIdList` | None):
+                List of IDs of the created objects if `return_object_id` is True, otherwise None.
         '''
         return self.stub.create_object_list_impl(pack_object_list(objs, model_id, return_object_id))
 
@@ -137,21 +190,27 @@ class Application:
         Updates a single object in the model.
 
         Args:
-            obj (obj): An object to be updated. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            obj (obj):
+                An object to be updated.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             None
         '''
         self.stub.update_object_impl(pack_object(obj, model_id))
 
-    def update_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
+    def update_object_list(self, objs: list, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         '''
         Updates a list of objects in the model.
 
         Args:
-            objs (list[obj]): A list of objects to be updated. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            objs (list[obj]):
+                A list of objects to be updated.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             None
@@ -163,21 +222,27 @@ class Application:
         Deletes a single object from the model.
 
         Args:
-            obj (obj): An object to be deleted defined by its number. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            obj (obj):
+                An object to be deleted defined by its number.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             None
         '''
         self.stub.delete_object_impl(pack_object(obj, model_id))
 
-    def delete_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
+    def delete_object_list(self, objs: list, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         '''
         Deletes a list of objects from the model.
 
         Args:
-            objs (list[obj]): A list of objects to be deleted. Refer to the :ref:`rfem_objects` for available objects.
-            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            objs (list[obj]):
+                A list of objects to be deleted.
+                Refer to the :ref:`rfem_objects` for available objects.
+            model_id (:ref:`ModelId` | None):
+                Unique identifier of the model.
 
         Returns:
             None
@@ -186,16 +251,18 @@ class Application:
 
     def get_results(self, results_id: ResultsId, filters: Iterable[ResultsFilter] | None = None, **keyword_filters):
         '''
-        GetResults returns Table, which is just a convenience wrapper around a Pandas Dataframe.
+        Returns Table, which is just a convenience wrapper around a Pandas Dataframe.
         The Dataframe can be directly accessed as .data
 
         Args:
-            results_id (list[obj]): A list of objects to be deleted. Refer to the :ref:`rfem_objects` for available objects.
-                example: ResultsId.RESULTS_ID_TEST
-            filters (ResultsFilter, optional): Filter to get only relevant results. Valid filter expressions are: "min", "max", ">value", "<value", and just "value" for equality.
-                example: filters=[ResultsFilter(column_id="support_force_p_x", filter_expression="max")]
+            results_id (:ref:`ResultsId` | None):
+                Unique identifier of the result category type.
+            filters (:ref:`ResultsFilter`, optional):
+                Filter to get only relevant results
+
         Returns:
-            Table(data_frame): Requested results in form of table.
+            Table(data_frame):
+                Requested results in form of table.
         '''
         all_filters = [].append(filters) if filters else []
 
@@ -247,6 +314,7 @@ class Application:
 
         Args:
             model_id (dlubal.api.common.model_id_pb2.ModelId | None): Unique identifier of the model
+        Active model is used if this field is not set.
             path (str | None): Path to the model
         """
         request = dlubal.api.rfem.application_pb2.SaveModelAsRequest(model_id=model_id, path=path)
@@ -258,6 +326,7 @@ class Application:
 
         Args:
             model_id (dlubal.api.common.model_id_pb2.ModelId | None): Unique identifier of the model
+        Active model is used if this field is not set.
             save_changes (bool): Specifies whether to save changes before closing the model
         """
         request = dlubal.api.rfem.application_pb2.CloseModelRequest(model_id=model_id, save_changes=save_changes)
@@ -287,7 +356,7 @@ class Application:
         Sets active model specified by model id
 
         Args:
-            model_id (dlubal.api.common.model_id_pb2.ModelId): 
+            model_id (dlubal.api.common.model_id_pb2.ModelId):
         """
         self.stub.set_active_model(model_id)
 
@@ -317,7 +386,7 @@ class Application:
 
     def close_connection(self):
         """
-        Closes connection to Webservice server
+        Closes connection to API server
         """
         self.stub.close_connection(google.protobuf.empty_pb2.Empty())
 
@@ -326,7 +395,7 @@ class Application:
         Deletes all objects
 
         Args:
-            optional_model_id (dlubal.api.common.model_id_pb2.OptionalModelId): 
+            optional_model_id (dlubal.api.common.model_id_pb2.OptionalModelId):
         """
         self.stub.delete_all_objects(optional_model_id)
 
@@ -363,5 +432,33 @@ class Application:
         request = dlubal.api.rfem.application_pb2.PlausibilityCheckRequest(type=type, skip_warnings=skip_warnings, model_id=model_id)
         return self.stub.plausibility_check(request)
 
+    def get_object_id_list(self, *, object_type: dlubal.api.rfem.object_type_pb2.ObjectType | None = None, parent_no: int | None = None, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None) -> dlubal.api.rfem.application_pb2.ObjectIdList:
+        """
+        Retrieves object ids filtered by a specific type.
+        If you want to retrieve all object ids, do not specify the object_type.
+
+        Args:
+            object_type (dlubal.api.rfem.object_type_pb2.ObjectType | None): The type of objects to retrieve. To get all object ids, omit it.
+            parent_no (int | None): Unique identifier of the parent object.
+        Omit this parameter if the object type does not have a parent or you want to get result for all parent objects.
+            model_id (dlubal.api.common.model_id_pb2.ModelId | None): Unique identifier of the model.
+        If not specified, the active model is used.
+
+        Returns:
+            dlubal.api.rfem.application_pb2.ObjectIdList
+        """
+        request = dlubal.api.rfem.application_pb2.GetObjectIdListRequest(object_type=object_type, parent_no=parent_no, model_id=model_id)
+        return self.stub.get_object_id_list(request)
+
     def get_model_main_parameters(self, *, optional_model_id: dlubal.api.common.model_id_pb2.OptionalModelId = dlubal.api.common.model_id_pb2.OptionalModelId()) -> dlubal.api.rfem.application_pb2.ModelMainParameters:
+        """
+        Retrieves the main parameters of a model, including its ID, name, description,
+        comments, file path, and associated project details.
+
+        Args:
+            optional_model_id (dlubal.api.common.model_id_pb2.OptionalModelId):
+
+        Returns:
+            dlubal.api.rfem.application_pb2.ModelMainParameters
+        """
         return self.stub.get_model_main_parameters(optional_model_id)

dlubal_api-2.9.8/dlubal/api/rfem/application_pb2.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: dlubal/api/rfem/application.proto
+# Protobuf Python Version: 5.28.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    28,
+    1,
+    '',
+    'dlubal/api/rfem/application.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import any_pb2 as google_dot_protobuf_dot_any__pb2
+from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
+from dlubal.api.common import model_id_pb2 as dlubal_dot_api_dot_common_dot_model__id__pb2
+from dlubal.api.common import table_data_pb2 as dlubal_dot_api_dot_common_dot_table__data__pb2
+from dlubal.api.rfem import object_type_pb2 as dlubal_dot_api_dot_rfem_dot_object__type__pb2
+from dlubal.api.rfem.results import results_query_pb2 as dlubal_dot_api_dot_rfem_dot_results_dot_results__query__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!dlubal/api/rfem/application.proto\x12\x0f\x64lubal.api.rfem\x1a\x19google/protobuf/any.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a dlubal/api/common/model_id.proto\x1a\"dlubal/api/common/table_data.proto\x1a!dlubal/api/rfem/object_type.proto\x1a+dlubal/api/rfem/results/results_query.proto\"P\n\x12\x43reateModelRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x1a\n\rtemplate_path\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x10\n\x0e_template_path\" \n\x10OpenModelRequest\x12\x0c\n\x04path\x18\x01 \x01(\t\"p\n\x12SaveModelAsRequest\x12\x31\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x12\x11\n\x04path\x18\x02 \x01(\tH\x01\x88\x01\x01\x42\x0b\n\t_model_idB\x07\n\x05_path\"i\n\x11\x43loseModelRequest\x12\x31\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x12\x14\n\x0csave_changes\x18\x02 \x01(\x08\x42\x0b\n\t_model_id\"-\n\x15\x43loseAllModelsRequest\x12\x14\n\x0csave_changes\x18\x01 \x01(\x08\"C\n\tModelInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04guid\x18\x02 \x01(\t\x12\x11\n\x04path\x18\x03 \x01(\tH\x00\x88\x01\x01\x42\x07\n\x05_path\";\n\tModelList\x12.\n\nmodel_info\x18\x01 \x03(\x0b\x32\x1a.dlubal.api.rfem.ModelInfo\"\xcf\x01\n\x0f\x41pplicationInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12.\n\x04type\x18\x02 \x01(\x0e\x32 .dlubal.api.rfem.ApplicationType\x12\x1a\n\x12is_server_instance\x18\x03 \x01(\x08\x12\x0f\n\x07version\x18\x04 \x01(\t\x12\x14\n\x0c\x66ull_version\x18\x05 \x01(\t\x12\x0f\n\x07options\x18\x06 \x01(\t\x12\x15\n\rlanguage_name\x18\x07 \x01(\t\x12\x13\n\x0blanguage_id\x18\x08 \x01(\t\"n\n\x06Object\x12$\n\x06object\x18\x01 \x01(\x0b\x32\x14.google.protobuf.Any\x12\x31\n\x08model_id\x18\x02 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x42\x0b\n\t_model_id\"6\n\nObjectList\x12(\n\x07objects\x18\x01 \x03(\x0b\x32\x17.dlubal.api.rfem.Object\"{\n\x17\x43reateObjectListRequest\x12,\n\x07objects\x18\x01 \x01(\x0b\x32\x1b.dlubal.api.rfem.ObjectList\x12\x1d\n\x10return_object_id\x18\x02 \x01(\x08H\x00\x88\x01\x01\x42\x13\n\x11_return_object_id\"\xc3\x01\n\x08ObjectId\x12\n\n\x02no\x18\x01 \x01(\x05\x12\x30\n\x0bobject_type\x18\x02 \x01(\x0e\x32\x1b.dlubal.api.rfem.ObjectType\x12\x16\n\tparent_no\x18\x03 \x01(\x05H\x00\x88\x01\x01\x12<\n\x12parent_object_type\x18\x04 \x01(\x0e\x32\x1b.dlubal.api.rfem.ObjectTypeH\x01\x88\x01\x01\x42\x0c\n\n_parent_noB\x15\n\x13_parent_object_type\"<\n\x0cObjectIdList\x12,\n\tobject_id\x18\x01 \x03(\x0b\x32\x19.dlubal.api.rfem.ObjectId\"l\n\x13\x43\x61lculateAllRequest\x12\x15\n\rskip_warnings\x18\x01 \x01(\x08\x12\x31\n\x08model_id\x18\x02 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x42\x0b\n\t_model_id\"b\n\x0fOperationResult\x12\x11\n\tsucceeded\x18\x01 \x01(\x08\x12\x11\n\x04\x64\x61ta\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x14\n\x07message\x18\x03 \x01(\tH\x01\x88\x01\x01\x42\x07\n\x05_dataB\n\n\x08_message\"\xa7\x01\n\x18PlausibilityCheckRequest\x12\x34\n\x04type\x18\x01 \x01(\x0e\x32&.dlubal.api.rfem.PlausibilityCheckType\x12\x15\n\rskip_warnings\x18\x02 \x01(\x08\x12\x31\n\x08model_id\x18\x03 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x42\x0b\n\t_model_id\"\xe0\x01\n\x13ModelMainParameters\x12\x10\n\x08model_id\x18\x01 \x01(\t\x12\x12\n\nmodel_name\x18\x02 \x01(\t\x12\x19\n\x11model_description\x18\x03 \x01(\t\x12\x15\n\rmodel_comment\x18\x04 \x01(\t\x12\x12\n\nmodel_path\x18\x05 \x01(\t\x12\x12\n\nproject_id\x18\x06 \x01(\t\x12\x14\n\x0cproject_name\x18\x07 \x01(\t\x12\x1b\n\x13project_description\x18\x08 \x01(\t\x12\x16\n\x0eproject_folder\x18\t \x01(\t\"\xc5\x01\n\x16GetObjectIdListRequest\x12\x35\n\x0bobject_type\x18\x01 \x01(\x0e\x32\x1b.dlubal.api.rfem.ObjectTypeH\x00\x88\x01\x01\x12\x16\n\tparent_no\x18\x02 \x01(\x05H\x01\x88\x01\x01\x12\x31\n\x08model_id\x18\x03 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x02\x88\x01\x01\x42\x0e\n\x0c_object_typeB\x0c\n\n_parent_noB\x0b\n\t_model_id*\xf1\x01\n\x0f\x41pplicationType\x12\x1b\n\x17\x41PPLICATION_UNSPECIFIED\x10\x00\x12\x1d\n\x19\x41PPLICATION_DLUBAL_CENTER\x10\x01\x12\x1d\n\x19\x41PPLICATION_REPORT_VIEWER\x10\x02\x12\x14\n\x10\x41PPLICATION_RFEM\x10\x03\x12\x15\n\x11\x41PPLICATION_RSTAB\x10\x04\x12\x18\n\x14\x41PPLICATION_RSECTION\x10\x05\x12\x1c\n\x18\x41PPLICATION_WEB_SECTIONS\x10\x06\x12\x1e\n\x1a\x41PPLICATION_CRASH_REPORTER\x10\x07*\xd3\x01\n\x15PlausibilityCheckType\x12\"\n\x1ePLAUSIBILITY_CHECK_UNSPECIFIED\x10\x00\x12%\n!PLAUSIBILITY_CHECK_MESH_GENERATOR\x10\x01\x12\"\n\x1ePLAUSIBILITY_CHECK_CALCULATION\x10\x02\x12)\n%PLAUSIBILITY_CHECK_PLAUSIBILITY_CHECK\x10\x03\x12 \n\x1cPLAUSIBILITY_CHECK_PART_LIST\x10\x04\x32\x97\x10\n\x0b\x41pplication\x12Q\n\x0c\x63reate_model\x12#.dlubal.api.rfem.CreateModelRequest\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12M\n\nopen_model\x12!.dlubal.api.rfem.OpenModelRequest\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12K\n\nsave_model\x12#.dlubal.api.rfem.SaveModelAsRequest\x1a\x16.google.protobuf.Empty\"\x00\x12K\n\x0b\x63lose_model\x12\".dlubal.api.rfem.CloseModelRequest\x1a\x16.google.protobuf.Empty\"\x00\x12T\n\x10\x63lose_all_models\x12&.dlubal.api.rfem.CloseAllModelsRequest\x1a\x16.google.protobuf.Empty\"\x00\x12H\n\x10get_active_model\x12\x16.google.protobuf.Empty\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12H\n\x10set_active_model\x12\x1a.dlubal.api.common.ModelId\x1a\x16.google.protobuf.Empty\"\x00\x12\x45\n\x11\x63lose_application\x12\x16.google.protobuf.Empty\x1a\x16.google.protobuf.Empty\"\x00\x12\x46\n\x0eget_model_list\x12\x16.google.protobuf.Empty\x1a\x1a.dlubal.api.rfem.ModelList\"\x00\x12R\n\x14get_application_info\x12\x16.google.protobuf.Empty\x1a .dlubal.api.rfem.ApplicationInfo\"\x00\x12\x44\n\x10\x63lose_connection\x12\x16.google.protobuf.Empty\x1a\x16.google.protobuf.Empty\"\x00\x12\x45\n\x0fget_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x17.dlubal.api.rfem.Object\"\x00\x12R\n\x14get_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x1b.dlubal.api.rfem.ObjectList\"\x00\x12J\n\x12\x63reate_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x19.dlubal.api.rfem.ObjectId\"\x00\x12\x64\n\x17\x63reate_object_list_impl\x12(.dlubal.api.rfem.CreateObjectListRequest\x1a\x1d.dlubal.api.rfem.ObjectIdList\"\x00\x12G\n\x12update_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x16.google.protobuf.Empty\"\x00\x12P\n\x17update_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x16.google.protobuf.Empty\"\x00\x12G\n\x12\x64\x65lete_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x16.google.protobuf.Empty\"\x00\x12P\n\x17\x64\x65lete_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x16.google.protobuf.Empty\"\x00\x12R\n\x12\x64\x65lete_all_objects\x12\".dlubal.api.common.OptionalModelId\x1a\x16.google.protobuf.Empty\"\x00\x12Y\n\rcalculate_all\x12$.dlubal.api.rfem.CalculateAllRequest\x1a .dlubal.api.rfem.OperationResult\"\x00\x12Y\n\x10get_results_impl\x12%.dlubal.api.rfem.results.ResultsQuery\x1a\x1c.dlubal.api.common.TableData\"\x00\x12\x63\n\x12plausibility_check\x12).dlubal.api.rfem.PlausibilityCheckRequest\x1a .dlubal.api.rfem.OperationResult\"\x00\x12^\n\x12get_object_id_list\x12\'.dlubal.api.rfem.GetObjectIdListRequest\x1a\x1d.dlubal.api.rfem.ObjectIdList\"\x00\x12g\n\x19get_model_main_parameters\x12\".dlubal.api.common.OptionalModelId\x1a$.dlubal.api.rfem.ModelMainParameters\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rfem.application_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_APPLICATIONTYPE']._serialized_start=2345
+  _globals['_APPLICATIONTYPE']._serialized_end=2586
+  _globals['_PLAUSIBILITYCHECKTYPE']._serialized_start=2589
+  _globals['_PLAUSIBILITYCHECKTYPE']._serialized_end=2800
+  _globals['_CREATEMODELREQUEST']._serialized_start=260
+  _globals['_CREATEMODELREQUEST']._serialized_end=340
+  _globals['_OPENMODELREQUEST']._serialized_start=342
+  _globals['_OPENMODELREQUEST']._serialized_end=374
+  _globals['_SAVEMODELASREQUEST']._serialized_start=376
+  _globals['_SAVEMODELASREQUEST']._serialized_end=488
+  _globals['_CLOSEMODELREQUEST']._serialized_start=490
+  _globals['_CLOSEMODELREQUEST']._serialized_end=595
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_start=597
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_end=642
+  _globals['_MODELINFO']._serialized_start=644
+  _globals['_MODELINFO']._serialized_end=711
+  _globals['_MODELLIST']._serialized_start=713
+  _globals['_MODELLIST']._serialized_end=772
+  _globals['_APPLICATIONINFO']._serialized_start=775
+  _globals['_APPLICATIONINFO']._serialized_end=982
+  _globals['_OBJECT']._serialized_start=984
+  _globals['_OBJECT']._serialized_end=1094
+  _globals['_OBJECTLIST']._serialized_start=1096
+  _globals['_OBJECTLIST']._serialized_end=1150
+  _globals['_CREATEOBJECTLISTREQUEST']._serialized_start=1152
+  _globals['_CREATEOBJECTLISTREQUEST']._serialized_end=1275
+  _globals['_OBJECTID']._serialized_start=1278
+  _globals['_OBJECTID']._serialized_end=1473
+  _globals['_OBJECTIDLIST']._serialized_start=1475
+  _globals['_OBJECTIDLIST']._serialized_end=1535
+  _globals['_CALCULATEALLREQUEST']._serialized_start=1537
+  _globals['_CALCULATEALLREQUEST']._serialized_end=1645
+  _globals['_OPERATIONRESULT']._serialized_start=1647
+  _globals['_OPERATIONRESULT']._serialized_end=1745
+  _globals['_PLAUSIBILITYCHECKREQUEST']._serialized_start=1748
+  _globals['_PLAUSIBILITYCHECKREQUEST']._serialized_end=1915
+  _globals['_MODELMAINPARAMETERS']._serialized_start=1918
+  _globals['_MODELMAINPARAMETERS']._serialized_end=2142
+  _globals['_GETOBJECTIDLISTREQUEST']._serialized_start=2145
+  _globals['_GETOBJECTIDLISTREQUEST']._serialized_end=2342
+  _globals['_APPLICATION']._serialized_start=2803
+  _globals['_APPLICATION']._serialized_end=4874
+# @@protoc_insertion_point(module_scope)

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/dlubal/api/rfem/application_pb2.pyi

@@ -205,3 +205,13 @@ class ModelMainParameters(_message.Message):
     project_description: str
     project_folder: str
     def __init__(self, model_id: _Optional[str] = ..., model_name: _Optional[str] = ..., model_description: _Optional[str] = ..., model_comment: _Optional[str] = ..., model_path: _Optional[str] = ..., project_id: _Optional[str] = ..., project_name: _Optional[str] = ..., project_description: _Optional[str] = ..., project_folder: _Optional[str] = ...) -> None: ...
+
+class GetObjectIdListRequest(_message.Message):
+    __slots__ = ("object_type", "parent_no", "model_id")
+    OBJECT_TYPE_FIELD_NUMBER: _ClassVar[int]
+    PARENT_NO_FIELD_NUMBER: _ClassVar[int]
+    MODEL_ID_FIELD_NUMBER: _ClassVar[int]
+    object_type: _object_type_pb2.ObjectType
+    parent_no: int
+    model_id: _model_id_pb2.ModelId
+    def __init__(self, object_type: _Optional[_Union[_object_type_pb2.ObjectType, str]] = ..., parent_no: _Optional[int] = ..., model_id: _Optional[_Union[_model_id_pb2.ModelId, _Mapping]] = ...) -> None: ...

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/dlubal/api/rfem/application_pb2_grpc.py

@@ -153,6 +153,11 @@ class ApplicationStub(object):
                 request_serializer=dlubal_dot_api_dot_rfem_dot_application__pb2.PlausibilityCheckRequest.SerializeToString,
                 response_deserializer=dlubal_dot_api_dot_rfem_dot_application__pb2.OperationResult.FromString,
                 _registered_method=True)
+        self.get_object_id_list = channel.unary_unary(
+                '/dlubal.api.rfem.Application/get_object_id_list',
+                request_serializer=dlubal_dot_api_dot_rfem_dot_application__pb2.GetObjectIdListRequest.SerializeToString,
+                response_deserializer=dlubal_dot_api_dot_rfem_dot_application__pb2.ObjectIdList.FromString,
+                _registered_method=True)
         self.get_model_main_parameters = channel.unary_unary(
                 '/dlubal.api.rfem.Application/get_model_main_parameters',
                 request_serializer=dlubal_dot_api_dot_common_dot_model__id__pb2.OptionalModelId.SerializeToString,
@@ -236,7 +241,7 @@ class ApplicationServicer(object):
         raise NotImplementedError('Method not implemented!')
 
     def close_connection(self, request, context):
-        """Closes connection to Webservice server
+        """Closes connection to API server
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -319,8 +324,18 @@ class ApplicationServicer(object):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def get_object_id_list(self, request, context):
+        """Retrieves object ids filtered by a specific type.
+        If you want to retrieve all object ids, do not specify the object_type.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
     def get_model_main_parameters(self, request, context):
-        """Missing associated documentation comment in .proto file."""
+        """Retrieves the main parameters of a model, including its ID, name, description,
+        comments, file path, and associated project details.
+        """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
@@ -443,6 +458,11 @@ def add_ApplicationServicer_to_server(servicer, server):
                     request_deserializer=dlubal_dot_api_dot_rfem_dot_application__pb2.PlausibilityCheckRequest.FromString,
                     response_serializer=dlubal_dot_api_dot_rfem_dot_application__pb2.OperationResult.SerializeToString,
             ),
+            'get_object_id_list': grpc.unary_unary_rpc_method_handler(
+                    servicer.get_object_id_list,
+                    request_deserializer=dlubal_dot_api_dot_rfem_dot_application__pb2.GetObjectIdListRequest.FromString,
+                    response_serializer=dlubal_dot_api_dot_rfem_dot_application__pb2.ObjectIdList.SerializeToString,
+            ),
             'get_model_main_parameters': grpc.unary_unary_rpc_method_handler(
                     servicer.get_model_main_parameters,
                     request_deserializer=dlubal_dot_api_dot_common_dot_model__id__pb2.OptionalModelId.FromString,
@@ -1080,6 +1100,33 @@ class Application(object):
             metadata,
             _registered_method=True)
 
+    @staticmethod
+    def get_object_id_list(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/dlubal.api.rfem.Application/get_object_id_list',
+            dlubal_dot_api_dot_rfem_dot_application__pb2.GetObjectIdListRequest.SerializeToString,
+            dlubal_dot_api_dot_rfem_dot_application__pb2.ObjectIdList.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
     @staticmethod
     def get_model_main_parameters(request,
             target,

dlubal_api-2.9.8/dlubal/api/rfem/base_data/terrain_pb2.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: dlubal/api/rfem/base_data/terrain.proto
+# Protobuf Python Version: 5.28.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    28,
+    1,
+    '',
+    'dlubal/api/rfem/base_data/terrain.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'dlubal/api/rfem/base_data/terrain.proto\x12\x19\x64lubal.api.rfem.base_data\"\xc3\x05\n\x07Terrain\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x39\n\x04type\x18\x02 \x01(\x0e\x32&.dlubal.api.rfem.base_data.TerrainTypeH\x01\x88\x01\x01\x12\x14\n\x07\x63omment\x18\x03 \x01(\tH\x02\x88\x01\x01\x12\"\n\x15\x62ounding_box_offset_x\x18\x04 \x01(\x01H\x03\x88\x01\x01\x12\"\n\x15\x62ounding_box_offset_y\x18\x05 \x01(\x01H\x04\x88\x01\x01\x12 \n\x13\x63\x65nter_of_terrain_z\x18\x06 \x01(\x01H\x05\x88\x01\x01\x12\x1e\n\x11rotation_around_Z\x18\x07 \x01(\x01H\x06\x88\x01\x01\x12\x1f\n\x12\x63onsider_boreholes\x18\x08 \x01(\x08H\x07\x88\x01\x01\x12\x1e\n\x11\x63oordinate_system\x18\t \x01(\x05H\x08\x88\x01\x01\x12J\n\rterrain_table\x18\n \x01(\x0b\x32..dlubal.api.rfem.base_data.TerrainTerrainTableH\t\x88\x01\x01\x12!\n\x14id_for_export_import\x18\x0b \x01(\tH\n\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\x0c \x01(\tH\x0b\x88\x01\x01\x42\x05\n\x03_noB\x07\n\x05_typeB\n\n\x08_commentB\x18\n\x16_bounding_box_offset_xB\x18\n\x16_bounding_box_offset_yB\x16\n\x14_center_of_terrain_zB\x14\n\x12_rotation_around_ZB\x15\n\x13_consider_boreholesB\x14\n\x12_coordinate_systemB\x10\n\x0e_terrain_tableB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_import\"V\n\x13TerrainTerrainTable\x12?\n\x04rows\x18\x01 \x03(\x0b\x32\x31.dlubal.api.rfem.base_data.TerrainTerrainTableRow\"\xc6\x01\n\x16TerrainTerrainTableRow\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x18\n\x0b\x64\x65scription\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x15\n\x08global_x\x18\x03 \x01(\x01H\x02\x88\x01\x01\x12\x15\n\x08global_y\x18\x04 \x01(\x01H\x03\x88\x01\x01\x12\x15\n\x08global_z\x18\x05 \x01(\x01H\x04\x88\x01\x01\x42\x05\n\x03_noB\x0e\n\x0c_descriptionB\x0b\n\t_global_xB\x0b\n\t_global_yB\x0b\n\t_global_z*\xbc\x01\n\x0bTerrainType\x12\x18\n\x14TERRAIN_TYPE_UNKNOWN\x10\x00\x12\x1a\n\x16TERRAIN_TYPE_BOREHOLES\x10\x05\x12!\n\x1dTERRAIN_TYPE_HORIZONTAL_PLANE\x10\x02\x12\x1f\n\x1bTERRAIN_TYPE_INCLINED_PLANE\x10\x03\x12\x1b\n\x17TERRAIN_TYPE_NO_TERRAIN\x10\x01\x12\x16\n\x12TERRAIN_TYPE_TABLE\x10\x04\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rfem.base_data.terrain_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_TERRAINTYPE']._serialized_start=1070
+  _globals['_TERRAINTYPE']._serialized_end=1258
+  _globals['_TERRAIN']._serialized_start=71
+  _globals['_TERRAIN']._serialized_end=778
+  _globals['_TERRAINTERRAINTABLE']._serialized_start=780
+  _globals['_TERRAINTERRAINTABLE']._serialized_end=866
+  _globals['_TERRAINTERRAINTABLEROW']._serialized_start=869
+  _globals['_TERRAINTERRAINTABLEROW']._serialized_end=1067
+# @@protoc_insertion_point(module_scope)

{dlubal_api-2.9.7.dev1 → dlubal_api-2.9.8}/dlubal/api/rfem/base_data/terrain_pb2.pyi

@@ -1,7 +1,8 @@
+from google.protobuf.internal import containers as _containers
 from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import message as _message
-from typing import ClassVar as _ClassVar, Mapping as _Mapping, Optional as _Optional, Union as _Union
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
 
 DESCRIPTOR: _descriptor.FileDescriptor
 
@@ -43,11 +44,27 @@ class Terrain(_message.Message):
     rotation_around_Z: float
     consider_boreholes: bool
     coordinate_system: int
-    terrain_table: ArrayOfTerrainTerrainTable
+    terrain_table: TerrainTerrainTable
     id_for_export_import: str
     metadata_for_export_import: str
-    def __init__(self, no: _Optional[int] = ..., type: _Optional[_Union[TerrainType, str]] = ..., comment: _Optional[str] = ..., bounding_box_offset_x: _Optional[float] = ..., bounding_box_offset_y: _Optional[float] = ..., center_of_terrain_z: _Optional[float] = ..., rotation_around_Z: _Optional[float] = ..., consider_boreholes: bool = ..., coordinate_system: _Optional[int] = ..., terrain_table: _Optional[_Union[ArrayOfTerrainTerrainTable, _Mapping]] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...
+    def __init__(self, no: _Optional[int] = ..., type: _Optional[_Union[TerrainType, str]] = ..., comment: _Optional[str] = ..., bounding_box_offset_x: _Optional[float] = ..., bounding_box_offset_y: _Optional[float] = ..., center_of_terrain_z: _Optional[float] = ..., rotation_around_Z: _Optional[float] = ..., consider_boreholes: bool = ..., coordinate_system: _Optional[int] = ..., terrain_table: _Optional[_Union[TerrainTerrainTable, _Mapping]] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...
 
-class ArrayOfTerrainTerrainTable(_message.Message):
-    __slots__ = ()
-    def __init__(self) -> None: ...
+class TerrainTerrainTable(_message.Message):
+    __slots__ = ("rows",)
+    ROWS_FIELD_NUMBER: _ClassVar[int]
+    rows: _containers.RepeatedCompositeFieldContainer[TerrainTerrainTableRow]
+    def __init__(self, rows: _Optional[_Iterable[_Union[TerrainTerrainTableRow, _Mapping]]] = ...) -> None: ...
+
+class TerrainTerrainTableRow(_message.Message):
+    __slots__ = ("no", "description", "global_x", "global_y", "global_z")
+    NO_FIELD_NUMBER: _ClassVar[int]
+    DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
+    GLOBAL_X_FIELD_NUMBER: _ClassVar[int]
+    GLOBAL_Y_FIELD_NUMBER: _ClassVar[int]
+    GLOBAL_Z_FIELD_NUMBER: _ClassVar[int]
+    no: int
+    description: str
+    global_x: float
+    global_y: float
+    global_z: float
+    def __init__(self, no: _Optional[int] = ..., description: _Optional[str] = ..., global_x: _Optional[float] = ..., global_y: _Optional[float] = ..., global_z: _Optional[float] = ...) -> None: ...