add function to strip metadata type

Author: hexaeder

src/NetworkDynamics.jl

@@ -88,11 +88,11 @@ export initialize_component, initialize_component!, init_residual
 export initialize_componentwise, initialize_componentwise!, interface_values
 include("initialization.jl")
 
-export has_metadata, get_metadata, set_metadata!, delete_metadata!
-export has_default, get_default, set_default!, delete_default!, set_defaults!
-export has_guess, get_guess, set_guess!, delete_guess!
-export has_init, get_init, set_init!, delete_init!
-export has_bounds, get_bounds, set_bounds!, delete_bounds!
+export has_metadata, get_metadata, set_metadata!, delete_metadata!, strip_metadata!
+export has_default, get_default, set_default!, delete_default!, set_defaults!, strip_defaults!
+export has_guess, get_guess, set_guess!, delete_guess!, strip_guesses!
+export has_init, get_init, set_init!, delete_init!, strip_inits!
+export has_bounds, get_bounds, set_bounds!, delete_bounds!, strip_bounds!
 export has_graphelement, get_graphelement, set_graphelement!
 export get_initial_state, dump_initial_state, dump_state
 export has_callback, get_callbacks, set_callback!, add_callback!

src/metadata.jl

@@ -101,12 +101,33 @@ function delete_metadata!(c::ComponentModel, sym::Symbol, key::Symbol)
 end
 delete_metadata!(nw::Network, sym::SymbolicIndex, key::Symbol) = delete_metadata!(getcomp(nw, sym), sym.subidx, key)
 
+"""
+    strip_metadata!(c::ComponentModel, key::Symbol)
+
+Remove all metadata of type `key` from the component.
+"""
+function strip_metadata!(c::ComponentModel, key::Symbol)
+    md_dict = symmetadata(c)
+    for (sym, sym_md) in md_dict
+        delete!(sym_md, key)
+    end
+    return c
+end
+strip_metadata!(nw::Network, sym::SymbolicIndex, key::Symbol) = strip_metadata!(getcomp(nw, sym), key)
+
 # generate default methods for some per-symbol metadata fields
 for md in [:default, :guess, :init, :bounds]
     fname_has = Symbol(:has_, md)
     fname_get = Symbol(:get_, md)
     fname_set = Symbol(:set_, md, :!)
     fname_del = Symbol(:delete_, md, :!)
+    fname_strip = if md == :guess
+        :strip_guesses!
+    elseif md == :bounds
+        :strip_bounds!
+    else
+        Symbol(:strip_, string(md)*"s", :!)
+    end
     @eval begin
         """
             has_$($(QuoteNode(md)))(c::ComponentModel, sym::Symbol)
@@ -159,6 +180,17 @@ for md in [:default, :guess, :init, :bounds]
         See also [`has_$($(QuoteNode(md)))`](@ref), [`set_$($(QuoteNode(md)))!`](@ref).
         """
         $fname_del(c::Comp_or_NW, sym) = delete_metadata!(c, sym, $(QuoteNode(md)))
+
+        """
+            strip_$($(QuoteNode(md)))!(c::ComponentModel)
+            strip_$($(QuoteNode(md)))!(nw::Network, idx::Union{VIndex,EIndex})
+
+        Removes all `$($(QuoteNode(md)))` values from a component model,
+        or from a component referenced by `idx` in a network.
+
+        See also [`delete_$($(QuoteNode(md)))!`](@ref), [`set_$($(QuoteNode(md)))!`](@ref).
+        """
+        $fname_strip(c::Comp_or_NW) = strip_metadata!(c, $(QuoteNode(md)))
     end
 end
 

test/metadata_test.jl

@@ -421,3 +421,38 @@ end
         end
     end
 end
+
+@testset "strip_metadata! function" begin
+    # Create a test vertex model
+    vm = Lib.swing_mtk()
+
+    # Set up various metadata types
+    set_default!(vm, :θ, 1.0)
+    set_default!(vm, :ω, 2.0)
+    set_guess!(vm, :M, 5.0)
+    set_init!(vm, :Pmech, 3.0)
+    set_metadata!(vm, :θ, :custom, "test_value")
+
+    # Verify metadata was set
+    @test has_default(vm, :θ)
+    @test has_default(vm, :ω)
+    @test has_guess(vm, :M)
+    @test has_init(vm, :Pmech)
+    @test has_metadata(vm, :θ, :custom)
+
+    # Test stripping defaults
+    strip_metadata!(vm, :default)
+    @test !has_default(vm, :θ)
+    @test !has_default(vm, :ω)
+    # Other metadata should remain
+    @test has_guess(vm, :M)
+    @test has_init(vm, :Pmech)
+    @test has_metadata(vm, :θ, :custom)
+
+    # Test stripping custom metadata
+    strip_metadata!(vm, :custom)
+    @test !has_metadata(vm, :θ, :custom)
+    # Other metadata should remain
+    @test has_guess(vm, :M)
+    @test has_init(vm, :Pmech)
+end