pycatia3dx 0.1__py3-none-any.whl

pycatia3dx/__init__.py

@@ -0,0 +1,63 @@
+"""
+    The catia base object is from which most other functionality derives. See examples for more information.
+
+    >>> from pycatia3dx import catia3dx
+    >>> application = catia()
+
+"""
+
+from pycatia3dx.annotation.enums import *
+from pycatia3dx.composites_use.enums import *
+from pycatia3dx.del_curve_trajectory.enums import *
+from pycatia3dx.del_resource_builder.enums import *
+from pycatia3dx.del_robot_simulation.enums import *
+from pycatia3dx.del_rof_surf.enums import *
+from pycatia3dx.del_spot_welding.enums import *
+from pycatia3dx.del_spot_welding_as_is.enums import *
+from pycatia3dx.dnb_fitting.enums import *
+from pycatia3dx.dnb_igp_arc_welding_use.enums import *
+from pycatia3dx.dnb_igp_olp_use.enums import *
+from pycatia3dx.drafting.enums import *
+from pycatia3dx.drafting_2d.enums import *
+from pycatia3dx.eng_connection.enums import *
+from pycatia3dx.fmt_mode.enums import *
+from pycatia3dx.hybrid_shapes.enums import *
+from pycatia3dx.interfaces.enums import *
+from pycatia3dx.kin_mechanism.enums import *
+from pycatia3dx.kin_simulation.enums import *
+from pycatia3dx.know_how.enums import *
+from pycatia3dx.knowledge_interfaces.enums import *
+from pycatia3dx.material.enums import *
+from pycatia3dx.measure.enums import *
+from pycatia3dx.measure.enums import *
+from pycatia3dx.mmr_automation_interfaces.enums import *
+from pycatia3dx.opns_section.enums import *
+from pycatia3dx.os.enums import *
+from pycatia3dx.part.enums import *
+from pycatia3dx.pcb_board.enums import *
+from pycatia3dx.plm_access.enums import *
+from pycatia3dx.plm_interference.enums import *
+from pycatia3dx.sim_rep.enums import *
+from pycatia3dx.sketcher.enums import *
+from pycatia3dx.sma_few_optimization.enums import *
+from pycatia3dx.sma_mat_material.enums import *
+from pycatia3dx.sma_mpa_base.enums import *
+from pycatia3dx.sma_mpa_foundation.enums import *
+from pycatia3dx.sma_mpa_results.enums import *
+from pycatia3dx.sma_mpa_structural_mode.enums import *
+from pycatia3dx.sma_spa_structural.enums import *
+from pycatia3dx.structure.enums import *
+from pycatia3dx.system.enums import *
+from pycatia3dx.tps.enums import *
+from pycatia3dx.version import version
+
+from pycatia3dx.base_interfaces.base_application import catia_application as catia3dx
+
+__author__ = 'Paul Bourne'
+__author_email = 'evereux@gmail.com'
+__description__ = 'A python package for automation of the CATIA 3DEXPERIENCE cad application.'
+__name__ = "pycatia3dx"
+__version__ = version
+__url__ = "https://github.com/evereux/pycatia3dx"
+
+name = __name__

pycatia3dx/agt/agt_category_mngt.py

@@ -0,0 +1,89 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+
+from pycatia3dx.system.any_object import AnyObject
+
+
+class AGTCategoryMngt(AnyObject):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.AnyObject
+                |                     AGTCategoryMngt
+                | 
+                | Object to manage category.
+                | To access category of structure object.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object)
+        self.com_object = com_object
+
+    def get_category(self) -> str:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Func GetCategory() As CATBSTR
+                |     Returns the category of this object.
+                | 
+                |     Example:
+                | 
+                | 
+                |              This example retrieves in category of insulation
+                |              object.
+                |              
+                | 
+                |              Dim ObjAGTCategoryMngt As AGTMaterialMngt
+                |              Set ObjAGTCategoryMngt = ObjAGTInsulation.AGTCategoryMngt
+                |              AGTCategory = ObjAGTCategoryMngt.GetCategory
+
+        :return: str
+        """
+        return self.com_object.GetCategory()
+
+    def set_category(self, i_category: str) -> None:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Sub SetCategory(CATBSTR iCategory)
+                |     Sets the category of this object.
+                | 
+                |     Parameters:
+                | 
+                |         iCategory
+                |             New category of the object. 
+                | 
+                |     Example:
+                | 
+                | 
+                |              This example sets category of object.
+                |              
+                | 
+                |              ObjAGTCategoryMngt.SetCategory "AGTInsulation"
+
+        :param str i_category:
+        :return: None
+        """
+        return self.com_object.SetCategory(i_category)
+
+    def __repr__(self):
+        return f'AgtCategoryMngt(name="{self.name}")'

pycatia3dx/agt/agt_connector.py

@@ -0,0 +1,91 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+from pycatia3dx.agt.agt_category_mngt import AGTCategoryMngt
+from pycatia3dx.agt.agt_material_mngt import AGTMaterialMngt
+from pycatia3dx.system.any_object import AnyObject
+
+
+class AGTConnector(AnyObject):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.AnyObject
+                |                     AGTConnector
+                | 
+                | Object for Connector.
+                | To return the management object.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object)
+        self.com_object = com_object
+
+    @property
+    def agt_category_mngt(self) -> AGTCategoryMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTCategoryMngt() As AGTCategoryMngt (Read Only)
+                |     Returns the AGTCategoryMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjCategoryMngt the AGTCategoryMngt
+                |              object of the Connector.
+                |              
+                | 
+                |              Dim ObjCategoryMngt As AGTCategoryMngt 
+                |              Set ObjCategoryMngt = ObjConnector.AGTCategoryMngt
+
+        :return: AGTCategoryMngt
+        """
+
+        return AGTCategoryMngt(self.com_object.AGTCategoryMngt)
+
+    @property
+    def agt_material_mngt(self) -> AGTMaterialMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTMaterialMngt() As AGTMaterialMngt (Read Only)
+                |     Returns the AGTMaterialMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjMaterialMngt the AGTMaterialMngt
+                |              object of the Connector.
+                |              
+                | 
+                |              Dim ObjMaterialMngt As AGTMaterialMngt 
+                |              Set ObjMaterialMngt = ObjConnector.AGTMaterialMngt
+
+        :return: AGTMaterialMngt
+        """
+
+        return AGTMaterialMngt(self.com_object.AGTMaterialMngt)
+
+    def __repr__(self):
+        return f'AgtConnector(name="{self.name}")'

pycatia3dx/agt/agt_connectors.py

@@ -0,0 +1,90 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+from typing import Iterator
+
+from pycatia3dx.agt.agt_connector import AGTConnector
+from pycatia3dx.system.collection import Collection
+from pycatia3dx.types.general import CATVariant
+
+
+class AGTConnectors(Collection):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.Collection
+                |                     AGTConnectors
+                | 
+                | Object for Connectors.
+                | To retrieve a Connector from collection.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object, child_object=AGTConnector)
+        self.com_object = com_object
+
+    def item(self, i_index: CATVariant) -> AGTConnector:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Func Item(CATVariant iIndex) As AGTConnector
+                |     Retrieves a Connector from the collection of Connector.
+                | 
+                |     Parameters:
+                | 
+                |         iIndex
+                |             The index of Connector 
+                | 
+                |     Example:
+                | 
+                | 
+                |              This example retrieves Connector from the list of
+                |              Connectors
+                |              
+                | 
+                |              Dim myPart as CATIAPart
+                |              Set myPart = CATIA.ActiveEditor.ActievObject
+                |              Dim MyAGTRoot As AGTRoot
+                |              Set MyAGTRoot = myPart.GetItem("CATAGTRoot")
+                |              'Get a second Connector from the list of Connector by
+                |              index
+                |              Dim ConnectorByIndex As AGTConnectors
+                |              Set ConnectorByIndex = MyAGTRoot.Connectors.Item(2)
+                |              'Get a Connector named "MyConnector.2" from the list of Connector
+                |              by name
+                |              Dim ConnectorByName As AGTConnectors
+                |              Set ConnectorByName = MyAGTRoot.Connectors.Item("MyConnector.2")
+
+        :param CATVariant i_index:
+        :return: AGTConnector
+        """
+        return AGTConnector(self.com_object.Item(i_index))
+
+    def __getitem__(self, n: int) -> AGTConnector:
+        if (n + 1) > self.count:
+            raise StopIteration
+
+        return AGTConnector(self.com_object.Item(n + 1))
+
+    def __iter__(self) -> Iterator[AGTConnector]:
+        for i in range(self.count):
+            yield AGTConnector(self.com_object.Item(i + 1))
+
+    def __repr__(self):
+        return f'AGTConnectors(name="{self.name}")'

pycatia3dx/agt/agt_draught_stop.py

@@ -0,0 +1,91 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+from pycatia3dx.agt.agt_category_mngt import AGTCategoryMngt
+from pycatia3dx.agt.agt_material_mngt import AGTMaterialMngt
+from pycatia3dx.system.any_object import AnyObject
+
+
+class AGTDraughtStop(AnyObject):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.AnyObject
+                |                     AGTDraughtStop
+                | 
+                | The interface to access a DraughtStop.
+                | To return the management object.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object)
+        self.com_object = com_object
+
+    @property
+    def agt_category_mngt(self) -> AGTCategoryMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTCategoryMngt() As AGTCategoryMngt (Read Only)
+                |     Returns the AGTCategoryMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjCategoryMngt the AGTCategoryMngt
+                |              object of the AGTDraughtStop.
+                |              
+                | 
+                |              Dim ObjCategoryMngt As AGTCategoryMngt 
+                |              Set ObjCategoryMngt = ObjAGTDraughtStop.AGTCategoryMngt
+
+        :return: AGTCategoryMngt
+        """
+
+        return AGTCategoryMngt(self.com_object.AGTCategoryMngt)
+
+    @property
+    def agt_material_mngt(self) -> AGTMaterialMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTMaterialMngt() As AGTMaterialMngt (Read Only)
+                |     Returns the AGTMaterialMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjMaterialMngt the AGTMaterialMngt
+                |              object of the AGTDraughtStop.
+                |              
+                | 
+                |              Dim ObjMaterialMngt As AGTMaterialMngt 
+                |              Set ObjMaterialMngt = ObjAGTDraughtStop.AGTMaterialMngt
+
+        :return: AGTMaterialMngt
+        """
+
+        return AGTMaterialMngt(self.com_object.AGTMaterialMngt)
+
+    def __repr__(self):
+        return f'AgtDraughtStop(name="{self.name}")'

pycatia3dx/agt/agt_draught_stops.py

@@ -0,0 +1,89 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+from typing import Iterator
+
+from pycatia3dx.agt.agt_draught_stop import AGTDraughtStop
+from pycatia3dx.system.collection import Collection
+from pycatia3dx.types.general import CATVariant
+
+
+class AGTDraughtStops(Collection):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.Collection
+                |                     AGTDraughtStops
+                | 
+                | Object for AGTDraughtStops.
+                | To retrieve DraughtStop from collection.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object, child_object=AGTDraughtStop)
+        self.com_object = com_object
+
+    def item(self, i_index: CATVariant) -> AGTDraughtStop:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Func Item(CATVariant iIndex) As AGTDraughtStop
+                |     Retrieves a DraughtStop from the collection of
+                |     DraughtStop.
+                | 
+                |     Parameters:
+                | 
+                |         iIndex
+                |             The index of DraughtStop. 
+                | 
+                |     Example:
+                | 
+                | 
+                |              This example retrieves in ThisDraughtStop the second DraughtStop,
+                |              
+                |              and in ThisDraughtStop the DraughtStop named MyDraughtStop.2 in
+                |              the DraughtStop collection. 
+                |              
+                | 
+                |              Dim myPart as CATIAPart
+                |              Set myPart = CATIA.ActiveEditor.ActievObject
+                |              Dim ThisAGTRoot As AGTRoot
+                |              Set ThisAGTRoot = myPart.GetItem("CATAGTRoot")
+                |              Dim ThisDraughtStop As AGTDraughtStop
+                |              Set ThisDraughtStop = ThisAGTRoot.DraughtStops.Item(2)
+                |              Dim ThisDraughtStop As AGTDraughtStop
+                |              Set ThisDraughtStop = ThisAGTRoot.DraughtStops.Item("MyDraughtStop.2")
+
+        :param CATVariant i_index:
+        :return: AGTDraughtStop
+        """
+        return AGTDraughtStop(self.com_object.Item(i_index))
+
+    def __getitem__(self, n: int) -> AGTDraughtStop:
+        if (n + 1) > self.count:
+            raise StopIteration
+
+        return AGTDraughtStop(self.com_object.Item(n + 1))
+
+    def __iter__(self) -> Iterator[AGTDraughtStop]:
+        for i in range(self.count):
+            yield AGTDraughtStop(self.com_object.Item(i + 1))
+
+    def __repr__(self):
+        return f'AGTDraughtStops(name="{self.name}")'

pycatia3dx/agt/agt_fire_bridge.py

@@ -0,0 +1,91 @@
+"""
+    Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090
+
+    .. warning::
+        The notes denoted "3DEXPERIENCE Automation Help" are to be used as reference only.
+        They are there as a guide as to how the visual basic / catscript functions work
+        and thus help debugging in pycatia.
+        
+"""
+from pycatia3dx.agt.agt_category_mngt import AGTCategoryMngt
+from pycatia3dx.agt.agt_material_mngt import AGTMaterialMngt
+from pycatia3dx.system.any_object import AnyObject
+
+
+class AGTFireBridge(AnyObject):
+    """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+
+                | SystemTS.IUnknown
+                |     System.IDispatch
+                |         System.CATBaseUnknown
+                |             System.CATBaseDispatch
+                |                 System.AnyObject
+                |                     AGTFireBridge
+                | 
+                | The interface to access a FireBridge.
+                | To return the management object.
+    
+    """
+
+    def __init__(self, com_object):
+        super().__init__(com_object)
+        self.com_object = com_object
+
+    @property
+    def agt_category_mngt(self) -> AGTCategoryMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTCategoryMngt() As AGTCategoryMngt (Read Only)
+                |     Returns the AGTCategoryMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjCategoryMngt the AGTCategoryMngt
+                |              object of the AGTFireBridge
+                |              
+                | 
+                |              Dim ObjCategoryMngt As AGTCategoryMngt 
+                |              Set ObjCategoryMngt = ObjAGTFirebridge.AGTCategoryMngt
+
+        :return: AGTCategoryMngt
+        """
+
+        return AGTCategoryMngt(self.com_object.AGTCategoryMngt)
+
+    @property
+    def agt_material_mngt(self) -> AGTMaterialMngt:
+        """
+        .. note::
+            :class: toggle
+
+            3DEXPERIENCE Automation Help (2025-09-28 13:20:20.191090)
+                | Property AGTMaterialMngt() As AGTMaterialMngt (Read Only)
+                |     Returns the AGTMaterialMngt object.
+                | 
+                |     Example:
+                | 
+                |          
+                | 
+                |              This example retrieves in ObjMaterialMngt the AGTMaterialMngt
+                |              object of the AGTFireBridge.
+                |              
+                | 
+                |              Dim ObjMaterialMngt As AGTMaterialMngt 
+                |              Set ObjMaterialMngt = ObjAGTFirebridge.AGTMaterialMngt
+
+        :return: AGTMaterialMngt
+        """
+
+        return AGTMaterialMngt(self.com_object.AGTMaterialMngt)
+
+    def __repr__(self):
+        return f'AgtFireBridge(name="{self.name}")'