dlubal.api 0.1.293714a1__py3-none-any.whl

dlubal/api/rfem/aluminum_design_objects/aluminum_design_uls_configuration_pb2.pyi

@@ -0,0 +1,30 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Optional as _Optional
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class AluminumDesignUlsConfiguration(_message.Message):
+    __slots__ = ("no", "user_defined_name_enabled", "name", "assigned_to_all_members", "assigned_to_members", "assigned_to_all_member_sets", "assigned_to_member_sets", "comment", "id_for_export_import", "metadata_for_export_import")
+    NO_FIELD_NUMBER: _ClassVar[int]
+    USER_DEFINED_NAME_ENABLED_FIELD_NUMBER: _ClassVar[int]
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_TO_ALL_MEMBERS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_TO_MEMBERS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_TO_ALL_MEMBER_SETS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_TO_MEMBER_SETS_FIELD_NUMBER: _ClassVar[int]
+    COMMENT_FIELD_NUMBER: _ClassVar[int]
+    ID_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    METADATA_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    no: int
+    user_defined_name_enabled: bool
+    name: str
+    assigned_to_all_members: bool
+    assigned_to_members: _containers.RepeatedScalarFieldContainer[int]
+    assigned_to_all_member_sets: bool
+    assigned_to_member_sets: _containers.RepeatedScalarFieldContainer[int]
+    comment: str
+    id_for_export_import: str
+    metadata_for_export_import: str
+    def __init__(self, no: _Optional[int] = ..., user_defined_name_enabled: bool = ..., name: _Optional[str] = ..., assigned_to_all_members: bool = ..., assigned_to_members: _Optional[_Iterable[int]] = ..., assigned_to_all_member_sets: bool = ..., assigned_to_member_sets: _Optional[_Iterable[int]] = ..., comment: _Optional[str] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...

dlubal/api/rfem/application.py

@@ -0,0 +1,290 @@
+# Autogenerated code. DO NOT EDIT. Manual code can be added to the corresponding .template.py file.
+
+import dlubal.api.common.model_id_pb2
+import dlubal.api.rfem.application_pb2
+import dlubal.api.rfem.application_pb2_grpc
+import google.protobuf.empty_pb2
+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
+from dlubal.api.rfem.results.results_query_pb2 import ResultsQuery, ResultsFilter
+
+from collections.abc import Iterable
+from pandas import DataFrame
+
+
+class Application:
+
+    def __init__(self,
+                 api_key_value=None,
+                 api_key_name=None,
+                 url='127.0.0.1',
+                 port='9000',
+                 ssl=False,
+                 ssl_file=''):
+        '''
+        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).
+        '''
+        self.url = url
+        self.port = port
+        check_ssl(ssl, ssl_file)
+        self.ssl = ssl
+        self.ssl_file = ssl_file
+        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
+
+    def __enter__(self):
+        '''
+        Start a session by entering the context manager
+        '''
+        return self
+
+    def __exit__(self, exc, value, traceback):
+        '''
+        Ensure the session is finished and channel is closed properly
+        '''
+        self.close_connection()
+
+        # Exception handler
+        if traceback or value:
+            exception_handler(exc, value, traceback)
+
+            dash = '-'
+            print(f'URL: {self.url if self.url else dash}, port: {self.port if self.port else dash}')
+            print(f'API key: {"..."+self.api_key.value[-6:] if self.api_key.value else dash}')
+            if self.ssl:
+                if self.ssl_file:
+                    print(f'SSL certificate: {self.ssl_file}')
+                else:
+                    print('SSL certificate: installed certificate (Windows Certification Store)')
+        else:
+            # Don't put any lines to indicate successfull termination.
+            # read: https://www.joelonsoftware.com/2000/04/26/designing-for-people-who-have-better-things-to-do-with-their-lives/
+            pass
+
+        return True
+
+    # Functions using packing
+    def get_object(self, obj, model_id=None):
+        '''
+        Retrieves a single object from the model using only the `no` argument in the object arguments.
+
+        Args:
+            obj (obj): An object to be retrieved. Refer to the :ref:`object-types` for available objects.
+            model_id (str, optional): Model ID specifies the model to be modified.
+
+        Returns:
+            :ref:`object-types`: A retrieved object.
+        '''
+        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=None):
+        '''
+        Retrieves a list of objects from the model
+        '''
+        result = self.stub.get_object_list_impl(pack_object_list(objs, model_id))
+        return unpack_object_list(result, type(objs[0]))
+
+    def create_object(self, obj, model_id=None):
+        '''
+        Creates a single object in the model.
+
+        Args:
+            obj (obj): An object to be created. Refer to the :ref:`object-types` for available objects.
+            model_id (str, optional): Model ID specifies the model to be modified.
+
+        Returns:
+            None
+        '''
+        self.stub.create_object_impl(pack_object(obj, model_id))
+
+    def create_object_list(self, objs, model_id=None):
+        '''
+        Creates a list of objects in the model.
+
+        Args:
+            objs (list[obj]): A list of objects to be created. Refer to the :ref:`object-types` for available objects.
+            model_id (str, optional): Model ID specifies the model to be modified.
+
+        Returns:
+            None
+        '''
+        self.stub.create_object_list_impl(pack_object_list(objs, model_id))
+
+    def update_object(self, obj, model_id=None):
+        '''
+        Updates a single object in the model
+        '''
+        self.stub.update_object_impl(pack_object(obj, model_id))
+
+    def update_object_list(self, objs, model_id=None):
+        '''
+        Updates a list of objects in the model
+        '''
+        self.stub.update_object_list_impl(pack_object_list(objs, model_id))
+
+    def delete_object(self, obj, model_id=None):
+        '''
+        Deletes a single object from the model.
+
+        Args:
+            obj (obj): An object to be deleted. Refer to the :ref:`object-types` for available objects.
+            model_id (str, optional): Model ID specifies the model to be modified.
+
+        Returns:
+            None
+        '''
+        self.stub.delete_object_impl(pack_object(obj, model_id))
+
+    def delete_object_list(self, objs, model_id=None):
+        '''
+        Deletes a list of objects from the model.
+
+        Args:
+            objs (list[obj]): A list of objects to be deleted. Refer to the :ref:`object-types` for available objects.
+            model_id (str, optional): Model ID specifies the model to be modified.
+
+        Returns:
+            None
+        '''
+        self.stub.delete_object_list_impl(pack_object_list(objs, model_id))
+
+    def get_results(self, results_id: ResultsId, filters: Iterable[ResultsFilter] | None = None, **keyword_filters):
+        '''
+        Get results from result tables
+        '''
+        all_filters = [].append(filters) if filters else []
+
+        for key, value in keyword_filters.items():
+            all_filters.append(ResultsFilter(column_id=key, filter_expression=str(value)))
+
+        results: TableData = self.stub.get_results_impl(ResultsQuery(results_id=results_id, filters=filters))
+
+        rows_data = []
+        for row in results.rows:
+            rows_data.append([get_internal_value(v) for v in row.values])
+
+        data_frame = DataFrame(columns=list(results.column_ids), data=rows_data)
+
+        return Table(data_frame)
+
+    def create_model(self, *, name: str, template_path: str | None = None) -> dlubal.api.common.model_id_pb2.ModelId:
+        """
+        Creates new model with the name specified in request.
+        Returns model id of created model
+
+        Args:
+            name (str): Name of the new model
+            template_path (str | None): Path to the existing template to be opened
+
+        Returns:
+            dlubal.api.common.model_id_pb2.ModelId
+        """
+        request = dlubal.api.rfem.application_pb2.CreateModelRequest(name=name, template_path=template_path)
+        return self.stub.create_model(request)
+
+    def open_model(self, *, path: str) -> dlubal.api.common.model_id_pb2.ModelId:
+        """
+        Opens model from path specified in 'name' field of the request
+        Returns model id of opened model
+
+        Args:
+            path (str): Path to the existing model to be opened
+
+        Returns:
+            dlubal.api.common.model_id_pb2.ModelId
+        """
+        request = dlubal.api.rfem.application_pb2.OpenModelRequest(path=path)
+        return self.stub.open_model(request)
+
+    def save_model(self, *, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None, path: str | None = None):
+        """
+        Saves model specified by model id to optional specified path
+
+        Args:
+            model_id (dlubal.api.common.model_id_pb2.ModelId | None): Unique identifier of the model
+            path (str | None): Path to the model
+        """
+        request = dlubal.api.rfem.application_pb2.SaveModelAsRequest(model_id=model_id, path=path)
+        self.stub.save_model(request)
+
+    def close_model(self, *, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None, save_changes: bool):
+        """
+        Closes model specified by model id
+
+        Args:
+            model_id (dlubal.api.common.model_id_pb2.ModelId | None): Unique identifier of the model
+            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)
+        self.stub.close_model(request)
+
+    def close_all_models(self, *, save_changes: bool):
+        """
+        Closes all open models
+
+        Args:
+            save_changes (bool): Specifies whether to save changes before closing the models
+        """
+        request = dlubal.api.rfem.application_pb2.CloseAllModelsRequest(save_changes=save_changes)
+        self.stub.close_all_models(request)
+
+    def get_active_model(self) -> dlubal.api.common.model_id_pb2.ModelId:
+        """
+        Returns model id of an active model
+
+        Returns:
+            dlubal.api.common.model_id_pb2.ModelId
+        """
+        return self.stub.get_active_model(google.protobuf.empty_pb2.Empty())
+
+    def close_application(self):
+        """
+        Closes the whole application
+        """
+        self.stub.close_application(google.protobuf.empty_pb2.Empty())
+
+    def get_model_list(self) -> dlubal.api.rfem.application_pb2.ModelList:
+        """
+        Returns list of models and information about them
+
+        Returns:
+            dlubal.api.rfem.application_pb2.ModelList
+        """
+        return self.stub.get_model_list(google.protobuf.empty_pb2.Empty())
+
+    def get_application_info(self) -> dlubal.api.rfem.application_pb2.ApplicationInfo:
+        """
+        Returns information about the application
+
+        Returns:
+            dlubal.api.rfem.application_pb2.ApplicationInfo
+        """
+        return self.stub.get_application_info(google.protobuf.empty_pb2.Empty())
+
+    def close_connection(self):
+        """
+        Closes connection to Webservice server
+        """
+        self.stub.close_connection(google.protobuf.empty_pb2.Empty())
+
+    def delete_all_objects(self, *, id: str | None = None):
+        request = dlubal.api.common.model_id_pb2.OptionalModelId(id=id)
+        self.stub.delete_all_objects(request)
+
+    def calculate_all(self, *, skip_warnings: bool, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None) -> dlubal.api.rfem.application_pb2.OperationResult:
+        request = dlubal.api.rfem.application_pb2.CalculateAllRequest(skip_warnings=skip_warnings, model_id=model_id)
+        return self.stub.calculate_all(request)

dlubal/api/rfem/application_pb2.py

@@ -0,0 +1,67 @@
+# -*- 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.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/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\"^\n\x12SaveModelAsRequest\x12,\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelId\x12\x11\n\x04path\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x07\n\x05_path\"W\n\x11\x43loseModelRequest\x12,\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelId\x12\x14\n\x0csave_changes\x18\x02 \x01(\x08\"-\n\x15\x43loseAllModelsRequest\x12\x14\n\x0csave_changes\x18\x01 \x01(\x08\"A\n\tModelInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\n\n\x02id\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\"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*\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\x32\x88\r\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\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\x12G\n\x12\x63reate_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x16.google.protobuf.Empty\"\x00\x12P\n\x17\x63reate_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x16.google.protobuf.Empty\"\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\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=1290
+  _globals['_APPLICATIONTYPE']._serialized_end=1531
+  _globals['_CREATEMODELREQUEST']._serialized_start=225
+  _globals['_CREATEMODELREQUEST']._serialized_end=305
+  _globals['_OPENMODELREQUEST']._serialized_start=307
+  _globals['_OPENMODELREQUEST']._serialized_end=339
+  _globals['_SAVEMODELASREQUEST']._serialized_start=341
+  _globals['_SAVEMODELASREQUEST']._serialized_end=435
+  _globals['_CLOSEMODELREQUEST']._serialized_start=437
+  _globals['_CLOSEMODELREQUEST']._serialized_end=524
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_start=526
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_end=571
+  _globals['_MODELINFO']._serialized_start=573
+  _globals['_MODELINFO']._serialized_end=638
+  _globals['_MODELLIST']._serialized_start=640
+  _globals['_MODELLIST']._serialized_end=699
+  _globals['_APPLICATIONINFO']._serialized_start=702
+  _globals['_APPLICATIONINFO']._serialized_end=909
+  _globals['_OBJECT']._serialized_start=911
+  _globals['_OBJECT']._serialized_end=1021
+  _globals['_OBJECTLIST']._serialized_start=1023
+  _globals['_OBJECTLIST']._serialized_end=1077
+  _globals['_CALCULATEALLREQUEST']._serialized_start=1079
+  _globals['_CALCULATEALLREQUEST']._serialized_end=1187
+  _globals['_OPERATIONRESULT']._serialized_start=1189
+  _globals['_OPERATIONRESULT']._serialized_end=1287
+  _globals['_APPLICATION']._serialized_start=1534
+  _globals['_APPLICATION']._serialized_end=3206
+# @@protoc_insertion_point(module_scope)

dlubal/api/rfem/application_pb2.pyi

@@ -0,0 +1,135 @@
+from google.protobuf import any_pb2 as _any_pb2
+from google.protobuf import empty_pb2 as _empty_pb2
+from dlubal.api.common import model_id_pb2 as _model_id_pb2
+from dlubal.api.common import table_data_pb2 as _table_data_pb2
+from dlubal.api.rfem.results import results_query_pb2 as _results_query_pb2
+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, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ApplicationType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    APPLICATION_UNSPECIFIED: _ClassVar[ApplicationType]
+    APPLICATION_DLUBAL_CENTER: _ClassVar[ApplicationType]
+    APPLICATION_REPORT_VIEWER: _ClassVar[ApplicationType]
+    APPLICATION_RFEM: _ClassVar[ApplicationType]
+    APPLICATION_RSTAB: _ClassVar[ApplicationType]
+    APPLICATION_RSECTION: _ClassVar[ApplicationType]
+    APPLICATION_WEB_SECTIONS: _ClassVar[ApplicationType]
+    APPLICATION_CRASH_REPORTER: _ClassVar[ApplicationType]
+APPLICATION_UNSPECIFIED: ApplicationType
+APPLICATION_DLUBAL_CENTER: ApplicationType
+APPLICATION_REPORT_VIEWER: ApplicationType
+APPLICATION_RFEM: ApplicationType
+APPLICATION_RSTAB: ApplicationType
+APPLICATION_RSECTION: ApplicationType
+APPLICATION_WEB_SECTIONS: ApplicationType
+APPLICATION_CRASH_REPORTER: ApplicationType
+
+class CreateModelRequest(_message.Message):
+    __slots__ = ("name", "template_path")
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    TEMPLATE_PATH_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    template_path: str
+    def __init__(self, name: _Optional[str] = ..., template_path: _Optional[str] = ...) -> None: ...
+
+class OpenModelRequest(_message.Message):
+    __slots__ = ("path",)
+    PATH_FIELD_NUMBER: _ClassVar[int]
+    path: str
+    def __init__(self, path: _Optional[str] = ...) -> None: ...
+
+class SaveModelAsRequest(_message.Message):
+    __slots__ = ("model_id", "path")
+    MODEL_ID_FIELD_NUMBER: _ClassVar[int]
+    PATH_FIELD_NUMBER: _ClassVar[int]
+    model_id: _model_id_pb2.ModelId
+    path: str
+    def __init__(self, model_id: _Optional[_Union[_model_id_pb2.ModelId, _Mapping]] = ..., path: _Optional[str] = ...) -> None: ...
+
+class CloseModelRequest(_message.Message):
+    __slots__ = ("model_id", "save_changes")
+    MODEL_ID_FIELD_NUMBER: _ClassVar[int]
+    SAVE_CHANGES_FIELD_NUMBER: _ClassVar[int]
+    model_id: _model_id_pb2.ModelId
+    save_changes: bool
+    def __init__(self, model_id: _Optional[_Union[_model_id_pb2.ModelId, _Mapping]] = ..., save_changes: bool = ...) -> None: ...
+
+class CloseAllModelsRequest(_message.Message):
+    __slots__ = ("save_changes",)
+    SAVE_CHANGES_FIELD_NUMBER: _ClassVar[int]
+    save_changes: bool
+    def __init__(self, save_changes: bool = ...) -> None: ...
+
+class ModelInfo(_message.Message):
+    __slots__ = ("name", "id", "path")
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    ID_FIELD_NUMBER: _ClassVar[int]
+    PATH_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    id: str
+    path: str
+    def __init__(self, name: _Optional[str] = ..., id: _Optional[str] = ..., path: _Optional[str] = ...) -> None: ...
+
+class ModelList(_message.Message):
+    __slots__ = ("model_info",)
+    MODEL_INFO_FIELD_NUMBER: _ClassVar[int]
+    model_info: _containers.RepeatedCompositeFieldContainer[ModelInfo]
+    def __init__(self, model_info: _Optional[_Iterable[_Union[ModelInfo, _Mapping]]] = ...) -> None: ...
+
+class ApplicationInfo(_message.Message):
+    __slots__ = ("name", "type", "is_server_instance", "version", "full_version", "options", "language_name", "language_id")
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    TYPE_FIELD_NUMBER: _ClassVar[int]
+    IS_SERVER_INSTANCE_FIELD_NUMBER: _ClassVar[int]
+    VERSION_FIELD_NUMBER: _ClassVar[int]
+    FULL_VERSION_FIELD_NUMBER: _ClassVar[int]
+    OPTIONS_FIELD_NUMBER: _ClassVar[int]
+    LANGUAGE_NAME_FIELD_NUMBER: _ClassVar[int]
+    LANGUAGE_ID_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    type: ApplicationType
+    is_server_instance: bool
+    version: str
+    full_version: str
+    options: str
+    language_name: str
+    language_id: str
+    def __init__(self, name: _Optional[str] = ..., type: _Optional[_Union[ApplicationType, str]] = ..., is_server_instance: bool = ..., version: _Optional[str] = ..., full_version: _Optional[str] = ..., options: _Optional[str] = ..., language_name: _Optional[str] = ..., language_id: _Optional[str] = ...) -> None: ...
+
+class Object(_message.Message):
+    __slots__ = ("object", "model_id")
+    OBJECT_FIELD_NUMBER: _ClassVar[int]
+    MODEL_ID_FIELD_NUMBER: _ClassVar[int]
+    object: _any_pb2.Any
+    model_id: _model_id_pb2.ModelId
+    def __init__(self, object: _Optional[_Union[_any_pb2.Any, _Mapping]] = ..., model_id: _Optional[_Union[_model_id_pb2.ModelId, _Mapping]] = ...) -> None: ...
+
+class ObjectList(_message.Message):
+    __slots__ = ("objects",)
+    OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    objects: _containers.RepeatedCompositeFieldContainer[Object]
+    def __init__(self, objects: _Optional[_Iterable[_Union[Object, _Mapping]]] = ...) -> None: ...
+
+class CalculateAllRequest(_message.Message):
+    __slots__ = ("skip_warnings", "model_id")
+    SKIP_WARNINGS_FIELD_NUMBER: _ClassVar[int]
+    MODEL_ID_FIELD_NUMBER: _ClassVar[int]
+    skip_warnings: bool
+    model_id: _model_id_pb2.ModelId
+    def __init__(self, skip_warnings: bool = ..., model_id: _Optional[_Union[_model_id_pb2.ModelId, _Mapping]] = ...) -> None: ...
+
+class OperationResult(_message.Message):
+    __slots__ = ("succeeded", "data", "message")
+    SUCCEEDED_FIELD_NUMBER: _ClassVar[int]
+    DATA_FIELD_NUMBER: _ClassVar[int]
+    MESSAGE_FIELD_NUMBER: _ClassVar[int]
+    succeeded: bool
+    data: str
+    message: str
+    def __init__(self, succeeded: bool = ..., data: _Optional[str] = ..., message: _Optional[str] = ...) -> None: ...