Add ComponentSelector feature: IS portion

src/InfrastructureSystems.jl

@@ -112,6 +112,7 @@ include("forecasts.jl")
 include("static_time_series.jl")
 include("time_series_parameters.jl")
 include("containers.jl")
+include("component_container.jl")
 include("component_uuids.jl")
 include("geographic_supplemental_attribute.jl")
 include("generated/includes.jl")
@@ -136,11 +137,12 @@ include("supplemental_attribute_manager.jl")
 include("components.jl")
 include("iterators.jl")
 include("component.jl")
-include("results.jl")
 include("serialization.jl")
 include("system_data.jl")
 include("subsystems.jl")
 include("validation.jl")
+include("component_selector.jl")
+include("results.jl")
 include("utils/print.jl")
 include("utils/test.jl")
 include("units.jl")

src/Optimization/Optimization.jl

@@ -18,6 +18,14 @@ import ..InfrastructureSystems:
     InfrastructureSystemsType,
     InfrastructureSystemsComponent,
     Results,
+    get_base_power,
+    get_variables,
+    get_parameters,
+    get_total_cost,
+    get_optimizer_stats,
+    get_timestamp,
+    write_results,
+    get_source_data,
     TimeSeriesCacheKey,
     TimeSeriesCache,
     configure_logging,
@@ -26,7 +34,8 @@ import ..InfrastructureSystems:
     get_uuid,
     compute_file_hash,
     convert_for_path,
-    InvalidValue
+    InvalidValue,
+    COMPONENT_NAME_DELIMITER
 
 using DocStringExtensions
 

src/Optimization/optimization_container_keys.jl

@@ -1,6 +1,5 @@
 abstract type OptimizationContainerKey end
 
-const _DELIMITER = "__"
 const CONTAINER_KEY_EMPTY_META = ""
 
 function make_key(::Type{T}, args...) where {T <: OptimizationContainerKey}
@@ -19,15 +18,15 @@ function encode_symbol(
     ::Type{U},
     meta::String = CONTAINER_KEY_EMPTY_META,
 ) where {T <: InfrastructureSystemsType, U}
-    meta_ = isempty(meta) ? meta : _DELIMITER * meta
-    T_ = replace(replace(strip_module_name(T), "{" => _DELIMITER), "}" => "")
-    return Symbol("$(strip_module_name(string(U)))$(_DELIMITER)$(T_)" * meta_)
+    meta_ = isempty(meta) ? meta : COMPONENT_NAME_DELIMITER * meta
+    T_ = replace(replace(strip_module_name(T), "{" => COMPONENT_NAME_DELIMITER), "}" => "")
+    return Symbol("$(strip_module_name(string(U)))$(COMPONENT_NAME_DELIMITER)$(T_)" * meta_)
 end
 
 function check_meta_chars(meta::String)
     # Underscores in this field will prevent us from being able to decode keys.
-    if occursin(_DELIMITER, meta)
-        throw(InvalidValue("'$_DELIMITER' is not allowed in meta"))
+    if occursin(COMPONENT_NAME_DELIMITER, meta)
+        throw(InvalidValue("'$COMPONENT_NAME_DELIMITER' is not allowed in meta"))
     end
 end
 

src/common.jl

@@ -41,6 +41,9 @@ const CONSTANT = Float64
 const LIM_TOL = 1e-6
 const XY_COORDS = @NamedTuple{x::Float64, y::Float64}
 
+"Delimiter to use when constructing qualified names like component_type__component_name."
+const COMPONENT_NAME_DELIMITER = "__"
+
 # See https://github.com/JuliaLang/julia/issues/18485
 "An equality predicate that is `true` for `NaN, NaN` (unlike `==`) and for `-0.0, 0.0` (unlike `isequal`)"
 isequivalent(x, y) = isequal(x, y) || (x == y)

src/component_container.jl

@@ -0,0 +1,71 @@
+"A data structure that acts like a container of components"
+abstract type ComponentContainer <: InfrastructureSystemsContainer end
+
+# For each of these functions, `ComponentContainer` concrete subtypes MUST either implement
+# appropriate methods or accept the default if it exists.
+#   - `get_components`: no default, must at least implement the `(type, system)` and `(filter_func, type, system)` signatures.
+#   - `get_component`: no default, must at least implement the `(type, system, name)` signature, may also want `(system, UUID)`, etc.
+#   - `get_available(::ComponentContainer, ::InfrastructureSystemsComponent)`: defaults to true
+#   - `get_available_components`: defaults to calling `get_components` with a filter function from `get_available`
+#   - `get_available_component`: defaults to calling `get_component` and checking `get_available`
+# The notion of availability used in `get_available` and `get_available_component(s)` is up
+# to the subtype, but it must be consistent across the three functions.
+
+"Get an iterator of components of a certain specification from the `ComponentContainer`."
+function get_components end
+
+"Get the single component that matches the given specification from the `ComponentContainer`, or `nothing` if there is no match."
+function get_component end
+
+"Get whether the given component of the given system is available for use (defaults to true)."
+get_available(::ComponentContainer, ::InfrastructureSystemsComponent) = true
+
+"Like [`get_components`](@ref) but only on components that are available."
+function get_available_components end
+
+"Like [`get_component`](@ref) but only on components that are available."
+function get_available_component end
+
+get_available_components(sys::ComponentContainer, args...; kwargs...) =
+    get_components(c -> get_available(sys, c), sys, args...; kwargs...)
+
+get_available_components(
+    ::Type{T},
+    sys::ComponentContainer,
+    args...;
+    kwargs...,
+) where {T <: InfrastructureSystemsComponent} =
+    get_components(c -> get_available(sys, c), T, sys, args...; kwargs...)
+
+get_available_components(
+    filter_func::Function,
+    ::Type{T},
+    sys::ComponentContainer,
+    args...;
+    kwargs...,
+) where {T <: InfrastructureSystemsComponent} =
+    get_components(x -> get_available(sys, x) && filter_func(x), T, sys, args...; kwargs...)
+
+# Helper function to most generically implement get_available_component
+function _get_available_component(sys::ComponentContainer, args...; kwargs...)
+    the_component = get_component(args...; kwargs...)
+    return get_available(sys, the_component) ? the_component : nothing
+end
+
+get_available_component(
+    ::Type{T},
+    sys::ComponentContainer,
+    name::AbstractString;
+    kwargs...,
+) where {T <: InfrastructureSystemsComponent} =
+    _get_available_component(sys, T, sys, name; kwargs...)
+
+get_available_component(sys::ComponentContainer, args...; kwargs...) =
+    _get_available_component(sys, sys, args...; kwargs...)
+
+# Satisfy the InfrastructureSystemsContainer interface
+iterate_container(sys::ComponentContainer) =
+    get_components(InfrastructureSystemsComponent, sys)
+
+get_num_members(sys::ComponentContainer) =
+    length(get_components(InfrastructureSystemsComponent, sys))