Changeset 17fceea for src/Actions/ActionQueue.hpp

Timestamp:

Sep 13, 2017, 5:19:58 PM (8 years ago)

Author:

Frederik Heber <frederik.heber@…>

Children:

15acdb

Parents:

ab3827

Message:

ActionQueue has predicates to check if current Action is Process or MakroAction.

File:

• src/Actions/ActionQueue.hpp (modified) (1 diff)

src/Actions/ActionQueue.hpp ¶

@@ -180 +180 @@
   bool isIdle() const;
 
+  /** States whether the current Action in the ActionQueue is a Process.
+   *
+   * \return true - ActionQueue is currently executing a process.
+   */
+  bool isProcess() const;
+
+  /** States whether the current Action in the ActionQueue is a MakroAction.
+   *
+   * \return true - ActionQueue is currently executing a MakroAction.
+   */
+  bool isMakroAction() const;
+
+  /** Getter to the current Action.
+   *
+   * \note Using this ref is only useful during the execution of the Action, e.g.
+   * when an Action inside the ActionSequence of a MakroAction needs access to the
+   * MakroAction itself (to signal stop). \sa MoleCuilder::ForceAnnealingAction::performCall()
+   *
+   * \warning Due to the multi-threaded nature of the ActionQueue this is very
+   * dangerous to use in other circumstances.
+   *
+   * \return const ref to the currently executed action
+   */
+  const Action& getCurrentAction() const;
+
 private:
   //!> grant Action access to internal history functions.