Adding Process ID so PyAEDT can point to a specific instance of Electronics Desktop (#1187)

camuher · PipKat · web-flow · commit 270a5d32a9c0 · 2022-05-20T09:17:25.000+02:00
* Add a variable to the constructors of the classes needed to aim PyAEDT, running from CPython 3.x, at a specific instance of Electronics Desktop.  Only implemented and tested for the Hfss class and parent classes.  The parameter is optional and does not modify the behavior of previous examples.

* added aedt_process_id to: circuit, emit, hfss3dlayout, icepak, maxwell3d, maxwell2d, maxwellcircuit, mechanical, Qextractor, q3d, q2d, rmxprt, twinbuilder and their parent classes for uniformity.

* Improves style compliance.  Also adds aedt_process_id to RMxport ant twinbuilder parent classes which was overlooked in the previous commit, causing build failures.

* Minor edits to match the style

* Update pyaedt/application/Analysis.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/application/Analysis3D.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/application/Analysis3DLayout.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/application/AnalysisMaxwellCircuit.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/application/Design.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/circuit.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/desktop.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/emit.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/hfss.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/hfss3dlayout.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/icepak.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/maxwell.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/maxwell.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/maxwellcircuit.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/mechanical.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/q3d.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/q3d.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/rmxprt.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* Update pyaedt/twinbuilder.py

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;
diff --git a/pyaedt/application/Analysis.py b/pyaedt/application/Analysis.py
@@ -69,6 +69,9 @@ class Analysis(Design, object):
         Whether to release  AEDT on exit.
     student_version : bool
         Whether to enable the student version of AEDT.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     """
 
@@ -86,6 +89,7 @@ def __init__(
         student_version,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         self.setups = []
         Design.__init__(
@@ -101,6 +105,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self.logger.info("Design Loaded")
         self._setup = None
diff --git a/pyaedt/application/Analysis3D.py b/pyaedt/application/Analysis3D.py
@@ -61,6 +61,9 @@ class FieldAnalysis3D(Analysis, object):
     student_version : bool, optional
         Whether to enable the student version of AEDT. The default
         is ``False``.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
     """
 
     def __init__(
@@ -77,6 +80,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         Analysis.__init__(
             self,
@@ -92,6 +96,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self._osolution = self._odesign.GetModule("Solutions")
         self._oboundary = self._odesign.GetModule("BoundarySetup")
diff --git a/pyaedt/application/Analysis3DLayout.py b/pyaedt/application/Analysis3DLayout.py
@@ -55,6 +55,9 @@ class FieldAnalysis3DLayout(Analysis):
     student_version : bool, optional
         Whether to enable the student version of AEDT. The default
         is ``False``.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     """
 
@@ -72,6 +75,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         Analysis.__init__(
             self,
@@ -87,6 +91,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self._osolution = self._odesign.GetModule("SolveSetups")
         self._oexcitation = self._odesign.GetModule("Excitations")
diff --git a/pyaedt/application/AnalysisEmit.py b/pyaedt/application/AnalysisEmit.py
@@ -37,6 +37,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         Design.__init__(
             self,
@@ -51,6 +52,7 @@ def __init__(
             student_version,
             machine=machine,
             port=machine,
+            aedt_process_id=aedt_process_id,
         )
         self.solution_type = solution_type
         self.oanalysis = None
diff --git a/pyaedt/application/AnalysisMaxwellCircuit.py b/pyaedt/application/AnalysisMaxwellCircuit.py
@@ -35,6 +35,9 @@ class AnalysisMaxwellCircuit(Analysis):
         Whether to release AEDT on exit. The default is ``True``.
     student_version : bool, optional
         Whether open AEDT Student Version. The default is ``False``.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     """
 
@@ -50,6 +53,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
 
         Analysis.__init__(
@@ -66,6 +70,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self.solution_type = None
         self._modeler = ModelerMaxwellCircuit(self)
diff --git a/pyaedt/application/AnalysisNexxim.py b/pyaedt/application/AnalysisNexxim.py
@@ -36,6 +36,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         Analysis.__init__(
             self,
@@ -51,6 +52,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
 
         self._modeler = ModelerNexxim(self)
diff --git a/pyaedt/application/AnalysisRMxprt.py b/pyaedt/application/AnalysisRMxprt.py
@@ -32,6 +32,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         Analysis.__init__(
             self,
@@ -47,6 +48,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
 
         self._modeler = ModelerRMxprt(self)
diff --git a/pyaedt/application/AnalysisTwinBuilder.py b/pyaedt/application/AnalysisTwinBuilder.py
@@ -54,6 +54,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
 
         Analysis.__init__(
@@ -70,6 +71,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self.solution_type = solution_type
         self._modeler = ModelerTwinBuilder(self)
diff --git a/pyaedt/application/Design.py b/pyaedt/application/Design.py
@@ -308,6 +308,9 @@ class Design(object):
     student_version : bool, optional
         Whether to enable the student version of AEDT. The default
         is ``False``.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     """
 
@@ -366,6 +369,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         self._init_variables()
         # Get Desktop from global Desktop Environment
@@ -378,7 +382,14 @@ def __init__(
 
         if "pyaedt_initialized" not in dir(main_module):
             desktop = Desktop(
-                specified_version, non_graphical, new_desktop_session, close_on_exit, student_version, machine, port
+                specified_version,
+                non_graphical,
+                new_desktop_session,
+                close_on_exit,
+                student_version,
+                machine,
+                port,
+                aedt_process_id,
             )
             self._logger = desktop.logger
             self.release_on_exit = True
diff --git a/pyaedt/circuit.py b/pyaedt/circuit.py
@@ -61,6 +61,9 @@ class Circuit(FieldAnalysisCircuit, object):
         Port number of which start the oDesktop communication on already existing server.
         This parameter is ignored in new server creation. It works only on 2022R2.
         Remote Server must be up and running with command `"ansysedt.exe -grpcsrv portnum"`.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     Examples
     --------
@@ -111,6 +114,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         FieldAnalysisCircuit.__init__(
             self,
@@ -126,6 +130,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
 
         self.onetwork_data_explorer = self._desktop.GetTool("NdExplorer")
diff --git a/pyaedt/desktop.py b/pyaedt/desktop.py
@@ -290,6 +290,9 @@ class Desktop:
         Port number of which start the oDesktop communication on already existing server.
         This parameter is ignored in new server creation. It works only on 2022R2.
         Remote Server must be up and running with command `"ansysedt.exe -grpcsrv portnum"`.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     Examples
     --------
@@ -321,6 +324,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         """Initialize desktop."""
         self._main = sys.modules["__main__"]
@@ -332,6 +336,7 @@ def __init__(
         self._main.student_version = student_version
         self.machine = machine
         self.port = port
+        self.aedt_process_id = aedt_process_id
         if is_ironpython:
             self._main.isoutsideDesktop = False
         else:
@@ -363,7 +368,12 @@ def __init__(
                 if StrictVersion(version_key) < StrictVersion("2022.2.0") or not settings.use_grpc_api:
                     print("Launching PyAEDT outside Electronics Desktop with CPython and Pythonnet")
                     self._init_cpython(
-                        non_graphical, new_desktop_session, version, self._main.student_version, version_key
+                        non_graphical,
+                        new_desktop_session,
+                        version,
+                        self._main.student_version,
+                        version_key,
+                        aedt_process_id,
                     )
                 else:
                     self._init_cpython_new(non_graphical, new_desktop_session, version, self._main.student_version)
@@ -382,6 +392,7 @@ def __init__(
         settings.aedt_version = self.odesktop.GetVersion()[0:6]
         settings.machine = self.machine
         settings.port = self.port
+        self.aedt_process_id = self.odesktop.GetProcessID()  # bit of cleanup for consistency if used in future
 
         if _com == "ironpython":
             sys.path.append(
@@ -545,7 +556,16 @@ def _dispatch_win32(self, version):
         self._main.oDesktop = o_ansoft_app.GetAppDesktop()
         self._main.isoutsideDesktop = True
 
-    def _init_cpython(self, non_graphical, new_aedt_session, version, student_version, version_key):
+    def _init_cpython(
+        self,
+        non_graphical,
+        new_aedt_session,
+        version,
+        student_version,
+        version_key,
+        aedt_process_id=None,
+    ):
+
         base_path = self._main.sDesktopinstallDirectory
         sys.path.append(base_path)
         sys.path.append(os.path.join(base_path, "PythonFiles", "DesktopPlugin"))
@@ -561,7 +581,7 @@ def _init_cpython(self, non_graphical, new_aedt_session, version, student_versio
         processID = []
         if IsWindows:
             processID = self._get_tasks_list_windows(student_version)
-        if student_version and not processID:
+        if student_version and not processID:  # Opens an instance if processID is an empty list
             self._run_student()
         elif non_graphical or new_aedt_session or not processID:
             # Force new object if no non-graphical instance is running or if there is not an already existing process.
@@ -573,8 +593,12 @@ def _init_cpython(self, non_graphical, new_aedt_session, version, student_versio
         processID2 = []
         if IsWindows:
             processID2 = self._get_tasks_list_windows(student_version)
-        proc = [i for i in processID2 if i not in processID]
-        if not proc:
+        proc = [i for i in processID2 if i not in processID]  # Looking for the "new" process
+        if (
+            not proc and (not new_aedt_session) and aedt_process_id
+        ):  # if it isn't a new aedt session and a process ID is given
+            proc = [aedt_process_id]
+        elif not proc:
             proc = processID2
         if proc == processID2 and len(processID2) > 1:
             self._dispatch_win32(version)
diff --git a/pyaedt/emit.py b/pyaedt/emit.py
@@ -53,6 +53,9 @@ class Emit(FieldAnalysisEmit, object):
         Port number of which start the oDesktop communication on already existing server.
         This parameter is ignored in new server creation. It works only on 2022R2.
         Remote Server must be up and running with command `"ansysedt.exe -grpcsrv portnum"`.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     Examples
     --------
@@ -94,6 +97,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         """Constructor."""
         FieldAnalysisEmit.__init__(
@@ -110,6 +114,7 @@ def __init__(
             student_version,
             machine=machine,
             port=port,
+            aedt_process_id=aedt_process_id,
         )
 
     def __enter__(self):
diff --git a/pyaedt/hfss.py b/pyaedt/hfss.py
@@ -72,6 +72,9 @@ class Hfss(FieldAnalysis3D, object):
         Port number of which start the oDesktop communication on already existing server.
         This parameter is ignored in new server creation. It works only on 2022R2.
         Remote Server must be up and running with command `"ansysedt.exe -grpcsrv portnum"`.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     Examples
     --------
@@ -150,6 +153,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         FieldAnalysis3D.__init__(
             self,
@@ -165,6 +169,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
         self.field_setups = self._get_rad_fields()
 
diff --git a/pyaedt/hfss3dlayout.py b/pyaedt/hfss3dlayout.py
@@ -59,6 +59,9 @@ class Hfss3dLayout(FieldAnalysis3DLayout):
         Port number of which start the oDesktop communication on already existing server.
         This parameter is ignored in new server creation. It works only on 2022R2.
         Remote Server must be up and running with command `"ansysedt.exe -grpcsrv portnum"`.
+    aedt_process_id : int, optional
+        Only used when ``new_desktop_session = False``, specifies by process ID which instance
+        of Electronics Desktop to point PyAEDT at.
 
     Examples
     --------
@@ -103,6 +106,7 @@ def __init__(
         student_version=False,
         machine="",
         port=0,
+        aedt_process_id=None,
     ):
         FieldAnalysis3DLayout.__init__(
             self,
@@ -118,6 +122,7 @@ def __init__(
             student_version,
             machine,
             port,
+            aedt_process_id,
         )
 
     def __enter__(self):
diff --git a/pyaedt/icepak.py b/pyaedt/icepak.py
diff --git a/pyaedt/maxwell.py b/pyaedt/maxwell.py
diff --git a/pyaedt/maxwellcircuit.py b/pyaedt/maxwellcircuit.py
diff --git a/pyaedt/mechanical.py b/pyaedt/mechanical.py
diff --git a/pyaedt/q3d.py b/pyaedt/q3d.py
diff --git a/pyaedt/rmxprt.py b/pyaedt/rmxprt.py
diff --git a/pyaedt/twinbuilder.py b/pyaedt/twinbuilder.py
