Harmonize enum and enum-parameter names (#659)

Align the names of enum and the names of the respective parameters.

Closes #658

doc/source/api/enum_types.rst

@@ -11,18 +11,18 @@ Enumeration data types
     BaseElementMaterialHandling
     BooleanOperationType
     CutOffGeometryOrientationType
-    CutoffMaterialType
+    CutoffMaterialHandling
     CutoffRuleType
     DimensionType
-    DrapingMaterialType
+    DrapingMaterialModel
     DrapingType
-    DropoffMaterialType
+    DropoffMaterialHandling
     DropOffType
     EdgeSetType
     ElementalDataType
     ElementTechnology
     ExtrusionGuideType
-    ExtrusionMethodType
+    ExtrusionMethod
     ExtrusionType
     FeFormat
     GeometricalRuleType
@@ -37,7 +37,7 @@ Enumeration data types
     LookUpTableColumnValueType
     MeshImportType
     NodalDataType
-    OffsetDirectionType
+    SolidModelOffsetDirectionType
     OffsetType
     SnapToGeometryOrientationType
     PlyCutoffType
@@ -51,7 +51,7 @@ Enumeration data types
     SolidModelExportFormat
     SolidModelImportFormat
     SolidModelSkinExportFormat
-    StatusType
+    Status
     StressStateType
     SymmetryType
     ThicknessFieldType

examples/007_direction_definitions.py

@@ -208,7 +208,7 @@
     ply_angle=0,
     ply_material=fabric,
     oriented_selection_sets=[oss],
-    draping=DrapingType.TABULAR_VALUES,
+    draping_type=DrapingType.TABULAR_VALUES,
     draping_angle_1_field=angle_column_1,
     draping_angle_2_field=angle_column_2,
 )

src/ansys/acp/core/__init__.py

@@ -54,7 +54,7 @@
     CADGeometry,
     CutOffGeometry,
     CutOffGeometryOrientationType,
-    CutoffMaterialType,
+    CutoffMaterialHandling,
     CutoffRuleType,
     CutoffSelectionRule,
     CutoffSelectionRuleElementalData,
@@ -63,9 +63,9 @@
     CylindricalSelectionRuleElementalData,
     CylindricalSelectionRuleNodalData,
     DimensionType,
-    DrapingMaterialType,
+    DrapingMaterialModel,
     DrapingType,
-    DropoffMaterialType,
+    DropoffMaterialHandling,
     DropOffSettings,
     DropOffType,
     EdgeSet,
@@ -77,7 +77,7 @@
     ElementTechnology,
     ExtrusionGuide,
     ExtrusionGuideType,
-    ExtrusionMethodType,
+    ExtrusionMethod,
     ExtrusionType,
     Fabric,
     FabricWithAngle,
@@ -122,7 +122,6 @@
     ModelingPlyNodalData,
     ModelNodalData,
     NodalDataType,
-    OffsetDirectionType,
     OffsetType,
     OrientedSelectionSet,
     OrientedSelectionSetElementalData,
@@ -158,12 +157,13 @@
     SolidModelExportSettings,
     SolidModelImportFormat,
     SolidModelNodalData,
+    SolidModelOffsetDirectionType,
     SolidModelSkinExportFormat,
     SphericalSelectionRule,
     SphericalSelectionRuleElementalData,
     SphericalSelectionRuleNodalData,
     Stackup,
-    StatusType,
+    Status,
     StressStateType,
     SubLaminate,
     SubShape,
@@ -207,7 +207,7 @@
     "ConnectLaunchConfig",
     "CutOffGeometry",
     "CutOffGeometryOrientationType",
-    "CutoffMaterialType",
+    "CutoffMaterialHandling",
     "CutoffRuleType",
     "CutoffSelectionRule",
     "CutoffSelectionRuleElementalData",
@@ -218,9 +218,9 @@
     "DimensionType",
     "DirectLaunchConfig",
     "DockerComposeLaunchConfig",
-    "DrapingMaterialType",
+    "DrapingMaterialModel",
     "DrapingType",
-    "DropoffMaterialType",
+    "DropoffMaterialHandling",
     "DropOffSettings",
     "DropOffType",
     "EdgeSet",
@@ -233,7 +233,7 @@
     "example_helpers",
     "ExtrusionGuide",
     "ExtrusionGuideType",
-    "ExtrusionMethodType",
+    "ExtrusionMethod",
     "ExtrusionType",
     "Fabric",
     "FabricWithAngle",
@@ -286,7 +286,7 @@
     "ModelingPlyNodalData",
     "ModelNodalData",
     "NodalDataType",
-    "OffsetDirectionType",
+    "SolidModelOffsetDirectionType",
     "OffsetType",
     "OrientedSelectionSet",
     "OrientedSelectionSetElementalData",
@@ -329,7 +329,7 @@
     "SphericalSelectionRuleElementalData",
     "SphericalSelectionRuleNodalData",
     "Stackup",
-    "StatusType",
+    "Status",
     "StressStateType",
     "SubLaminate",
     "SubShape",

src/ansys/acp/core/_tree_objects/__init__.py

@@ -48,18 +48,18 @@
     BaseElementMaterialHandling,
     BooleanOperationType,
     CutOffGeometryOrientationType,
-    CutoffMaterialType,
+    CutoffMaterialHandling,
     CutoffRuleType,
     DimensionType,
-    DrapingMaterialType,
+    DrapingMaterialModel,
     DrapingType,
-    DropoffMaterialType,
+    DropoffMaterialHandling,
     DropOffType,
     EdgeSetType,
     ElementalDataType,
     ElementTechnology,
     ExtrusionGuideType,
-    ExtrusionMethodType,
+    ExtrusionMethod,
     ExtrusionType,
     GeometricalRuleType,
     ImportedPlyDrapingType,
@@ -70,7 +70,6 @@
     LookUpTableColumnValueType,
     MeshImportType,
     NodalDataType,
-    OffsetDirectionType,
     OffsetType,
     PlyCutoffType,
     PlyGeometryExportFormat,
@@ -82,8 +81,9 @@
     SensorType,
     SnapToGeometryOrientationType,
     SolidModelExportFormat,
+    SolidModelOffsetDirectionType,
     SolidModelSkinExportFormat,
-    StatusType,
+    Status,
     StressStateType,
     SymmetryType,
     ThicknessFieldType,
@@ -183,7 +183,7 @@
     "CADGeometry",
     "CutOffGeometry",
     "CutOffGeometryOrientationType",
-    "CutoffMaterialType",
+    "CutoffMaterialHandling",
     "CutoffRuleType",
     "CutoffSelectionRule",
     "CutoffSelectionRuleElementalData",
@@ -192,9 +192,9 @@
     "CylindricalSelectionRuleElementalData",
     "CylindricalSelectionRuleNodalData",
     "DimensionType",
-    "DrapingMaterialType",
+    "DrapingMaterialModel",
     "DrapingType",
-    "DropoffMaterialType",
+    "DropoffMaterialHandling",
     "DropOffSettings",
     "DropOffType",
     "EdgeSet",
@@ -206,7 +206,7 @@
     "ElementTechnology",
     "ExtrusionGuide",
     "ExtrusionGuideType",
-    "ExtrusionMethodType",
+    "ExtrusionMethod",
     "ExtrusionType",
     "Fabric",
     "FabricWithAngle",
@@ -253,7 +253,7 @@
     "ModelingPlyNodalData",
     "ModelNodalData",
     "NodalDataType",
-    "OffsetDirectionType",
+    "SolidModelOffsetDirectionType",
     "OffsetType",
     "OrientedSelectionSet",
     "OrientedSelectionSetElementalData",
@@ -295,7 +295,7 @@
     "SphericalSelectionRuleElementalData",
     "SphericalSelectionRuleNodalData",
     "Stackup",
-    "StatusType",
+    "Status",
     "StressStateType",
     "SubLaminate",
     "SubShape",

src/ansys/acp/core/_tree_objects/_grpc_helpers/mapping.py

@@ -36,7 +36,7 @@
 from ..._utils.resource_paths import join as _rp_join
 from .._object_cache import ObjectCacheMixin, constructor_with_cache
 from ..base import CreatableTreeObject, ServerWrapper, TreeObject, TreeObjectBase
-from ..enums import StatusType
+from ..enums import Status
 from .exceptions import wrap_grpc_errors
 from .property_helper import _exposed_grpc_property, _wrap_doc
 from .protocols import EditableAndReadableResourceStub, ObjectInfo, ReadableResourceStub
@@ -260,7 +260,7 @@ def get_read_only_collection_property(
     """Define a read-only mapping of child tree objects."""
 
     def collection_property(self: ParentT) -> Mapping[ValueT]:
-        if requires_uptodate and hasattr(self, "status") and not self.status == StatusType.UPTODATE:
+        if requires_uptodate and hasattr(self, "status") and not self.status == Status.UPTODATE:
             raise RuntimeError(
                 f"The object {self.name} must be up-to-date to access {object_class.__name__}."
             )

src/ansys/acp/core/_tree_objects/boolean_selection_rule.py

@@ -81,7 +81,7 @@ class BooleanSelectionRule(CreatableTreeObject, IdTreeObject):
         Name of the Boolean Selection Rule.
     selection_rules :
 
-    include_rule_type :
+    include_rule :
         Include or exclude area in rule. Setting this to ``False``
         inverts the selection.
     """
@@ -98,11 +98,11 @@ def __init__(
         *,
         name: str = "BooleanSelectionrule",
         selection_rules: Iterable[LinkedSelectionRule] = (),
-        include_rule_type: bool = True,
+        include_rule: bool = True,
     ):
         super().__init__(name=name)
         self.selection_rules = selection_rules
-        self.include_rule_type = include_rule_type
+        self.include_rule = include_rule
 
     def _create_stub(self) -> boolean_selection_rule_pb2_grpc.ObjectServiceStub:
         return boolean_selection_rule_pb2_grpc.ObjectServiceStub(self._channel)
@@ -118,9 +118,7 @@ def _create_stub(self) -> boolean_selection_rule_pb2_grpc.ObjectServiceStub:
         module_name=__module__,
     )
 
-    include_rule_type: ReadWriteProperty[bool, bool] = grpc_data_property(
-        "properties.include_rule_type"
-    )
+    include_rule: ReadWriteProperty[bool, bool] = grpc_data_property("properties.include_rule_type")
 
     elemental_data = elemental_data_property(BooleanSelectionRuleElementalData)
     nodal_data = nodal_data_property(BooleanSelectionRuleNodalData)

src/ansys/acp/core/_tree_objects/cylindrical_selection_rule.py

@@ -91,9 +91,9 @@ class CylindricalSelectionRule(CreatableTreeObject, IdTreeObject):
         Direction of the Cylindrical Selection Rule.
     radius :
         Radius of the cylinder.
-    relative_rule_type :
+    relative_rule :
         If True, parameters are evaluated relative to size of the object.
-    include_rule_type :
+    include_rule :
         Include or exclude area in rule. Setting this to ``False``
         inverts the selection.
     """
@@ -114,17 +114,17 @@ def __init__(
         origin: tuple[float, ...] = (0.0, 0.0, 0.0),
         direction: tuple[float, ...] = (0.0, 0.0, 1.0),
         radius: float = 0.0,
-        relative_rule_type: bool = False,
-        include_rule_type: bool = True,
+        relative_rule: bool = False,
+        include_rule: bool = True,
     ):
         super().__init__(name=name)
         self.use_global_coordinate_system = use_global_coordinate_system
         self.rosette = rosette
         self.origin = origin
         self.direction = direction
         self.radius = radius
-        self.relative_rule_type = relative_rule_type
-        self.include_rule_type = include_rule_type
+        self.relative_rule = relative_rule
+        self.include_rule = include_rule
 
     def _create_stub(self) -> cylindrical_selection_rule_pb2_grpc.ObjectServiceStub:
         return cylindrical_selection_rule_pb2_grpc.ObjectServiceStub(self._channel)
@@ -142,12 +142,10 @@ def _create_stub(self) -> cylindrical_selection_rule_pb2_grpc.ObjectServiceStub:
         "properties.direction", from_protobuf=to_tuple_from_1D_array, to_protobuf=to_1D_double_array
     )
     radius: ReadWriteProperty[float, float] = grpc_data_property("properties.radius")
-    relative_rule_type: ReadWriteProperty[bool, bool] = grpc_data_property(
+    relative_rule: ReadWriteProperty[bool, bool] = grpc_data_property(
         "properties.relative_rule_type"
     )
-    include_rule_type: ReadWriteProperty[bool, bool] = grpc_data_property(
-        "properties.include_rule_type"
-    )
+    include_rule: ReadWriteProperty[bool, bool] = grpc_data_property("properties.include_rule_type")
 
     elemental_data = elemental_data_property(CylindricalSelectionRuleElementalData)
     nodal_data = nodal_data_property(CylindricalSelectionRuleNodalData)