dlubal.api 2.12.1__py3-none-any.whl → 2.12.3__py3-none-any.whl

dlubal/api/rstab/application.py

@@ -122,11 +122,11 @@ class Application:
 
     def get_object(self, obj, model_id: ModelId | None = None):
         """
-        Retrieves a single object from the model using its number.
+        Retrieves a single object from the model.
 
         Args:
             obj (obj):
-                An object to be retrieved defined by its number. See :ref:`rstab_objects`.
+                An object to be retrieved defined by its number.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -142,7 +142,7 @@ class Application:
 
         Args:
             objs (list[obj]):
-                A list of model objects to retrieve. See :ref:`rstab_objects`.
+                A list of model objects to retrieve.
             only_selected (bool, optional):
                 If True, only returns objects from the list that are currently selected in the model.
             model_id (:ref:`common_model_id_ModelId` | None):
@@ -165,7 +165,7 @@ class Application:
 
         Args:
             obj (obj):
-                An object to be created. See :ref:`rstab_objects`.
+                An object to be created.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -180,7 +180,7 @@ class Application:
 
         Args:
             objs (list[obj]):
-                A list of objects to be created. See :ref:`rstab_objects`.
+                A list of objects to be created.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -195,7 +195,7 @@ class Application:
 
         Args:
             obj (obj):
-                An object to be updated. See :ref:`rstab_objects`.
+                An object to be updated.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -210,7 +210,7 @@ class Application:
 
         Args:
             objs (list[obj]):
-                A list of objects to be updated. See :ref:`rstab_objects`.
+                A list of objects to be updated.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -225,7 +225,7 @@ class Application:
 
         Args:
             obj (obj):
-                An object to be deleted defined by its number. See :ref:`rstab_objects`.
+                An object to be deleted.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -240,7 +240,7 @@ class Application:
 
         Args:
             objs (list[obj]):
-                A list of objects to be deleted. See :ref:`rstab_objects`.
+                A list of objects to be deleted.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -255,7 +255,7 @@ class Application:
 
         Args:
             objs (list[obj]):
-                A list of objects to be selected. See :ref:`rstab_objects`.
+                A list of objects to be selected.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -278,9 +278,9 @@ class Application:
             filters (:ref:`rstab_results_results_query_ResultsFilter` | None):
                 One or more filters to return only relevant results.
             member_axes_system (:ref:`rstab_results_settings_result_settings_MemberAxesSystem` | None):
-                The axes system to use for member results.
+                The axes system to use for member results. If not provided, it defaults to ``MEMBER_AXES_SYSTEM_MEMBER_AXES_X_Y_Z``.
             support_coordinate_system (:ref:`rstab_results_settings_result_settings_CoordinateSystem` | None):
-                The coordinate system to use for support results.
+                The coordinate system to use for support results. If not provided, it defaults to ``COORDINATE_SYSTEM_LOCAL``.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -328,9 +328,9 @@ class Application:
             loading (:ref:`rstab_object_id_ObjectId`):
                 Reference to the loading (e.g., load case, combination, etc.).
             member_axes_system (:ref:`rstab_results_settings_result_settings_MemberAxesSystem` | None):
-                The axes system to use for member results.
+                The axes system to use for member results. If not provided, it defaults to ``MEMBER_AXES_SYSTEM_MEMBER_AXES_X_Y_Z``.
             support_coordinate_system (:ref:`rstab_results_settings_result_settings_CoordinateSystem` | None):
-                The coordinate system to use for support results.
+                The coordinate system to use for support results. If not provided, it defaults to ``COORDINATE_SYSTEM_LOCAL``.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
 
@@ -360,14 +360,14 @@ class Application:
 
         return convert_table_data_to_table(table_data=results, warning=warning)
 
-    def convert_objects(self, *, convert_into: ConvertObjectInto, objects: list, model_id: ModelId | None = None):
+    def convert_objects(self, *, convert_into: ConvertObjectInto, objs: list, model_id: ModelId | None = None):
         """
         Converts specified objects into a different type.
 
         Args:
             convert_into (:ref:`common_common_messages_ConvertObjectInto`):
                 Specifies the target conversion type.
-            objects (list):
+            objs (list):
                 Objects to be converted.
             model_id (:ref:`common_model_id_ModelId` | None):
                 Unique identifier of the model. If None, the active model is used.
@@ -375,7 +375,7 @@ class Application:
         Returns:
             None
         """
-        request = ConvertObjectsRequest(convert_into=convert_into, objects=pack_object_list(objects, model_id))
+        request = ConvertObjectsRequest(convert_into=convert_into, objects=pack_object_list(objs, model_id))
         self.stub.convert_objects_impl(request)
 
     def import_from(self, *, filepath: str, import_attributes: google.protobuf.any_pb2.Any, model_id: ModelId | None = None):

dlubal/api/rstab/base_data_objects/terrain_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n0dlubal/api/rstab/base_data_objects/terrain.proto\x12\"dlubal.api.rstab.base_data_objects\"\xfc\x08\n\x07Terrain\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x43\n\x04type\x18\x02 \x01(\x0e\x32\x30.dlubal.api.rstab.base_data_objects.Terrain.TypeH\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\x12T\n\rterrain_table\x18\n \x01(\x0b\x32\x38.dlubal.api.rstab.base_data_objects.Terrain.TerrainTableH\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\x1aY\n\x0cTerrainTable\x12I\n\x04rows\x18\x01 \x03(\x0b\x32;.dlubal.api.rstab.base_data_objects.Terrain.TerrainTableRow\x1a\xbf\x01\n\x0fTerrainTableRow\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\"\x85\x01\n\x04Type\x12\x10\n\x0cTYPE_UNKNOWN\x10\x00\x12\x12\n\x0eTYPE_BOREHOLES\x10\x05\x12\x19\n\x15TYPE_HORIZONTAL_PLANE\x10\x02\x12\x17\n\x13TYPE_INCLINED_PLANE\x10\x03\x12\x13\n\x0fTYPE_NO_TERRAIN\x10\x01\x12\x0e\n\nTYPE_TABLE\x10\x04\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_importb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n0dlubal/api/rstab/base_data_objects/terrain.proto\x12\"dlubal.api.rstab.base_data_objects\"\xc4\t\n\x07Terrain\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\x43\n\x04type\x18\x02 \x01(\x0e\x32\x30.dlubal.api.rstab.base_data_objects.Terrain.TypeH\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\x12T\n\rterrain_table\x18\n \x01(\x0b\x32\x38.dlubal.api.rstab.base_data_objects.Terrain.TerrainTableH\t\x88\x01\x01\x12\x17\n\nifc_object\x18\x0b \x01(\x05H\n\x88\x01\x01\x12!\n\x14id_for_export_import\x18\x0c \x01(\tH\x0b\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\r \x01(\tH\x0c\x88\x01\x01\x1aY\n\x0cTerrainTable\x12I\n\x04rows\x18\x01 \x03(\x0b\x32;.dlubal.api.rstab.base_data_objects.Terrain.TerrainTableRow\x1a\xbf\x01\n\x0fTerrainTableRow\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\"\xa5\x01\n\x04Type\x12\x10\n\x0cTYPE_UNKNOWN\x10\x00\x12\x12\n\x0eTYPE_BOREHOLES\x10\x05\x12\x19\n\x15TYPE_HORIZONTAL_PLANE\x10\x02\x12\x1e\n\x1aTYPE_IFC_FILE_MODEL_OBJECT\x10\x06\x12\x17\n\x13TYPE_INCLINED_PLANE\x10\x03\x12\x13\n\x0fTYPE_NO_TERRAIN\x10\x01\x12\x0e\n\nTYPE_TABLE\x10\x04\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\r\n\x0b_ifc_objectB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,11 +32,11 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rstab.base_data_
 if not _descriptor._USE_C_DESCRIPTORS:
   DESCRIPTOR._loaded_options = None
   _globals['_TERRAIN']._serialized_start=89
-  _globals['_TERRAIN']._serialized_end=1237
-  _globals['_TERRAIN_TERRAINTABLE']._serialized_start=573
-  _globals['_TERRAIN_TERRAINTABLE']._serialized_end=662
-  _globals['_TERRAIN_TERRAINTABLEROW']._serialized_start=665
-  _globals['_TERRAIN_TERRAINTABLEROW']._serialized_end=856
-  _globals['_TERRAIN_TYPE']._serialized_start=859
-  _globals['_TERRAIN_TYPE']._serialized_end=992
+  _globals['_TERRAIN']._serialized_end=1309
+  _globals['_TERRAIN_TERRAINTABLE']._serialized_start=598
+  _globals['_TERRAIN_TERRAINTABLE']._serialized_end=687
+  _globals['_TERRAIN_TERRAINTABLEROW']._serialized_start=690
+  _globals['_TERRAIN_TERRAINTABLEROW']._serialized_end=881
+  _globals['_TERRAIN_TYPE']._serialized_start=884
+  _globals['_TERRAIN_TYPE']._serialized_end=1049
 # @@protoc_insertion_point(module_scope)

dlubal/api/rstab/base_data_objects/terrain_pb2.pyi

@@ -7,18 +7,20 @@ from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Map
 DESCRIPTOR: _descriptor.FileDescriptor
 
 class Terrain(_message.Message):
-    __slots__ = ("no", "type", "comment", "bounding_box_offset_x", "bounding_box_offset_y", "center_of_terrain_z", "rotation_around_Z", "consider_boreholes", "coordinate_system", "terrain_table", "id_for_export_import", "metadata_for_export_import")
+    __slots__ = ("no", "type", "comment", "bounding_box_offset_x", "bounding_box_offset_y", "center_of_terrain_z", "rotation_around_Z", "consider_boreholes", "coordinate_system", "terrain_table", "ifc_object", "id_for_export_import", "metadata_for_export_import")
     class Type(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
         __slots__ = ()
         TYPE_UNKNOWN: _ClassVar[Terrain.Type]
         TYPE_BOREHOLES: _ClassVar[Terrain.Type]
         TYPE_HORIZONTAL_PLANE: _ClassVar[Terrain.Type]
+        TYPE_IFC_FILE_MODEL_OBJECT: _ClassVar[Terrain.Type]
         TYPE_INCLINED_PLANE: _ClassVar[Terrain.Type]
         TYPE_NO_TERRAIN: _ClassVar[Terrain.Type]
         TYPE_TABLE: _ClassVar[Terrain.Type]
     TYPE_UNKNOWN: Terrain.Type
     TYPE_BOREHOLES: Terrain.Type
     TYPE_HORIZONTAL_PLANE: Terrain.Type
+    TYPE_IFC_FILE_MODEL_OBJECT: Terrain.Type
     TYPE_INCLINED_PLANE: Terrain.Type
     TYPE_NO_TERRAIN: Terrain.Type
     TYPE_TABLE: Terrain.Type
@@ -50,6 +52,7 @@ class Terrain(_message.Message):
     CONSIDER_BOREHOLES_FIELD_NUMBER: _ClassVar[int]
     COORDINATE_SYSTEM_FIELD_NUMBER: _ClassVar[int]
     TERRAIN_TABLE_FIELD_NUMBER: _ClassVar[int]
+    IFC_OBJECT_FIELD_NUMBER: _ClassVar[int]
     ID_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
     METADATA_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
     no: int
@@ -62,6 +65,7 @@ class Terrain(_message.Message):
     consider_boreholes: bool
     coordinate_system: int
     terrain_table: Terrain.TerrainTable
+    ifc_object: int
     id_for_export_import: str
     metadata_for_export_import: str
-    def __init__(self, no: _Optional[int] = ..., type: _Optional[_Union[Terrain.Type, 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[Terrain.TerrainTable, _Mapping]] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...
+    def __init__(self, no: _Optional[int] = ..., type: _Optional[_Union[Terrain.Type, 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[Terrain.TerrainTable, _Mapping]] = ..., ifc_object: _Optional[int] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...