Jd/add infos

Project.toml

@@ -21,7 +21,6 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 StructTypes = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
 TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 TerminalLoggers = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TimeSeries = "9e3dc215-6440-5c97-bce1-76c03772f85e"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
@@ -38,6 +37,13 @@ Mustache = "1"
 PrettyTables = "^1.3, 2"
 StructTypes = "^1.9"
 TerminalLoggers = "~0.1"
-TimeSeries = "~0.22, 0.23"
+TimeSeries = "0.23, 0.24"
 YAML = "~0.4"
 julia = "^1.6"
+Dates = "1"
+InteractiveUtils = "1"
+Logging = "1"
+Pkg = "1"
+Random = "1"
+TOML = "1"
+UUIDs = "1"

src/InfrastructureSystems.jl

@@ -53,6 +53,25 @@ Base type for auxillary structs. These should not be stored in a system.
 """
 abstract type DeviceParameter <: InfrastructureSystemsType end
 
+"""
+Base type for structs that store infos
+
+Required interface functions for subtypes:
+
+  - get_internal()
+
+Optional interface functions:
+
+  - get_time_series_container()
+  - get_components_uuid()
+  - get_uuid()
+
+Subtypes may contain time series. Which requires
+
+  - get_time_series_container()
+"""
+abstract type InfrastructureSystemsInfo <: InfrastructureSystemsType end
+
 """
 Return the internal time_series storage container or nothing, if the type doesn't store
 time series.
@@ -92,7 +111,11 @@ include("forecasts.jl")
 include("static_time_series.jl")
 include("time_series_container.jl")
 include("time_series_parser.jl")
+include("containers.jl")
+include("info.jl")
+include("infos.jl")
 include("components.jl")
+include("geographic_info.jl")
 include("generated/includes.jl")
 include("single_time_series.jl")
 include("deterministic_single_time_series.jl")

src/component.jl

@@ -46,6 +46,7 @@ function clear_time_series!(component::InfrastructureSystemsComponent)
         @debug "Cleared time_series in $(get_name(component))." _group =
             LOG_GROUP_TIME_SERIES
     end
+    return
 end
 
 function _get_columns(start_time, count, ts_metadata::ForecastMetadata)
@@ -585,6 +586,7 @@ function prepare_for_removal!(component::InfrastructureSystemsComponent)
     set_time_series_storage!(component, nothing)
     clear_time_series!(component)
     @debug "cleared all time series data from" _group = LOG_GROUP_SYSTEM get_name(component)
+    return
 end
 
 """
@@ -802,6 +804,7 @@ function clear_time_series_storage!(component::InfrastructureSystemsComponent)
             end
         end
     end
+    return
 end
 
 function set_time_series_storage!(
@@ -812,6 +815,7 @@ function set_time_series_storage!(
     if !isnothing(container)
         set_time_series_storage!(container, storage)
     end
+    return
 end
 
 function _get_time_series_storage(component::InfrastructureSystemsComponent)
@@ -868,3 +872,69 @@ function assign_new_uuid!(component::InfrastructureSystemsComponent)
     set_uuid!(get_internal(component), new_uuid)
     return
 end
+
+"""
+Attaches an info to a component
+"""
+function attach_info!(
+    component::InfrastructureSystemsComponent,
+    info::T,
+) where {T <: InfrastructureSystemsInfo}
+    component_uuid = get_uuid(component)
+
+    if component_uuid ∈ info.components_uuid
+        throw(
+            ArgumentError(
+                "Info type $T with UUID $(get_uuid(info)) already attached to component $(get_name(component))",
+            ),
+        )
+    end
+
+    push!(info.components_uuid, component_uuid)
+    infos_container = get_infos_container(component)
+
+    if !haskey(infos_container, T)
+        infos_container[T] = Set{T}()
+    end
+    push!(infos_container[T], info)
+    @debug "Info type $T with UUID $(get_uuid(info)) stored in component $(get_name(component))"
+    return
+end
+
+"""
+Return true if the component has infos.
+"""
+function has_infos(component::InfrastructureSystemsComponent)
+    container = get_infos_container(component)
+    return !isempty(container)
+end
+
+function clear_infos!(component::InfrastructureSystemsComponent)
+    container = get_infos_container(component)
+    for info_set in values(container)
+        for i in info_set
+            delete!(get_components_uuid(i), get_uuid(component))
+        end
+    end
+    empty!(container)
+    @debug "Cleared infos in $(get_name(component))."
+    return
+end
+
+function remove_info!(
+    component::InfrastructureSystemsComponent,
+    info::T,
+) where {T <: InfrastructureSystemsInfo}
+    container = get_infos_container(component)
+    if !haskey(container, T)
+        throw(
+            ArgumentError("info type $T is not stored in component $(get_name(component))"),
+        )
+    end
+    delete!(get_components_uuid(info), get_uuid(component))
+    delete!(container[T], info)
+    if isempty(container[T])
+        pop!(container, T)
+    end
+    return
+end

src/components.jl

@@ -1,12 +1,14 @@
 
 const ComponentsByType = Dict{DataType, Dict{String, <:InfrastructureSystemsComponent}}
 
-struct Components
+struct Components <: InfrastructureSystemsContainer
     data::ComponentsByType
     time_series_storage::TimeSeriesStorage
     validation_descriptors::Vector
 end
 
+get_display_string(::Components) = "components"
+
 function Components(time_series_storage::TimeSeriesStorage, validation_descriptors=nothing)
     if isnothing(validation_descriptors)
         validation_descriptors = Vector()
@@ -15,11 +17,6 @@ function Components(time_series_storage::TimeSeriesStorage, validation_descripto
     return Components(ComponentsByType(), time_series_storage, validation_descriptors)
 end
 
-function serialize(components::Components)
-    # time_series_storage and validation_descriptors are serialized elsewhere.
-    return [serialize(x) for y in values(components.data) for x in values(y)]
-end
-
 function _add_component!(
     components::Components,
     component::T;
@@ -91,6 +88,7 @@ function check_component(components::Components, comp::InfrastructureSystemsComp
     if !validate_struct(comp)
         throw(InvalidValue("$(summary(comp)) is invalid"))
     end
+    return
 end
 
 """
@@ -268,7 +266,7 @@ Call collect on the result if an array is desired.
 # Arguments
 
   - `T`: component type
-  - `components::Components`: Components of the sytem
+  - `components::Components`: Components of the system
   - `filter_func::Union{Nothing, Function} = nothing`: Optional function that accepts a component
     of type T and returns a Bool. Apply this function to each component and only return components
     where the result is true.
@@ -321,39 +319,15 @@ end
 See also: [`get_components`](@ref)
 """
 function iterate_components(components::Components)
-    Channel() do channel
-        for comp_dict in values(components.data)
-            for component in values(comp_dict)
-                put!(channel, component)
-            end
-        end
-    end
+    iterate_container(components)
 end
 
 function iterate_components_with_time_series(components::Components)
-    Channel() do channel
-        for comp_dict in values(components.data)
-            for component in values(comp_dict)
-                if has_time_series(component)
-                    put!(channel, component)
-                end
-            end
-        end
-    end
+    iterate_container_with_time_series(components)
 end
 
 function get_num_components(components::Components)
-    count = 0
-    for components in values(components.data)
-        count += length(components)
-    end
-    return count
-end
-
-function clear_time_series!(components::Components)
-    for component in iterate_components_with_time_series(components)
-        clear_time_series!(component)
-    end
+    return get_num_members(components)
 end
 
 function is_attached(
@@ -388,6 +362,7 @@ function set_name!(
     set_name_internal!(component, name)
     components.data[T][name] = component
     @debug "Changed the name of component $(summary(component))" _group = LOG_GROUP_SYSTEM
+    return
 end
 
 function compare_values(x::Components, y::Components; compare_uuids=false)

src/containers.jl

@@ -0,0 +1,46 @@
+abstract type InfrastructureSystemsContainer end
+
+function serialize(container::InfrastructureSystemsContainer)
+    # time_series_storage and validation_descriptors are serialized elsewhere.
+    return [serialize(x) for y in values(container.data) for x in values(y)]
+end
+
+"""
+Iterates over all data in the container.
+"""
+function iterate_container(container::InfrastructureSystemsContainer)
+    Channel() do channel
+        for m_dict in values(container.data)
+            for member in values(m_dict)
+                put!(channel, member)
+            end
+        end
+    end
+end
+
+function iterate_container_with_time_series(container::InfrastructureSystemsContainer)
+    Channel() do channel
+        for m_dict in values(container.data)
+            for member in values(m_dict)
+                if has_time_series(member)
+                    put!(channel, member)
+                end
+            end
+        end
+    end
+end
+
+function get_num_members(container::InfrastructureSystemsContainer)
+    count = 0
+    for members in values(container.data)
+        count += length(members)
+    end
+    return count
+end
+
+function clear_time_series!(container::InfrastructureSystemsContainer)
+    for member in iterate_components_with_time_series(container)
+        clear_time_series!(member)
+    end
+    return
+end

src/geographic_info.jl

@@ -0,0 +1,33 @@
+"""
+Base type for structs that store infos
+
+Required interface functions for subtypes:
+
+  - get_internal()
+  - get_components_uuid()
+  - get_time_series_container()
+
+Subtypes may contain time series, if no time series container is implemented return nothing
+"""
+struct InfrastructureSystemsGeo <: InfrastructureSystemsInfo
+    geo_json::Dict{String, Any}
+    components_uuid::Set{UUIDs.UUID}
+    internal::InfrastructureSystemsInternal
+end
+
+function InfrastructureSystemsGeo(;
+    geo_json::Dict{String, Any}=Dict{String, Any}(),
+    components_uuid::Set{UUIDs.UUID}=Set{UUIDs.UUID}(),
+)
+    return InfrastructureSystemsGeo(
+        geo_json,
+        components_uuid,
+        InfrastructureSystemsInternal(),
+    )
+end
+
+get_geo_json(geo::InfrastructureSystemsGeo) = geo.geo_json
+get_internal(geo::InfrastructureSystemsGeo) = geo.internal
+get_uuid(geo::InfrastructureSystemsGeo) = get_uuid(get_internal(geo))
+get_time_series_container(::InfrastructureSystemsGeo) = nothing
+get_components_uuid(geo::InfrastructureSystemsGeo) = geo.components_uuid