Support Layout types WIDE and LONG

Author: lukelowry

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## v.03
 
+- Added long monitor output layout and an ACTIVSg2000 PostgreSQL example.
+- Removed unused `VariableMonitorController::addVariable`.
 - Added `BusSignalVoltageOut` bus model with voltage signal outlets and current signal inlets.
 - Added `BusSignalVoltageIn` bus model with voltage signal inlets and current signal outlets.
 - Removed `BusToSignalAdapter`. Prefer `BusSignalVoltageOut` or `BusSignalVoltageIn`.

GridKit/Model/PhasorDynamics/Bus/BusImpl.hpp

@@ -66,7 +66,7 @@ namespace GridKit
     {
       bus_id_        = data.bus_id;
       size_          = 2;
-      monitor_       = std::make_unique<MonitorT>("Bus_" + data.name, data.monitored_variables);
+      monitor_       = std::make_unique<MonitorT>("Bus", data.name, data.monitored_variables);
       using Variable = typename ModelDataT::MonitorableVariables;
       monitor_->set(Variable::Vr, [this]
                     { return Vr(); });

GridKit/Model/PhasorDynamics/Bus/BusInfiniteImpl.hpp

@@ -65,7 +65,7 @@ namespace GridKit
     {
       bus_id_        = data.bus_id;
       size_          = 0;
-      monitor_       = std::make_unique<MonitorT>("Bus_" + data.name, data.monitored_variables);
+      monitor_       = std::make_unique<MonitorT>("Bus", data.name, data.monitored_variables);
       using Variable = typename ModelDataT::MonitorableVariables;
       monitor_->set(Variable::Vr, [this]
                     { return Vr(); });

GridKit/Model/PhasorDynamics/Bus/BusSignalVoltageIn/BusSignalVoltageInImpl.hpp

@@ -52,7 +52,7 @@ namespace GridKit
     {
       bus_id_        = data.bus_id;
       size_          = 0;
-      monitor_       = std::make_unique<MonitorT>("Bus_" + data.name, data.monitored_variables);
+      monitor_       = std::make_unique<MonitorT>("Bus", data.name, data.monitored_variables);
       using Variable = typename ModelDataT::MonitorableVariables;
       monitor_->set(Variable::Vr, [this]
                     { return Vr(); });

GridKit/Model/PhasorDynamics/Bus/BusSignalVoltageOut/BusSignalVoltageOutImpl.hpp

@@ -51,7 +51,7 @@ namespace GridKit
     {
       bus_id_        = data.bus_id;
       size_          = 2;
-      monitor_       = std::make_unique<MonitorT>("Bus_" + data.name, data.monitored_variables);
+      monitor_       = std::make_unique<MonitorT>("Bus", data.name, data.monitored_variables);
       using Variable = typename ModelDataT::MonitorableVariables;
       monitor_->set(Variable::Vr, [this]
                     { return Vr(); });

GridKit/Model/PhasorDynamics/INPUT_FORMAT.md

@@ -72,6 +72,7 @@ an output for monitored variables (those listed in the `mon` field of a
   `file_name`        | Optional string indicating output file name. If omitted, `stdout` is used.
   `format`           | One of { "CSV", "JSON", "YAML" } (case-insensitive)
   `delim`            | Optional string specifying delimiter to use for CSV output (default is `","`).
+  `layout`           | Optional, one of { "WIDE", "LONG" } (default is "WIDE"). "LONG" writes one row per variable and sample.
 
 __NOTE__: If `monitors` entry is omitted entirely, you will get the default CSV
 output to `stdout`. If you wish to change the console output format, use an

GridKit/Model/PhasorDynamics/SystemModelDataJSONParser.hpp

@@ -18,6 +18,7 @@ namespace GridKit
     using json          = nlohmann::json;
     using Log           = ::GridKit::Utilities::Logger;
     using MonitorFormat = ::GridKit::Model::VariableMonitorFormat;
+    using MonitorLayout = ::GridKit::Model::VariableMonitorLayout;
 
     /// JSON parser function implementation for the `SystemModelData` type
     ///
@@ -64,13 +65,14 @@ namespace GridKit
           auto fmt_str   = raw_mon.at("format").get<std::string>();
           auto format    = enum_parse(MonitorFormat{}, fmt_str);
           auto delim     = raw_mon.value("delim", std::string(","));
-          if (format.has_value())
+          auto layout    = enum_parse(MonitorLayout{}, raw_mon.value("layout", std::string("wide")));
+          if (format.has_value() && layout.has_value())
           {
-            sm.monitor_sink.emplace_back(format.value(), file_name, delim);
+            sm.monitor_sink.emplace_back(format.value(), file_name, delim, layout.value());
           }
           else
           {
-            Log::error() << "\n\tInvalid monitor format: \"" << fmt_str << "\"."
+            Log::error() << "\n\tInvalid monitor format or layout: " << raw_mon.dump()
                          << "\n\tSee the \"monitors\" list in your JSON file."
                          << std::endl;
           }

GridKit/Model/VariableMonitor.hpp

@@ -12,6 +12,7 @@
 #include <set>
 #include <sstream>
 #include <string>
+#include <string_view>
 #include <system_error>
 #include <type_traits>
 #include <variant>
@@ -29,7 +30,7 @@ namespace GridKit
     namespace VariableMonitorDetail
     {
       template <typename RealT>
-      std::string formatReal(RealT value)
+      void formatReal(std::string& out, RealT value)
       {
         std::array<char, 128> buffer{};
         constexpr auto        precision = std::numeric_limits<RealT>::digits10 + 1;
@@ -42,13 +43,14 @@ namespace GridKit
 
         if (ec == std::errc{})
         {
-          return std::string(buffer.data(), ptr);
+          out.append(buffer.data(), ptr);
+          return;
         }
 
         std::ostringstream os;
         os.precision(precision);
         os << std::scientific << value;
-        return os.str();
+        out += os.str();
       }
     } // namespace VariableMonitorDetail
 
@@ -63,6 +65,16 @@ namespace GridKit
       YAML  ///< YAML format
     };
 
+    /**
+     * @enum VariableMonitorLayout
+     * Available table layouts for monitor output
+     */
+    enum class VariableMonitorLayout
+    {
+      WIDE, ///< One row per sample with one column per variable
+      LONG  ///< One record per sample and variable
+    };
+
     /**
      * @brief Abstract class for managing output of monitored variables
      *
@@ -94,8 +106,20 @@ namespace GridKit
       {
       };
 
+      /// Type used for dispatch
+      struct Wide
+      {
+      };
+
+      /// Type used for dispatch
+      struct Long
+      {
+      };
+
       /// Short alias for local use
       using Format = VariableMonitorFormat;
+      /// Short alias for local use
+      using Layout = VariableMonitorLayout;
 
       /**
        * @brief Defines information necessary to create a monitor sink
@@ -108,6 +132,8 @@ namespace GridKit
         std::string file_name{};
         /// Delimiter (used only with CSV format currently)
         std::string delim{","};
+        /// Table layout
+        Layout      layout{Layout::WIDE};
       };
 
       virtual ~VariableMonitorBase()
@@ -119,50 +145,27 @@ namespace GridKit
        */
       virtual bool empty() const = 0;
 
-    protected:
-      ///@{
-      /**
-       * @brief Print items relevant to the start of a file
-       */
-      virtual void appendHeader(std::string&, Csv) const = 0;
+      /// Appends the formatted current value of a monitored variable
+      using ValueFormatter = std::function<void(std::string&)>;
 
-      virtual void appendHeader(std::string&, Json) const
-      {
-      }
-
-      virtual void appendHeader(std::string&, Yaml) const
-      {
-      }
-
-      ///@}
-
-      ///@{
-      /**
-       * @brief Print monitored variables at current state
-       */
-      virtual void append(std::string&, Csv) const  = 0;
-      virtual void append(std::string&, Json) const = 0;
-      virtual void append(std::string&, Yaml) const = 0;
-
-      ///@}
-
-      ///@{
       /**
-       * @brief Print items relevant to the end of a file
+       * @brief Monitored variable and the formatter of its current value
        */
-      virtual void appendFooter(std::string&, Csv) const
+      struct Entry
       {
-      }
-
-      virtual void appendFooter(std::string&, Json) const
-      {
-      }
-
-      virtual void appendFooter(std::string&, Yaml) const
-      {
-      }
+        /// Device class, such as `Genrou`
+        std::string_view      device_class;
+        /// Device identifier within its class
+        std::string_view      id;
+        /// Variable name
+        std::string_view      variable;
+        /// Formats the current value
+        const ValueFormatter* value;
+      };
 
-      ///@}
+    protected:
+      /// Append one entry per monitored variable
+      virtual void appendEntries(std::vector<Entry>&) const = 0;
     };
 
     template <typename eval_type, template <typename, typename> typename model_data_type>