wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/models/collider.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.collider_shape import ColliderShape
+from wandelbots_api_client.models.pose2 import Pose2
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Collider(BaseModel):
+    """
+    Defines a collider with a single shape.  A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame.  Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
+    """  # noqa: E501
+
+    shape: ColliderShape
+    pose: Optional[Pose2] = None
+    margin: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0,
+        description="Increases the shape's size in all dimensions. Applied in [mm]. Can be used to keep a safe distance to the shape.",
+    )
+    __properties: ClassVar[List[str]] = ["shape", "pose", "margin"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Collider from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of shape
+        if self.shape:
+            _dict["shape"] = self.shape.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pose
+        if self.pose:
+            _dict["pose"] = self.pose.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Collider from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "shape": ColliderShape.from_dict(obj["shape"]) if obj.get("shape") is not None else None,
+                "pose": Pose2.from_dict(obj["pose"]) if obj.get("pose") is not None else None,
+                "margin": obj.get("margin") if obj.get("margin") is not None else 0,
+            }
+        )
+        return _obj

wandelbots_api_client/models/collider_input.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.collider_output_shape import ColliderOutputShape
+from wandelbots_api_client.models.pyjectory_datatypes_core_pose import PyjectoryDatatypesCorePose
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ColliderInput(BaseModel):
+    """
+    Defines a collider with a single shape.  Pose describes where the shape of the collider is positioned.
+    """  # noqa: E501
+
+    shape: ColliderOutputShape
+    pose: PyjectoryDatatypesCorePose
+    margin: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0,
+        description="Increases the shape's size in all dimensions. Applied in [mm]. Can be used to keep a safe distance to the shape.",
+    )
+    __properties: ClassVar[List[str]] = ["shape", "pose", "margin"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ColliderInput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of shape
+        if self.shape:
+            _dict["shape"] = self.shape.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pose
+        if self.pose:
+            _dict["pose"] = self.pose.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ColliderInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "shape": ColliderOutputShape.from_dict(obj["shape"]) if obj.get("shape") is not None else None,
+                "pose": PyjectoryDatatypesCorePose.from_dict(obj["pose"]) if obj.get("pose") is not None else None,
+                "margin": obj.get("margin") if obj.get("margin") is not None else 0,
+            }
+        )
+        return _obj

wandelbots_api_client/models/collider_output.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.collider_output_shape import ColliderOutputShape
+from wandelbots_api_client.models.pyjectory_datatypes_core_pose import PyjectoryDatatypesCorePose
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ColliderOutput(BaseModel):
+    """
+    Defines a collider with a single shape.  Pose describes where the shape of the collider is positioned.
+    """  # noqa: E501
+
+    shape: ColliderOutputShape
+    pose: PyjectoryDatatypesCorePose
+    margin: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0,
+        description="Increases the shape's size in all dimensions. Applied in [mm]. Can be used to keep a safe distance to the shape.",
+    )
+    __properties: ClassVar[List[str]] = ["shape", "pose", "margin"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ColliderOutput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of shape
+        if self.shape:
+            _dict["shape"] = self.shape.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pose
+        if self.pose:
+            _dict["pose"] = self.pose.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ColliderOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "shape": ColliderOutputShape.from_dict(obj["shape"]) if obj.get("shape") is not None else None,
+                "pose": PyjectoryDatatypesCorePose.from_dict(obj["pose"]) if obj.get("pose") is not None else None,
+                "margin": obj.get("margin") if obj.get("margin") is not None else 0,
+            }
+        )
+        return _obj

wandelbots_api_client/models/collider_output_shape.py

@@ -0,0 +1,242 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from wandelbots_api_client.models.box3 import Box3
+from wandelbots_api_client.models.capsule3 import Capsule3
+from wandelbots_api_client.models.convex_hull3 import ConvexHull3
+from wandelbots_api_client.models.cylinder3 import Cylinder3
+from wandelbots_api_client.models.plane3 import Plane3
+from wandelbots_api_client.models.rectangle3 import Rectangle3
+from wandelbots_api_client.models.rectangular_capsule3 import RectangularCapsule3
+from wandelbots_api_client.models.sphere3 import Sphere3
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+COLLIDEROUTPUTSHAPE_ONE_OF_SCHEMAS = [
+    "Box3",
+    "Capsule3",
+    "ConvexHull3",
+    "Cylinder3",
+    "Plane3",
+    "Rectangle3",
+    "RectangularCapsule3",
+    "Sphere3",
+]
+
+
+class ColliderOutputShape(BaseModel):
+    """
+    ColliderOutputShape
+    """
+
+    # data type: Sphere3
+    oneof_schema_1_validator: Optional[Sphere3] = None
+    # data type: Box3
+    oneof_schema_2_validator: Optional[Box3] = None
+    # data type: Rectangle3
+    oneof_schema_3_validator: Optional[Rectangle3] = None
+    # data type: Plane3
+    oneof_schema_4_validator: Optional[Plane3] = None
+    # data type: Cylinder3
+    oneof_schema_5_validator: Optional[Cylinder3] = None
+    # data type: Capsule3
+    oneof_schema_6_validator: Optional[Capsule3] = None
+    # data type: RectangularCapsule3
+    oneof_schema_7_validator: Optional[RectangularCapsule3] = None
+    # data type: ConvexHull3
+    oneof_schema_8_validator: Optional[ConvexHull3] = None
+    actual_instance: Optional[Union[Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3]] = None
+    one_of_schemas: Set[str] = {"Box3", "Capsule3", "ConvexHull3", "Cylinder3", "Plane3", "Rectangle3", "RectangularCapsule3", "Sphere3"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = ColliderOutputShape.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: Sphere3
+        if not isinstance(v, Sphere3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Sphere3`")
+        else:
+            match += 1
+        # validate data type: Box3
+        if not isinstance(v, Box3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Box3`")
+        else:
+            match += 1
+        # validate data type: Rectangle3
+        if not isinstance(v, Rectangle3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Rectangle3`")
+        else:
+            match += 1
+        # validate data type: Plane3
+        if not isinstance(v, Plane3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Plane3`")
+        else:
+            match += 1
+        # validate data type: Cylinder3
+        if not isinstance(v, Cylinder3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Cylinder3`")
+        else:
+            match += 1
+        # validate data type: Capsule3
+        if not isinstance(v, Capsule3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Capsule3`")
+        else:
+            match += 1
+        # validate data type: RectangularCapsule3
+        if not isinstance(v, RectangularCapsule3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `RectangularCapsule3`")
+        else:
+            match += 1
+        # validate data type: ConvexHull3
+        if not isinstance(v, ConvexHull3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ConvexHull3`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in ColliderOutputShape with oneOf schemas: Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in ColliderOutputShape with oneOf schemas: Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into Sphere3
+        try:
+            instance.actual_instance = Sphere3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Box3
+        try:
+            instance.actual_instance = Box3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Rectangle3
+        try:
+            instance.actual_instance = Rectangle3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Plane3
+        try:
+            instance.actual_instance = Plane3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Cylinder3
+        try:
+            instance.actual_instance = Cylinder3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Capsule3
+        try:
+            instance.actual_instance = Capsule3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into RectangularCapsule3
+        try:
+            instance.actual_instance = RectangularCapsule3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ConvexHull3
+        try:
+            instance.actual_instance = ConvexHull3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into ColliderOutputShape with oneOf schemas: Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into ColliderOutputShape with oneOf schemas: Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[Union[Dict[str, Any], Box3, Capsule3, ConvexHull3, Cylinder3, Plane3, Rectangle3, RectangularCapsule3, Sphere3]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())