Merge pull request #874 from mimiframework/default-symbol

Allow setting a default Symbol or String
mimiframework · Nov 17, 2021 · 288c1e2 · 288c1e2
2 parents 5c683a5 + 943fd46
commit 288c1e2
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/src/core/defcomp.jl b/src/core/defcomp.jl
@@ -83,8 +83,9 @@ end
 
 function add_parameter(comp_def::ComponentDef, name, datatype, dimensions, description, unit, default)
     if default !== nothing
-        if length(dimensions) != ndims(default)
-            error("Default value has different number of dimensions ($(ndims(default))) than parameter '$name' ($(length(dimensions)))")
+        ndims_default = (default isa Symbol || default isa String) ? 0 : ndims(default)
+        if length(dimensions) != ndims_default
+            error("Default value has different number of dimensions ($(ndims_default))) than parameter '$name' ($(length(dimensions)))")
         end
     end
     p = ParameterDef(name, comp_def.comp_path, datatype, dimensions, description, unit, default)

diff --git a/test/test_defaults.jl b/test/test_defaults.jl
@@ -58,4 +58,18 @@ run(m)
 @test m[:A, :p1] == 40
 @test Mimi.model_param(m, :model_p1).value == 30
 
+# try setting defaults for Strings or Symbols
+@defcomp A begin
+    p1 = Parameter{String}(default = "hello")
+    p2 = Parameter{Symbol}(default = :goodbye)
+end
+
+m = Model()
+set_dimension!(m, :time, 1:10)
+add_comp!(m, A)
+run(m)
+
+@test m[:A, :p1] == "hello"
+@test m[:A, :p2] == :goodbye
+
 end