Changeset ecc050

Timestamp:

May 19, 2021, 7:06:29 PM (4 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.0, stable

Children:

923ce2

Parents:

8c9cce

git-author:

Frederik Heber <frederik.heber@…> (04/24/19 21:29:22)

git-committer:

Frederik Heber <frederik.heber@…> (05/19/21 19:06:29)

Message:

pyMoleCuilder's wait() has return value.

• tells whether actions have been executed successfully or not.
• DOCU: updated docu

Files:

• doc/userguide/userguide.xml (modified) (2 diffs)
• src/Python/PythonScripting_impl.hpp (modified) (1 diff)
• src/Python/modules.hpp (modified) (1 diff)
• src/Python/wait.cpp (modified) (2 diffs)
• src/cleanUp.cpp (modified) (1 diff)
• src/cleanUp.hpp (modified) (1 diff)

doc/userguide/userguide.xml

@@ -1603 +1603 @@
           <programlisting>... change-box &quot;20,0,20,0,0,20&quot;</programlisting>
           <para>As the domain matrix is symmetric, six values suffice to fully
-          specify it. We have to give the six components of the lower triangle           matrix. Here, we change the box to a cuboid of equal edge length of
-          20.<warning>
-              <para>In case of the python interface an upper triangle matrix is given. Hence, the above would read &quot;20,0,0,20,0,20&quot;.</para>
-            </warning></para>
+          specify it. We have to give the six components of the lower triangle
+          matrix. Here, we change the box to a cuboid of equal edge length of
+          20.
+          <warning>
+            <para>In case of the python interface an upper triangle matrix is given. Hence, the above would read &quot;20,0,0,20,0,20&quot;.</para>
+          </warning></para>
         </section>
         <section xml:id="domain.bound-in-box">
@@ -3244 +3246 @@
       <programlisting>
          mol.MoleculeLoad("...")
-         mol.wait()
+         status = mol.wait()
       </programlisting>
-      <para>This will continue first after the molecule has been fully loaded.
-      </para>
+      <para>This will continue first only after the molecule has been fully 
+      loaded. Moreover, wait returns whether the actions contained executed
+      succesfully.</para>
       <warning>These wait()s will have no effect if the python script is loaded
       via the "load-session" command inside a User Interface (command-line,

src/Python/PythonScripting_impl.hpp

@@ -95 +95 @@
       "Reinitializes the internal state of the python module as if it had been freshly imported,saves all input files beforehand."
   );
-  boost::python::def(
+  boost::python::def< bool() >(
       "wait",
       MoleCuilder::detail::module_wait,

src/Python/modules.hpp

@@ -25 +25 @@
 void module_exit();
 void module_reinit();
-void module_wait();
+bool module_wait();
 
 typedef std::vector<atomId_t> atomIdVec;

src/Python/wait.cpp

@@ -42 +42 @@
 #include "cleanUp.hpp"
 
-void MoleCuilder::detail::module_wait()
+bool MoleCuilder::detail::module_wait()
 {
+  bool retval = true;
   // prevent wait() in python scripts in case of present UI (loaded sessions)
 #ifdef HAVE_ACTION_THREAD
@@ -49 +50 @@
     LOG(0, "Waiting for action queue to idle.");
     waitQueue();
+    retval = getOkQueue();
   }
 #endif
+  return retval;
 }

src/cleanUp.cpp

@@ -244 +244 @@
   MoleCuilder::ActionQueue::getInstance().wait();
 }
-#endif
+
+/** Returns whether last action did ok.
+ *
+ */
+bool getOkQueue()
+{
+  return MoleCuilder::ActionQueue::getConstInstance().getLastActionOk();
+}
+#endif
+
+

src/cleanUp.hpp

@@ -22 +22 @@
 void stopQueue();
 void waitQueue();
+bool getOkQueue();
 #endif