ScenarioManager: added displayStringTextFormat NED parameter for spec…

…ify the text above the module

src/inet/common/scenario/ScenarioManager.cc

@@ -480,10 +480,28 @@ void ScenarioManager::processLifecycleCommand(const cXMLElement *node)
 
 void ScenarioManager::refreshDisplay() const
 {
-    char buf[80];
-    sprintf(buf, "total %d changes, %d left", numChanges, numChanges - numDone);
-    getDisplayString().setTagArg(ATTR_T, 0, buf);
+    auto text = StringFormat::formatString(par("displayStringTextFormat"), this);
+    getDisplayString().setTagArg("t", 0, text.c_str());
 }
 
+std::string ScenarioManager::resolveDirective(char directive) const
+{
+    switch (directive) {
+        case 'c':
+            return std::to_string(numChanges);
+        case 'd':
+            return std::to_string(numDone);
+        case 'l':
+            return std::to_string(numChanges - numDone); // "numLeft"
+        case 't':
+            return scheduledEvents.empty() ? "n/a" : scheduledEvents.front()->getArrivalTime().str() + "s";
+        case 'n':
+            return scheduledEvents.empty() ? "n/a" : scheduledEvents.front()->getName();
+        default:
+            throw cRuntimeError("Unknown directive: %c", directive);
+    }
+}
+
+
 } // namespace inet
 

src/inet/common/scenario/ScenarioManager.h

@@ -13,6 +13,7 @@
 #include "inet/common/lifecycle/LifecycleController.h"
 #include "inet/common/scenario/IScriptable.h"
 #include "inet/common/scenario/ScenarioTimer_m.h"
+#include "inet/common/StringFormat.h"
 
 namespace inet {
 
@@ -41,7 +42,7 @@ class INET_API cPostModuleInitNotification : public cModelChangeNotification
  *
  * @see IScriptable
  */
-class INET_API ScenarioManager : public cSimpleModule, public LifecycleController
+class INET_API ScenarioManager : public cSimpleModule, public LifecycleController, public StringFormat::IDirectiveResolver
 {
   protected:
     // total number of changes, and number of changes already done
@@ -75,6 +76,8 @@ class INET_API ScenarioManager : public cSimpleModule, public LifecycleControlle
     virtual void processModuleSpecificCommand(const cXMLElement *node);
     virtual void processLifecycleCommand(const cXMLElement *node);
 
+    virtual std::string resolveDirective(char directive) const override;
+
   public:
     ScenarioManager() {}
 

src/inet/common/scenario/ScenarioManager.ned

@@ -113,6 +113,11 @@ simple ScenarioManager
 {
     parameters:
         xml script = default(xml("<script></script>"));
+
+        // Format for the text displayed above the module icon.
+        // Directives: %c: numChanges, %d: numDone, %l: numLeft, %t: nextEventTime, %n: nextEventName
+        string displayStringTextFormat = default("total %c changes, %l left\nnext at: %t");
+
         @display("i=block/control");
         @labels(node,mpls-node);
 }