Merge pull request #3 from ModiaSim/development

Improvements

Author: MartinOtter

Project.toml

@@ -1,7 +1,7 @@
 name = "SignalTables"
 uuid = "3201582d-3078-4276-ba5d-0a1254d79d7c"
 authors = ["[email protected] <[email protected]>"]
-version = "0.3.0"
+version = "0.3.1"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

docs/src/index.md

@@ -183,6 +183,13 @@ are different to the Python 2.x version.
 
 ## Release Notes
 
+### Version 0.3.1
+
+- writeSignalTable(..): Do not store elements, that cannot be mapped to JSON + add _classVersion to signal table on file.
+- For backwards compatibilty to ModiaResult, also accept ENV["MODIA_PLOT_PACKAGE"] instead of ENV["SignalTablesPlotPackage"]
+  to define plot package.
+
+
 ### Version 0.3.0
 
 - Slightly non-backwards compatiable to 0.2.0.

src/PlotPackageDefinition.jl

@@ -14,7 +14,7 @@ macro usingPlotPackage()
     if haskey(ENV, "SignalTablesPlotPackage")
         PlotPackage = ENV["SignalTablesPlotPackage"]
         if !(PlotPackage in AvailablePlotPackages)
-            @warn "ENV[\"SignalTablesPlotPackage\"] = \"$PlotPackage\" is not supported!. Using \"SilentNoPlot\"."
+            @info "ENV[\"SignalTablesPlotPackage\"] = \"$PlotPackage\" is not supported!. Using \"SilentNoPlot\"."
             @goto USE_NO_PLOT
         elseif PlotPackage == "NoPlot"
             @goto USE_NO_PLOT
@@ -28,8 +28,25 @@ macro usingPlotPackage()
             return esc( :(using $PlotPackage) )
         end
 
+    elseif haskey(ENV, "MODIA_PLOT_PACKAGE")
+        PlotPackage = ENV["MODIA_PLOT_PACKAGE"]
+        if !(PlotPackage in AvailablePlotPackages)
+            @info "ENV[\"MODIA_PLOT_PACKAGE\"] = \"$PlotPackage\" is not supported!. Using \"SilentNoPlot\"."
+            @goto USE_NO_PLOT
+        elseif PlotPackage == "NoPlot"
+            @goto USE_NO_PLOT
+        elseif PlotPackage == "SilentNoPlot"
+            expr = :( import SignalTables.SilentNoPlot: plot, showFigure, saveFigure, closeFigure, closeAllFigures )
+            return esc( expr )
+        else
+            PlotPackage = Symbol("SignalTablesInterface_" * PlotPackage)
+            expr = :(using $PlotPackage)
+            println("$expr")
+            return esc( :(using $PlotPackage) )
+        end
+        
     else
-        @warn "No plot package activated. Using \"SilentNoPlot\"."
+        @info "No plot package activated. Using \"SilentNoPlot\"."
         @goto USE_NO_PLOT
     end
 

src/SignalTableFunctions.jl

@@ -675,13 +675,17 @@ the corresponding signals are encoded.
 """
 function encodeSignalTable(signalTable; signalNames=nothing)
     if isSignalTable(signalTable)
-        jdict = OrderedDict{String,Any}("_class" => "SignalTable")
+        jdict = OrderedDict{String,Any}("_class" => "SignalTable",
+                                        "_classVersion" => version)
         if isnothing(signalNames)
             signalNames = getSignalNames(signalTable)
         end
         for name in signalNames
             signal = getSignal(signalTable, name)
-            jdict[name] = encodeSignalTableElement(name, signal)
+            encodedSignal = encodeSignalTableElement(name, signal)
+            if !isnothing(encodedSignal)
+                jdict[name] = encodedSignal
+            end
         end
         return jdict
     else
@@ -696,23 +700,28 @@ end
 Encodes a signal table element suitable to convert to JSON format.
 """
 function encodeSignalTableElement(path, element)
-    if isVar(element)
-        jdict = OrderedDict{String,Any}("_class" => "Var")
-        for (key,val) in element
-            if key != :Var
-                jdict[string(key)] = encodeSignalTableElement(appendNames(path,key),val)
-            end
+    if isSignal(element)
+        if isVar(element)
+            jdict = OrderedDict{String,Any}("_class" => "Var")
+        else
+            jdict = OrderedDict{String,Any}("_class" => "Par")
         end
-        return jdict
-
-    elseif isPar(element)
-        jdict = OrderedDict{String,Any}("_class" => "Par")
+        available = true
         for (key,val) in element
-            if key != :Par
-                jdict[string(key)] = encodeSignalTableElement(appendNames(path,key),val)
+            if key != ":_class"
+                encodedSignal = encodeSignalTableElement(appendNames(path,key),val)
+                if isnothing(encodedSignal)
+                    available = false
+                else
+                    jdict[string(key)] = encodedSignal
+                end            
             end
         end
-        return jdict
+        if available
+            return jdict
+        else
+            return nothing
+        end
 
     elseif typeof(element) <: AbstractArray && (elementBaseType(eltype(element)) <: Number || elementBaseType(eltype(element)) <: String)
         if ndims(element) == 1 && string(elementBaseType(eltype(element))) in TypesWithoutEncoding 

src/SignalTables.jl

@@ -1,6 +1,7 @@
 module SignalTables
 
 const path = dirname(dirname(@__FILE__))
+const version = "0.3.1"   # version tag of SignalTables release without "v"
 
 using  OrderedCollections
 using  Unitful