InfrastructureSystems API Reference

Provides customization of HDF5 compression settings. Refer to the HDF5.jl and HDF5 documention for more information.

Thrown upon detection of user data that is not supported.

mutable struct Deterministic <: AbstractDeterministic
    name::String
    data::SortedDict
    resolution::Dates.Period
    scaling_factor_multiplier::Union{Nothing, Function}
    internal::InfrastructureSystemsInternal
end

A deterministic forecast for a particular data field in a Component.

Arguments

• name::String: user-defined name
• data::SortedDict: timestamp - scalingfactor
• resolution::Dates.Period: forecast resolution
• scaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• internal::InfrastructureSystemsInternal

Deterministic(
    name::AbstractString,
    input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Deterministic

Construct Deterministic from a Dict of TimeArrays.

Arguments

• name::AbstractString: user-defined name
• input_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.
• timestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.

Deterministic(
    name::AbstractString,
    filename::AbstractString,
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Deterministic

Construct Deterministic from a CSV file. The first column must be a timestamp in DateTime format and the columns the values in the forecast window.

Arguments

• name::AbstractString: user-defined name
• filename::AbstractString: name of CSV file containing data
• component::InfrastructureSystemsComponent: component associated with the data
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.

Deterministic(
    name::AbstractString,
    series_data::InfrastructureSystems.RawTimeSeries,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Deterministic

Construct Deterministic from RawTimeSeries.

Deterministic(
    src::InfrastructureSystems.Deterministic,
    name::AbstractString;
    scaling_factor_multiplier
) -> InfrastructureSystems.Deterministic

Construct Deterministic that shares the data from an existing instance.

This is useful in cases where you want a component to use the same time series data for two different attributes.

Deterministic(
    forecast::InfrastructureSystems.Deterministic,
    data
) -> InfrastructureSystems.Deterministic

Construct a new Deterministic from an existing instance and a subset of data.

mutable struct DeterministicMetadata <: ForecastMetadata
    name::String
    resolution::Dates.Period
    initial_timestamp::Dates.DateTime
    interval::Dates.Period
    count::Int
    time_series_uuid::UUIDs.UUID
    horizon::Dates.Period
    time_series_type::Type{<:AbstractDeterministic}
    scaling_factor_multiplier::Union{Nothing, Function}
    features::Dict{String, Union{Bool, Int, String}}
    internal::InfrastructureSystemsInternal
end

A deterministic forecast for a particular data field in a Component.

Arguments

• name::String: user-defined name
• resolution::Dates.Period:
• initial_timestamp::Dates.DateTime: time series availability time
• interval::Dates.Period: time step between forecast windows
• count::Int: number of forecast windows
• time_series_uuid::UUIDs.UUID: reference to time series data
• horizon::Dates.Period: length of this time series
• time_series_type::Type{<:AbstractDeterministic}: Type of the time series data associated with this metadata.
• scaling_factor_multiplier::Union{Nothing, Function}: (default: nothing) Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• features::Dict{String, Union{Bool, Int, String}}: (default: Dict{String, Any}()) User-defined tags that differentiate multiple time series arrays that represent the same component attribute, such as different arrays for different scenarios or years.
• internal::InfrastructureSystemsInternal:

mutable struct DeterministicSingleTimeSeries <: AbstractDeterministic
    single_time_series::SingleTimeSeries
    initial_timestamp::Dates.DateTime
    interval::Dates.Period
    count::Int
    horizon::Int
end

A deterministic forecast for a particular data field in a Component that wraps a SingleTimeSeries.

Arguments

• single_time_series::SingleTimeSeries: wrapped SingleTimeSeries object
• initial_timestamp::Dates.DateTime: time series availability time
• interval::Dates.Period: time step between forecast windows
• count::Int: number of forecast windows
• horizon::Int: length of this time series

Base type for auxillary structs. These should not be stored in a system.

Specializes the behavior of SimpleLogger by adding timestamps and process and thread IDs.

Wrapper around Iterators.Flatten to provide total length.

Construct ForecastCache to automatically control caching of forecast data. Maintains some count of forecast windows in memory based on cache_size_bytes.

Call Base.iterate or get_next_time_series_array! to retrieve data. Each iteration will return a TimeSeries.TimeArray covering one forecast window of length horizon_count.

Arguments

• ::Type{T}: subtype of Forecast
• component::InfrastructureSystemsComponent: component
• name::AbstractString: forecast name
• start_time::Union{Nothing, Dates.DateTime} = nothing: forecast start time
• horizon_count::Union{Nothing, Int} = nothing: forecast horizon count
• cache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory
• ignore_scaling_factors = false: controls whether to ignore scaling_factor_multiplier in the time series instance

Attribute to store Geographic Information about the system components

Stores all time series data in an HDF5 file.

The file used is assumed to be temporary and will be automatically deleted when there are no more references to the storage object.

Hdf5TimeSeriesStorage(
    create_file::Bool;
    filename,
    directory,
    compression
) -> InfrastructureSystems.Hdf5TimeSeriesStorage

Constructs Hdf5TimeSeriesStorage.

Arguments

• create_file::Bool: create new file
• filename=nothing: if nothing, create a temp file, else use this name.
• directory=nothing: if set and filename is nothing, create a temp file in this directory. If it is not set, use the environment variable SIENNATIMESERIES_DIRECTORY. If that is not set, use tempdir(). This should be set if the time series data is larger than the tmp filesystem can hold.

Hdf5TimeSeriesStorage(

) -> InfrastructureSystems.Hdf5TimeSeriesStorage

Constructs Hdf5TimeSeriesStorage by creating a temp file.

Stores all time series data in memory.

InMemoryTimeSeriesStorage(
    hdf5_storage::InfrastructureSystems.Hdf5TimeSeriesStorage
) -> InfrastructureSystems.InMemoryTimeSeriesStorage

Constructs InMemoryTimeSeriesStorage from an instance of Hdf5TimeSeriesStorage.

Base type for structs that are stored in a system.

Required interface functions for subtypes:

• get_name()
• get_internal()

Subtypes may contain time series.

Internal storage common to InfrastructureSystems types.

InfrastructureSystemsInternal(
    u::Base.UUID
) -> InfrastructureSystems.InfrastructureSystemsInternal

Creates InfrastructureSystemsInternal with an existing UUID.

InfrastructureSystemsInternal(
;
    uuid,
    shared_system_references,
    units_info,
    ext
) -> InfrastructureSystems.InfrastructureSystemsInternal

Creates InfrastructureSystemsInternal with a new UUID.

Base type for any struct in the Sienna packages. All structs must implement a kwarg-only constructor to allow deserializing from a Dict.

LazyDictFromIterator creates a dictionary from an iterator, but only increments the iterator and adds items to the dictionary as it needs them. In the worst case it is identical to creating a dictionary by iterating over the entire list. Each V should have a K member.

Arguments

• K: type of the dictionary keys
• V: type of the dictionary values
• iter: any object implementing the Iterator interface
• getter::Function: method to call on V to get its K

Structure to represent the underlying data of linear functions. Principally used for the representation of cost functions f(x) = proportional_term*x + constant_term.

Arguments

• proportional_term::Float64: the proportional term in the represented function
• constant_term::Float64: the constant term in the represented function

Contains information describing a log event.

LogEventTracker() -> InfrastructureSystems.LogEventTracker
LogEventTracker(
    levels
) -> InfrastructureSystems.LogEventTracker

Tracks counts of all log events by level.

Examples

LogEventTracker()
LogEventTracker((Logging.Info, Logging.Warn, Logging.Error))

Redirects log events to multiple loggers. The primary use case is to allow logging to both a file and the console. Secondarily, it can track the counts of all log messages.

Example

MultiLogger([TerminalLogger(stderr), SimpleLogger(stream)], LogEventTracker())

MultiLogger(
    loggers::Array{T<:Base.CoreLogging.AbstractLogger}
) -> InfrastructureSystems.MultiLogger

Creates a MultiLogger with no event tracking.

Example

MultiLogger([TerminalLogger(stderr), SimpleLogger(stream)])

Indicate that the feature at hand happens to not be implemented for the given data even though it could be. If it is a category mistake to imagine this feature defined on that data, use another exception, like TypeError or ArgumentError.

Structure to represent piecewise linear data as a series of points: two points define one segment, three points define two segments, etc. The curve starts at the first point given, not the origin. Principally used for the representation of cost functions where the points store quantities (x, y), such as (MW, /h).

Arguments

• points::Vector{@NamedTuple{x::Float64, y::Float64}}: the points that define the function

Structure to represent a step function as a series of endpoint x-coordinates and segment y-coordinates: two x-coordinates and one y-coordinate defines a single segment, three x-coordinates and two y-coordinates define two segments, etc. This can be useful to represent the derivative of a PiecewiseLinearData, where the y-coordinates of this step function represent the slopes of that piecewise linear function, so there is also an optional field c that can be used to store the initial y-value of that piecewise linear function. Principally used for the representation of cost functions where the points store quantities (x, dy/dx), such as (MW, /MWh).

Arguments

• x_coords::Vector{Float64}: the x-coordinates of the endpoints of the segments
• y_coords::Vector{Float64}: the y-coordinates of the segments: y_coords[1] is the y-value between

x_coords[1] and x_coords[2], etc. Must have one fewer elements than x_coords.

• c::Union{Nothing, Float64}: optional, the value to use for the integral from 0 to x_coords[1] of this function

mutable struct Probabilistic <: Forecast
    name::String
    resolution::Dates.Period
    percentiles::Vector{Float64}
    data::SortedDict
    scaling_factor_multiplier::Union{Nothing, Function}
    internal::InfrastructureSystemsInternal
end

A Probabilistic forecast for a particular data field in a Component.

Arguments

• name::String: user-defined name
• resolution::Dates.Period: forecast resolution
• percentiles::Vector{Float64}: Percentiles for the probabilistic forecast
• data::SortedDict: timestamp - scalingfactor
• scaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• internal::InfrastructureSystemsInternal

Probabilistic(
    name::AbstractString,
    input_data::AbstractDict,
    percentiles::Vector,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Probabilistic

Construct Probabilistic from a SortedDict of Arrays.

Arguments

• name::AbstractString: user-defined name
• input_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.
• percentiles: Percentiles represented in the probabilistic forecast
• resolution::Dates.Period: The resolution of the forecast in Dates.Period`
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.

Probabilistic(
    name::AbstractString,
    input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray},
    percentiles::Vector{Float64};
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Probabilistic

Construct Probabilistic from a Dict of TimeArrays.

Arguments

• name::AbstractString: user-defined name
• input_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.
• percentiles: Percentiles represented in the probabilistic forecast
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.
• timestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.

Probabilistic(
    name::AbstractString,
    series_data::InfrastructureSystems.RawTimeSeries,
    percentiles::Vector,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Probabilistic

Construct Deterministic from RawTimeSeries.

Probabilistic(
    src::InfrastructureSystems.Probabilistic,
    name::AbstractString;
    scaling_factor_multiplier
) -> InfrastructureSystems.Probabilistic

Construct a Probabilistic that shares the data from an existing instance.

This is useful in cases where you want a component to use the same time series data for two different attributes.

mutable struct ProbabilisticMetadata <: ForecastMetadata
    name::String
    initial_timestamp::Dates.DateTime
    resolution::Dates.Period
    interval::Dates.Period
    count::Int
    percentiles::Vector{Float64}
    time_series_uuid::UUIDs.UUID
    horizon::Dates.Period
    scaling_factor_multiplier::Union{Nothing, Function}
    features::Dict{String, Union{Bool, Int, String}}
    internal::InfrastructureSystemsInternal
end

A Probabilistic forecast for a particular data field in a Component.

Arguments

• name::String: user-defined name
• initial_timestamp::Dates.DateTime: time series availability time
• resolution::Dates.Period:
• interval::Dates.Period: time step between forecast windows
• count::Int: number of forecast windows
• percentiles::Vector{Float64}: Percentiles for the probabilistic forecast
• time_series_uuid::UUIDs.UUID: reference to time series data
• horizon::Dates.Period: length of this time series
• scaling_factor_multiplier::Union{Nothing, Function}: (default: nothing) Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• features::Dict{String, Union{Bool, Int, String}}: (default: Dict{String, Any}()) User-defined tags that differentiate multiple time series arrays that represent the same component attribute, such as different arrays for different scenarios or years.
• internal::InfrastructureSystemsInternal:

Structure to represent the underlying data of quadratic functions. Principally used for the representation of cost functions f(x) = quadratic_term*x^2 + proportional_term*x + constant_term.

Arguments

• quadratic_term::Float64: the quadratic term in the represented function
• proportional_term::Float64: the proportional term in the represented function
• constant_term::Float64: the constant term in the represented function

QuadraticFunctionData(
    data::InfrastructureSystems.LinearFunctionData
) -> InfrastructureSystems.QuadraticFunctionData

Losslessly convert LinearFunctionData to QuadraticFunctionData

Wraps the data read from the text files with time series

Records user-defined events in JSON format.

Recorder(
    name::Symbol;
    io,
    mode,
    directory
) -> InfrastructureSystems.Recorder

Construct a Recorder.

Arguments

• name::Symbol: name of recorder
• io::Union{Nothing, IO}: If nothing, record events in a file using name.
• mode = "w": Only used when io is nothing.
• directory = ".": Only used when io is nothing.

To implement a sub-type of this you need to implement the methods below.

mutable struct Scenarios <: Forecast
    name::String
    resolution::Dates.Period
    scenario_count::Int64
    data::SortedDict
    scaling_factor_multiplier::Union{Nothing, Function}
    internal::InfrastructureSystemsInternal
end

A Discrete Scenario Based time series for a particular data field in a Component.

Arguments

• name::String: user-defined name
• resolution::Dates.Period: forecast resolution
• scenario_count::Int64: Number of scenarios
• data::SortedDict: timestamp - scalingfactor
• scaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• internal::InfrastructureSystemsInternal

Scenarios(
    name::AbstractString,
    input_data::AbstractDict,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Scenarios

Construct Scenarios from a SortedDict of Arrays.

Arguments

• name::AbstractString: user-defined name
• input_data::AbstractDict{Dates.DateTime, Matrix{Float64}}: time series data.
• resolution::Dates.Period: The resolution of the forecast in Dates.Period`
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.

Scenarios(
    name::AbstractString,
    input_data::AbstractDict{Dates.DateTime, <:TimeSeries.TimeArray};
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.Scenarios

Construct Scenarios from a Dict of TimeArrays.

Arguments

• name::AbstractString: user-defined name
• input_data::AbstractDict{Dates.DateTime, TimeSeries.TimeArray}: time series data.
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.
• timestamp = :timestamp: If the values are DataFrames is passed then this must be the column name that contains timestamps.

Scenarios(
    src::InfrastructureSystems.Scenarios,
    name::AbstractString;
    scaling_factor_multiplier
) -> InfrastructureSystems.Scenarios

Construct Scenarios that shares the data from an existing instance.

This is useful in cases where you want a component to use the same time series data for two different attributes.

mutable struct ScenariosMetadata <: ForecastMetadata
    name::String
    resolution::Dates.Period
    initial_timestamp::Dates.DateTime
    interval::Dates.Period
    scenario_count::Int64
    count::Int
    time_series_uuid::UUIDs.UUID
    horizon::Dates.Period
    scaling_factor_multiplier::Union{Nothing, Function}
    features::Dict{String, Union{Bool, Int, String}}
    internal::InfrastructureSystemsInternal
end

A Discrete Scenario Based time series for a particular data field in a Component.

Arguments

• name::String: user-defined name
• resolution::Dates.Period:
• initial_timestamp::Dates.DateTime: time series availability time
• interval::Dates.Period: time step between forecast windows
• scenario_count::Int64: Number of scenarios
• count::Int: number of forecast windows
• time_series_uuid::UUIDs.UUID: reference to time series data
• horizon::Dates.Period: length of this time series
• scaling_factor_multiplier::Union{Nothing, Function}: (default: nothing) Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• features::Dict{String, Union{Bool, Int, String}}: (default: Dict{String, Any}()) User-defined tags that differentiate multiple time series arrays that represent the same component attribute, such as different arrays for different scenarios or years.
• internal::InfrastructureSystemsInternal:

mutable struct SingleTimeSeries <: StaticTimeSeries
    name::String
    data::TimeSeries.TimeArray
    scaling_factor_multiplier::Union{Nothing, Function}
    internal::InfrastructureSystemsInternal
end

A deterministic forecast for a particular data field in a Component.

Arguments

• name::String: user-defined name
• data::TimeSeries.TimeArray: timestamp - scalingfactor
• scaling_factor_multiplier::Union{Nothing, Function}: Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• internal::InfrastructureSystemsInternal

SingleTimeSeries(
    name::AbstractString,
    filename::AbstractString,
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    resolution::Dates.Period;
    normalization_factor,
    scaling_factor_multiplier
) -> InfrastructureSystems.SingleTimeSeries

Construct SingleTimeSeries from a CSV file. The file must have a column that is the name of the component.

Arguments

• name::AbstractString: user-defined name
• filename::AbstractString: name of CSV file containing data
• component::InfrastructureSystemsComponent: component associated with the data
• resolution::Dates.Period: resolution of the time series
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.

SingleTimeSeries(
    name::AbstractString,
    data::Union{DataFrames.DataFrame, TimeSeries.TimeArray};
    normalization_factor,
    scaling_factor_multiplier,
    timestamp
) -> InfrastructureSystems.SingleTimeSeries

Construct SingleTimeSeries from a TimeArray or DataFrame.

Arguments

• name::AbstractString: user-defined name
• data::Union{TimeSeries.TimeArray, DataFrames.DataFrame}: time series data
• normalization_factor::NormalizationFactor = 1.0: optional normalization factor to apply to each data entry
• scaling_factor_multiplier::Union{Nothing, Function} = nothing: If the data are scaling factors then this function will be called on the component and applied to the data when get_time_series_array is called.
• timestamp = :timestamp: If a DataFrame is passed then this must be the column name that contains timestamps.

SingleTimeSeries(
    src::InfrastructureSystems.SingleTimeSeries,
    name::AbstractString;
    scaling_factor_multiplier
) -> InfrastructureSystems.SingleTimeSeries

Construct SingleTimeSeries that shares the data from an existing instance.

This is useful in cases where you want a component to use the same time series data for two different attribtues.

SingleTimeSeries(
    time_series::InfrastructureSystems.SingleTimeSeries,
    data::TimeSeries.TimeArray
) -> Any

Creates a new SingleTimeSeries from an existing instance and a subset of data.

SingleTimeSeries(
    name::String,
    resolution::Dates.Period,
    initial_time::Dates.DateTime,
    time_steps::Int64
) -> InfrastructureSystems.SingleTimeSeries

Construct SingleTimeSeries after constructing a TimeArray from initial_time and time_steps.

mutable struct SingleTimeSeriesMetadata <: StaticTimeSeriesMetadata
    name::String
    resolution::Dates.Period
    initial_timestamp::Dates.DateTime
    time_series_uuid::UUIDs.UUID
    length::Int
    scaling_factor_multiplier::Union{Nothing, Function}
    features::Dict{String, Union{Bool, Int, String}}
    internal::InfrastructureSystemsInternal
end

A TimeSeries Data object in contigous form.

Arguments

• name::String: user-defined name
• resolution::Dates.Period:
• initial_timestamp::Dates.DateTime: time series availability time
• time_series_uuid::UUIDs.UUID: reference to time series data
• length::Int: length of this time series
• scaling_factor_multiplier::Union{Nothing, Function}: (default: nothing) Applicable when the time series data are scaling factors. Called on the associated component to convert the values.
• features::Dict{String, Union{Bool, Int, String}}: (default: Dict{String, Any}()) User-defined tags that differentiate multiple time series arrays that represent the same component attribute, such as different arrays for different scenarios or years.
• internal::InfrastructureSystemsInternal:

Construct StaticTimeSeriesCache to automatically control caching of time series data. Maintains rows of data in memory based on cache_size_bytes.

Call Base.iterate or get_time_series_array to retrieve data. Each iteration will return a TimeSeries.TimeArray of size 1.

Arguments

• ::Type{T}: subtype of StaticTimeSeries
• component::InfrastructureSystemsComponent: component
• name::AbstractString: time series name
• cache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES: maximum size of data to keep in memory
• ignore_scaling_factors = false: controls whether to ignore scalingfactormultiplier in the time series instance

StructDefinition(
;
    struct_name,
    fields,
    supertype,
    docstring,
    is_component
)

Construct a StructDefinition for code auto-generation purposes.

Arguments

• struct_name::AbstractString: Struct name
• fields::Vector{StructField}: Struct fields. Refer to StructField.
• docstring::AbstractString: Struct docstring. Defaults to an empty string.
• supertype::Union{String, DataType}: Struct supertype. Defaults to no supertype.
• is_component::Bool: Set to true for component types that will be attached to a system. Do not set to Default to true.

StructField(
;
    name,
    data_type,
    default,
    comment,
    needs_conversion,
    exclude_setter,
    valid_range,
    validation_action,
    null_value,
    internal_default
)

Construct a StructField for code auto-generation purposes.

Arguments

• name::String: Field name
• data_type::Union{DataType, String}: Field type
• default::Any: The generated constructors will define this as a default value.
• comment::String: Include this comment above the field name. Defaults to empty string.
• needs_conversion::Bool: Set to true if the getter and setter functions need to apply unit conversion. The type must implement get_value(::Component, ::Type) and set_value(::Component, ::Type) for this combination of component type and field type.
• exclude_setter::Bool: Do not generate a setter function for this field. Defaults to false.
• valid_range::Union{Nothing, String, Dict}: Enables range validation when the component is added to a system. Define this as a Dict with "min" and "max" or as a String with the field name in the struct that defines this field's valid range and InfrastructureSystems will validate any value against that range. Use nothing if one doesn't apply, such as if there is no max limit.
• validation_action: Define this as "error" or "warn". If it is "error" then InfrastructureSystems will throw an exception if the validation code detects a problem. Otherwise, it will log a warning.
• null_value::Any: Value to indicate the field is zero or empty, such as 0.0 for Float64. If all members in the struct define this field then a "demo" constructor will be generated. This allows entering val = MyType(nothing) in the REPL to see the layout of a struct without worrying about valid values.
• internal_default: Set to true for non-user-facing fields like InfrastructureSystemsInternal that have default values.

Base type for structs that store supplemental attributes

Required interface functions for subtypes:

• get_internal()

Optional interface functions:

• get_uuid()

Subtypes may contain time series. Which requires

• supportstimeseries(::SupplementalAttribute)

All subtypes must include an instance of ComponentUUIDs in order to track components attached to each attribute.

SupplementalAttributeAssociations(

) -> InfrastructureSystems.SupplementalAttributeAssociations

Construct a new SupplementalAttributeAssociations with an in-memory database.

mutable struct SystemData <: InfrastructureSystemsType
    components::Components
    "Masked components are attached to the system for overall management purposes but
    are not exposed in the standard library calls like [`get_components`](@ref).
    Examples are components in a subsystem."
    masked_components::Components
    validation_descriptors::Vector
    internal::InfrastructureSystemsInternal
end

Container for system components and time series data

SystemData(
;
    validation_descriptor_file,
    time_series_in_memory,
    time_series_directory,
    compression
) -> InfrastructureSystems.SystemData

Construct SystemData to store components and time series data.

Arguments

• validation_descriptor_file = nothing: Optionally, a file defining component validation descriptors.
• time_series_in_memory = false: Controls whether time series data is stored in memory or in a file.
• time_series_directory = nothing: Controls what directory time series data is stored in. Default is the environment variable SIENNATIMESERIES_DIRECTORY or tempdir() if that isn't set.
• compression = CompressionSettings(): Controls compression of time series data.

Defines an association between a time series owner (component or supplemental attribute) and the time series metadata.

Examples

association1 = TimeSeriesAssociation(component, time_series)
association2 = TimeSeriesAssociation(component, time_series, scenario = "high")

Provides counts of time series including attachments to components and supplemental attributes.

Abstract type for time series stored in the system. Components store references to these through TimeSeriesMetadata values so that data can reside on storage media instead of memory.

Describes how to construct time_series from raw time series data files.

Abstract type for time_series that are stored in a system. Users never create them or get access to them. Stores references to TimeSeriesData.

TimeSeriesMetadataStore(
    filename::AbstractString
) -> InfrastructureSystems.TimeSeriesMetadataStore

Load a TimeSeriesMetadataStore from a saved database into an in-memory database.

TimeSeriesMetadataStore(

) -> InfrastructureSystems.TimeSeriesMetadataStore

Construct a new TimeSeriesMetadataStore with an in-memory database.

Abstract type for time series storage implementations.

All subtypes must implement:

• cleartimeseries!
• deserializetimeseries
• getcompressionsettings
• getnumtime_series
• removetimeseries!
• serializetimeseries!
• Base.isempty

close(logger::InfrastructureSystems.MultiLogger)

Ensures that any file streams are flushed and closed.

convert(
    _::Type{InfrastructureSystems.QuadraticFunctionData},
    data::InfrastructureSystems.LinearFunctionData
) -> InfrastructureSystems.QuadraticFunctionData

Losslessly convert LinearFunctionData to QuadraticFunctionData

flush(logger::InfrastructureSystems.MultiLogger)

Flush any file streams.

get(
    container::InfrastructureSystems.LazyDictFromIterator,
    key
) -> Any

Returns the item mapped to key. If the key is already stored then it will be returned with a dictionary lookup. If it has not been stored then iterate over the list until it is found.

Returns nothing if key is not found.

zero(
    _::Type{InfrastructureSystems.FunctionData}
) -> InfrastructureSystems.LinearFunctionData

Get a FunctionData representing the function f(x) = 0

zero(
    _::Union{InfrastructureSystems.LinearFunctionData, Type{InfrastructureSystems.LinearFunctionData}}
) -> InfrastructureSystems.LinearFunctionData

Get a LinearFunctionData representing the function f(x) = 0

_check_transform_single_time_series(
    data::InfrastructureSystems.SystemData,
    _::Type{InfrastructureSystems.DeterministicSingleTimeSeries},
    horizon::Dates.Period,
    interval::Dates.Period
) -> Vector{Any}

Check that all existing SingleTimeSeries can be converted to DeterministicSingleTimeSeries with the given horizon and interval.

Throw ConflictingInputsError if any time series cannot be converted.

Return a Vector of NamedTuple of component, time series metadata, and forecast parameters for all matches.

_get_all_concrete_subtypes(
    _::Type{T},
    sub_types::Vector{DataType}
)

Recursively builds a vector of subtypes.

_validate(
    data::InfrastructureSystems.SystemData,
    component::InfrastructureSystems.InfrastructureSystemsComponent
)

Checks that the component exists in data and is the same object.

add_association!(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    attribute::InfrastructureSystems.SupplementalAttribute
)

Add a supplemental attribute association to the associations. The caller must check for duplicates.

add_component!(
    components::InfrastructureSystems.Components,
    component::InfrastructureSystems.InfrastructureSystemsComponent;
    kwargs...
)

Add a component.

Throws ArgumentError if the component's name is already stored for its concrete type.

Throws InvalidRange if any of the component's field values are outside of defined valid range.

add_component_to_subsystem!(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString,
    component::InfrastructureSystems.InfrastructureSystemsComponent
)

Add a component to a subsystem.

add_metadata!(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    metadata::InfrastructureSystems.TimeSeriesMetadata
)

Add metadata to the store. The caller must check if there are duplicates.

add_serialization_metadata!(data::Dict, _::Type{T})

Add type information to the dictionary that can be used to deserialize the value.

add_subsystem!(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString
)

Add a new subsystem to the system.

add_time_series!(
    data::InfrastructureSystems.SystemData,
    components,
    time_series::InfrastructureSystems.TimeSeriesData;
    features...
) -> InfrastructureSystems.TimeSeriesKey

Add the same time series data to multiple components.

Arguments

• data::SystemData: SystemData
• components: iterable of components that will store the same time series reference
• time_series::TimeSeriesData: Any object of subtype TimeSeriesData

This is significantly more efficent than calling add_time_series! for each component individually with the same data because in this case, only one time series array is stored.

Throws ArgumentError if a component is not stored in the system.

add_time_series!(
    data::InfrastructureSystems.SystemData,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.TimeSeriesData;
    features...
) -> InfrastructureSystems.TimeSeriesKey

Add time series data to a component or supplemental attribute.

Arguments

• data::SystemData: SystemData
• owner::InfrastructureSystemsComponent: will store the time series reference
• time_series::TimeSeriesData: Any object of subtype TimeSeriesData

Throws ArgumentError if the owner is not stored in the system.

add_time_series_from_file_metadata!(
    data::InfrastructureSystems.SystemData,
    component_type::Type{<:InfrastructureSystems.InfrastructureSystemsComponent},
    file_metadata::Vector{InfrastructureSystems.TimeSeriesFileMetadata};
    resolution
) -> Vector{InfrastructureSystems.TimeSeriesKey}

Adds time series data from a metadata file or metadata descriptors.

Arguments

• data::SystemData: system
• file_metadata::Vector{TimeSeriesFileMetadata}: metadata for time series
• resolution::DateTime.Period=nothing: skip time_series that don't match this resolution.

add_time_series_from_file_metadata!(
    data::InfrastructureSystems.SystemData,
    ::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    metadata_file::AbstractString;
    resolution
) -> Vector{InfrastructureSystems.TimeSeriesKey}

Adds time_series from a metadata file or metadata descriptors.

Arguments

• data::SystemData: system
• ::Type{T}: type of the component associated with time series data; may be abstract
• metadata_file::AbstractString: metadata file for time series that includes an array of TimeSeriesFileMetadata instances or a vector.
• resolution::DateTime.Period=nothing: skip time_series that don't match this resolution.

assign_new_uuid_internal!(
    component::InfrastructureSystems.InfrastructureSystemsComponent
)

Return an instance of ForecastParameters for the given inputs.

Throws ConflictingInputsError if horizon and interval are incompatible with the metadata.

assign_new_uuid_internal!(
    obj::InfrastructureSystems.InfrastructureSystemsType
)

Assign a new UUID.

backup_to_temp(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> String

Backup the database to a file on the temporary filesystem and return that filename.

check_consistency(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    _::Type{InfrastructureSystems.SingleTimeSeries}
) -> Tuple{Any, Any}

Throw InvalidValue if the SingleTimeSeries arrays have different initial times or lengths. Return the initial timestamp and length as a tuple.

clear_components!(
    components::InfrastructureSystems.Components
)

Removes all components from the system.

clear_ext!(
    obj::InfrastructureSystems.InfrastructureSystemsInternal
)

Clear any value stored in ext.

clear_metadata!(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> SQLite.Query

Clear all time series metadata from the store.

clear_supplemental_attributes!(
    mgr::InfrastructureSystems.SupplementalAttributeManager
)

Removes all supplemental_attributes from the system.

Ignores whether attributes are attached to components.

clear_supplemental_attributes!(
    data::InfrastructureSystems.SystemData
)

Remove all supplemental attributes.

compare_over_fields(cmp_op, reduce_op, init, a, b) -> Any

For a and b, instances of the same concrete type, iterate over all the fields, compare a's value to b's using cmp_op, and reduce to one value using reduce_op with an initialization value of init.

compare_values(x, y; compare_uuids, exclude) -> Bool

Recursively compares struct values. Prints all mismatched values to stdout.

Arguments

• x::T: First value
• y::T: Second value
• compare_uuids::Bool = false: Compare any UUID in the object or composed objects.
• `exclude::Set{Symbol} = Set{Symbol}(): Fields to exclude from comparison. Passed on recursively and so applied per type.

compute_sha256(filename::AbstractString) -> String

Return the SHA 256 hash of a file.

configure_logging(
;
    console,
    console_stream,
    console_level,
    progress,
    file,
    filename,
    file_level,
    file_mode,
    tracker,
    set_global
) -> InfrastructureSystems.MultiLogger

Creates console and file loggers per caller specification and returns a MultiLogger.

Suppress noisy events by specifying per-event values of maxlog = X and _suppression_period = Y where X is the max number of events that can occur in Y seconds. After the period ends, messages will no longer be suppressed. Note that if you don't specify _suppression_period then maxlog applies for the for the duration of your process (standard Julia logging behavior).

Note: Use of log message suppression and the LogEventTracker are not thread-safe. Please contact the package developers if you need this functionality.

Note: If logging to a file users must call Base.close() on the returned MultiLogger to ensure that all events get flushed.

Arguments

• console::Bool=true: create console logger
• console_stream::IOStream=stderr: stream for console logger
• console_level::Logging.LogLevel=Logging.Error: level for console messages
• progress::Bool=true: enable progress logger
• file::Bool=true: create file logger
• filename::Union{Nothing, String}=log.txt: log file
• file_level::Logging.LogLevel=Logging.Info: level for file messages
• file_mode::String=w+: mode used when opening log file
• tracker::Union{LogEventTracker, Nothing}=LogEventTracker(): optionally track log events
• set_global::Bool=true: set the created logger as the global logger

Example

logger = configure_logging(filename="mylog.txt")
@info "hello world"
@info "hello world" maxlog = 5 _suppression_period = 10

copy_h5_file(src::AbstractString, dst::AbstractString)

Copies an HDF5 file to a new file. This should be used instead of a system call to copy because it won't copy unused space that results from deleting datasets.

copy_time_series!(
    dst::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    src::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute};
    name_mapping,
    scaling_factor_multiplier_mapping
)

Efficiently add all time_series in one component to another by copying the underlying references.

Arguments

• dst::TimeSeriesOwners: Destination owner
• src::TimeSeriesOwners: Source owner
• name_mapping::Dict = nothing: Optionally map src names to different dst names. If provided and src has a timeseries with a name not present in namemapping, that timeseries will not copied. If namemapping is nothing then all time_series will be copied with src's names.
• scaling_factor_multiplier_mapping::Dict = nothing: Optionally map src multipliers to different dst multipliers. If provided and src has a timeseries with a multiplier not present in scalingfactormultipliermapping, that timeseries will not copied. If scalingfactormultipliermapping is nothing then all time_series will be copied with src's multipliers.

deserialize(
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsType},
    data::Dict
) -> InfrastructureSystems.SystemData

Deserialize an object from standard types stored in non-Julia formats, such as JSON, into Julia types.

double_equals_from_fields(a, b) -> Any

Compute the conjunction of the == values of all the fields in a and b

drop_table(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
)

Drop the supplemental attribute associations table.

empty_group_levels!(
    logger::InfrastructureSystems.MultiLogger
)

Empty the minimum log levels stored for each group.

execute(
    db::SQLite.DB,
    query::AbstractString,
    params::Union{Nothing, Vector},
    log_group::Symbol
) -> SQLite.Query

Wrapper around SQLite.DBInterface.execute to provide log messages.

execute_count(
    db::SQLite.DB,
    query::AbstractString,
    params::Union{Nothing, Vector},
    log_group::Symbol
) -> Any

Run a query to find a count. The query must produce a column called count with one row.

from(
    time_series::InfrastructureSystems.SingleTimeSeries,
    timestamp
) -> InfrastructureSystems.SingleTimeSeries

Return a time_series truncated starting with timestamp.

from_file(
    ::Type{InfrastructureSystems.Hdf5TimeSeriesStorage},
    filename::AbstractString;
    read_only,
    directory
) -> InfrastructureSystems.Hdf5TimeSeriesStorage

Constructs Hdf5TimeSeriesStorage from an existing file.

from_h5_file(
    _::Type{InfrastructureSystems.TimeSeriesMetadataStore},
    src::AbstractString,
    directory
) -> InfrastructureSystems.TimeSeriesMetadataStore

Load a TimeSeriesMetadataStore from an HDF5 file into an in-memory database.

from_json(
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsType},
    filename::String
) -> Any

Deserializes a InfrastructureSystemsType from a JSON filename.

from_json(
    io::Union{IO, String},
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsType}
) -> InfrastructureSystems.TestComponent

Deserializes a InfrastructureSystemsType from String or IO.

generate_struct_file(
    definition::InfrastructureSystems.StructDefinition;
    filename,
    output_directory
)

Generate a Julia source code file for one struct from a StructDefinition.

Refer to StructDefinition and StructField for descriptions of the available fields.

Arguments

• definition::StructDefinition: Defines the struct and all fields.
• filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/structs.json
• output_directory::AbstractString: Generate the files in this directory. Defaults to src/generated

generate_struct_files(
    definitions;
    filename,
    output_directory
)

Generate Julia source code files for multiple structs from a iterable of StructDefinition instances.

Refer to StructDefinition and StructField for descriptions of the available fields.

Arguments

• definitions: Defines the structs and all fields.
• filename::AbstractString: Add the struct definition to this JSON file. Defaults to src/descriptors/power_system_structs.json
• output_directory::AbstractString: Generate the files in this directory. Defaults to src/generated

get_abstract_subtypes(_::Type{T}) -> Vector

Returns an array of abstract types that are direct subtypes of T.

get_all_concrete_subtypes(_::Type{T}) -> Any

Returns an array of all concrete subtypes of T. Caches the values for faster lookup on repeated calls.

Note that this does not find parameterized types. It will also not find types dynamically added after the first call of given type.

get_assigned_subsystems(
    data::InfrastructureSystems.SystemData,
    component::InfrastructureSystems.InfrastructureSystemsComponent
) -> Vector

Return a Vector of subsystem names that contain the component.

get_attribute_counts_by_type(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
) -> Vector

Return a Vector of OrderedDict of stored time series counts by type.

get_attribute_summary_table(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
) -> DataFrames.DataFrame

Return a DataFrame with the number of supplemental attributes by type for components.

get_component(
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    components::InfrastructureSystems.Components,
    name::AbstractString
) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}

Get the component of type T with name. Returns nothing if no component matches. If T is an abstract type then the names of components across all subtypes of T must be unique.

See get_components_by_name for abstract types with non-unique names across subtypes.

Throws ArgumentError if T is not a concrete type and there is more than one component with requested name

get_components(
    ::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    components::InfrastructureSystems.Components;
    component_uuids
) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:InfrastructureSystems.InfrastructureSystemsComponent, I<:(Vector)}

Returns an iterator of components. T can be concrete or abstract. Call collect on the result if an array is desired.

Arguments

• T: component type
• 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.

See also: iterate_components

get_components_by_name(
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    components::InfrastructureSystems.Components,
    name::AbstractString
) -> Vector{T} where T<:InfrastructureSystems.InfrastructureSystemsComponent

Get the components of abstract type T with name. Note that InfrastructureSystems enforces unique names on each concrete type but not across concrete types.

See get_component if the concrete type is known.

Throws ArgumentError if T is not an abstract type.

get_concrete_subtypes(_::Type{T}) -> Vector

Returns an array of concrete types that are direct subtypes of T.

get_count(
    value::InfrastructureSystems.DeterministicMetadata
) -> Int64

Get DeterministicMetadata count.

get_count(
    value::InfrastructureSystems.DeterministicSingleTimeSeries
) -> Int64

Get DeterministicSingleTimeSeries count.

get_count(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Int64

Get ProbabilisticMetadata count.

get_count(
    value::InfrastructureSystems.ScenariosMetadata
) -> Int64

Get ScenariosMetadata count.

get_data(
    value::InfrastructureSystems.Deterministic
) -> DataStructures.SortedDict

Get Deterministic data.

get_data(
    value::InfrastructureSystems.Probabilistic
) -> DataStructures.SortedDict

Get Probabilistic data.

get_data(
    value::InfrastructureSystems.Scenarios
) -> DataStructures.SortedDict

Get Scenarios data.

get_data(
    value::InfrastructureSystems.SingleTimeSeries
) -> TimeSeries.TimeArray

Get SingleTimeSeries data.

get_data_type(
    ts::InfrastructureSystems.TimeSeriesData
) -> Any

Return a String for the data type of the forecast data, this implementation avoids the use of eval on arbitrary code stored in HDF dataset.

get_ext(
    obj::InfrastructureSystems.InfrastructureSystemsInternal
) -> Union{Nothing, Dict{String, Any}}

Return a user-modifiable dictionary to store extra information.

get_features(
    value::InfrastructureSystems.DeterministicMetadata
) -> Dict{String, Union{Bool, Int64, String}}

Get DeterministicMetadata features.

get_features(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Dict{String, Union{Bool, Int64, String}}

Get ProbabilisticMetadata features.

get_features(
    value::InfrastructureSystems.ScenariosMetadata
) -> Dict{String, Union{Bool, Int64, String}}

Get ScenariosMetadata features.

get_features(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Dict{String, Union{Bool, Int64, String}}

Get SingleTimeSeriesMetadata features.

get_group_level(
    logger::InfrastructureSystems.MultiLogger,
    group::Symbol
) -> Union{Nothing, Base.CoreLogging.LogLevel}

Return the minimum logging level for a group or nothing if group is not stored.

get_group_levels(
    logger::InfrastructureSystems.MultiLogger
) -> Dict{Symbol, Base.CoreLogging.LogLevel}

Return the minimum logging levels for groups that have been stored.

get_horizon(
    value::InfrastructureSystems.DeterministicMetadata
) -> Dates.Period

Get DeterministicMetadata horizon.

get_horizon(
    value::InfrastructureSystems.DeterministicSingleTimeSeries
) -> Dates.Period

Get DeterministicSingleTimeSeries horizon.

get_horizon(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Dates.Period

Get ProbabilisticMetadata horizon.

get_horizon(
    value::InfrastructureSystems.ScenariosMetadata
) -> Dates.Period

Get ScenariosMetadata horizon.

get_initial_times(
    f::InfrastructureSystems.Forecast
) -> DataStructures.SDMKeyIteration{T} where T<:DataStructures.SortedDict

Return the initial times in the forecast.

get_initial_timestamp(
    value::InfrastructureSystems.DeterministicMetadata
) -> Dates.DateTime

Get DeterministicMetadata initial_timestamp.

get_initial_timestamp(
    value::InfrastructureSystems.DeterministicSingleTimeSeries
) -> Dates.DateTime

Get DeterministicSingleTimeSeries initial_timestamp.

get_initial_timestamp(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Dates.DateTime

Get ProbabilisticMetadata initial_timestamp.

get_initial_timestamp(
    value::InfrastructureSystems.ScenariosMetadata
) -> Dates.DateTime

Get ScenariosMetadata initial_timestamp.

get_initial_timestamp(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Dates.DateTime

Get SingleTimeSeriesMetadata initial_timestamp.

get_internal(
    value::InfrastructureSystems.DeterministicMetadata
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get DeterministicMetadata internal.

get_internal(
    value::InfrastructureSystems.Deterministic
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get Deterministic internal.

get_internal(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get ProbabilisticMetadata internal.

get_internal(
    value::InfrastructureSystems.Probabilistic
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get Probabilistic internal.

get_internal(
    value::InfrastructureSystems.ScenariosMetadata
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get ScenariosMetadata internal.

get_internal(
    value::InfrastructureSystems.Scenarios
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get Scenarios internal.

get_internal(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get SingleTimeSeriesMetadata internal.

get_internal(
    value::InfrastructureSystems.SingleTimeSeries
) -> InfrastructureSystems.InfrastructureSystemsInternal

Get SingleTimeSeries internal.

get_interval(
    value::InfrastructureSystems.DeterministicMetadata
) -> Dates.Period

Get DeterministicMetadata interval.

get_interval(
    value::InfrastructureSystems.DeterministicSingleTimeSeries
) -> Dates.Period

Get DeterministicSingleTimeSeries interval.

get_interval(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Dates.Period

Get ProbabilisticMetadata interval.

get_interval(
    value::InfrastructureSystems.ScenariosMetadata
) -> Dates.Period

Get ScenariosMetadata interval.

get_length(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Int64

Get SingleTimeSeriesMetadata length.

get_log_events(
    tracker::InfrastructureSystems.LogEventTracker,
    level::Base.CoreLogging.LogLevel
) -> Union{Base.ValueIterator{Dict{Symbol, InfrastructureSystems.LogEvent}}, Vector{Any}}

Returns an iterable of log events for a level.

get_metadata(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series_type::Type{<:InfrastructureSystems.TimeSeriesData},
    name::String;
    features...
) -> Any

Return the metadata matching the inputs. Throw an exception if there is more than one matching input.

get_name(
    value::InfrastructureSystems.DeterministicMetadata
) -> String

Get DeterministicMetadata name.

get_name(
    value::InfrastructureSystems.Deterministic
) -> String

Get Deterministic name.

get_name(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> String

Get ProbabilisticMetadata name.

get_name(
    value::InfrastructureSystems.Probabilistic
) -> String

Get Probabilistic name.

get_name(
    value::InfrastructureSystems.ScenariosMetadata
) -> String

Get ScenariosMetadata name.

get_name(value::InfrastructureSystems.Scenarios) -> String

Get Scenarios name.

get_name(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> String

Get SingleTimeSeriesMetadata name.

get_name(
    value::InfrastructureSystems.SingleTimeSeries
) -> String

Get SingleTimeSeries name.

get_next_time(
    cache::InfrastructureSystems.TimeSeriesCache
) -> Any

Return the timestamp for the next read with get_next_time_series_array!.

Return nothing if all data has been read.

get_next_time_series_array!(
    cache::InfrastructureSystems.TimeSeriesCache
) -> Any

Return the next TimeSeries.TimeArray.

Returns nothing when all data has been read. Call reset! to restart. Call get_next_time to check the start time.

Reads from storage if the data is not already in cache.

Arguments

• cache::StaticTimeSeriesCache: cached instance

get_num_attributes(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
) -> Any

Return the number of supplemental attributes.

get_num_components_with_attributes(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
) -> Any

Return the number of components with supplemental attributes.

get_num_steps(
    _::Type{T<:InfrastructureSystems.TimeSeriesFileFormat},
    file::CSV.File,
    period::AbstractArray
) -> Any

Return the number of steps specified by the period in the file.

get_num_steps(
    _::Type{T<:InfrastructureSystems.TimeSeriesFormatPeriodAsHeader},
    file::CSV.File,
    period::AbstractArray
) -> Any

Return the number of steps specified by the period in the file.

get_num_steps(
    _::Type{T<:Union{InfrastructureSystems.TimeSeriesFormatDateTimeAsColumn, InfrastructureSystems.TimeSeriesFormatPeriodAsColumn}},
    file::CSV.File,
    period::AbstractArray
) -> Any

Return the number of steps specified by the period in the file.

get_num_subsystems(
    data::InfrastructureSystems.SystemData
) -> Int64

Return the number of subsystems in the system.

get_num_time_series(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> Any

Return the number of unique time series arrays.

get_percentiles(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Vector{Float64}

Get ProbabilisticMetadata percentiles.

get_percentiles(
    value::InfrastructureSystems.Probabilistic
) -> Vector{Float64}

Get Probabilistic percentiles.

get_period_columns(
    _::Type{InfrastructureSystems.TimeSeriesFormatPeriodAsColumn},
    file::CSV.File
) -> Vector{Symbol}

Return the column names that specify the Period.

get_points(
    data::InfrastructureSystems.PiecewiseLinearData
) -> Vector{@NamedTuple{x::Float64, y::Float64}}

Get the points that define the piecewise data

Get from a subtype or instance of FunctionData the type of data its getrawdata method returns

get_resolution(
    value::InfrastructureSystems.DeterministicMetadata
) -> Dates.Period

Get DeterministicMetadata resolution.

get_resolution(
    value::InfrastructureSystems.Deterministic
) -> Dates.Period

Get Deterministic resolution.

get_resolution(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Dates.Period

Get ProbabilisticMetadata resolution.

get_resolution(
    value::InfrastructureSystems.Probabilistic
) -> Dates.Period

Get Probabilistic resolution.

get_resolution(
    value::InfrastructureSystems.ScenariosMetadata
) -> Dates.Period

Get ScenariosMetadata resolution.

get_resolution(
    value::InfrastructureSystems.Scenarios
) -> Dates.Period

Get Scenarios resolution.

get_resolution(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Dates.Period

Get SingleTimeSeriesMetadata resolution.

get_resolution(
    value::InfrastructureSystems.SingleTimeSeries
) -> Dates.Period

Get SingleTimeSeries resolution.

get_resolution(ts::TimeSeries.TimeArray) -> Any

Return the resolution from a TimeArray.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.DeterministicMetadata
) -> Union{Nothing, Function}

Get DeterministicMetadata scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.Deterministic
) -> Union{Nothing, Function}

Get Deterministic scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Union{Nothing, Function}

Get ProbabilisticMetadata scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.Probabilistic
) -> Union{Nothing, Function}

Get Probabilistic scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.ScenariosMetadata
) -> Union{Nothing, Function}

Get ScenariosMetadata scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.Scenarios
) -> Union{Nothing, Function}

Get Scenarios scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Union{Nothing, Function}

Get SingleTimeSeriesMetadata scaling_factor_multiplier.

get_scaling_factor_multiplier(
    value::InfrastructureSystems.SingleTimeSeries
) -> Union{Nothing, Function}

Get SingleTimeSeries scaling_factor_multiplier.

get_scenario_count(
    value::InfrastructureSystems.ScenariosMetadata
) -> Int64

Get ScenariosMetadata scenario_count.

get_scenario_count(
    value::InfrastructureSystems.Scenarios
) -> Int64

Get Scenarios scenario_count.

get_serialization_metadata(data::Dict) -> Any

Return the type information for the serialized struct.

get_single_time_series(
    value::InfrastructureSystems.DeterministicSingleTimeSeries
) -> InfrastructureSystems.SingleTimeSeries

Get DeterministicSingleTimeSeries single_time_series.

get_slopes(
    pwl::InfrastructureSystems.PiecewiseLinearData
) -> Vector{Float64}

Calculates the slopes of the line segments defined by the PiecewiseLinearData, returning one fewer slope than the number of underlying points.

get_subsystem_components(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString
) -> Base.Generator{Set{Base.UUID}, InfrastructureSystems.var"#421#422"{InfrastructureSystems.SystemData}}

Return a Generator of all components in the subsystem.

Throws ArgumentError if the subsystem name is not stored.

get_subsystems(
    data::InfrastructureSystems.SystemData
) -> Base.KeySet{String, Dict{String, Set{Base.UUID}}}

Return an iterator of all subsystem names in the system.

get_supplemental_attributes(
    filter_func::Function,
    _::Type{T<:InfrastructureSystems.SupplementalAttribute},
    mgr::InfrastructureSystems.SupplementalAttributeManager
) -> InfrastructureSystems.FlattenIteratorWrapper{T, I} where {T<:InfrastructureSystems.SupplementalAttribute, I<:(Vector)}

Returns an iterator of supplemental_attributes. T can be concrete or abstract. Call collect on the result if an array is desired.

Arguments

• T: supplemental_attribute type
• mgr::SupplementalAttributeManager: SupplementalAttributeManager in 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.

get_supplemental_attributes(
    _::Type{T<:InfrastructureSystems.SupplementalAttribute},
    component::InfrastructureSystems.InfrastructureSystemsComponent
) -> Any

Return a Vector of supplemental_attributes. T can be concrete or abstract.

Arguments

• T: supplemental_attribute type
• supplemental_attributes::SupplementalAttributes: SupplementalAttributes in 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.

get_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    key::InfrastructureSystems.TimeSeriesKey
) -> Any
get_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    key::InfrastructureSystems.TimeSeriesKey,
    start_time::Union{Nothing, Dates.DateTime}
) -> Any
get_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    key::InfrastructureSystems.TimeSeriesKey,
    start_time::Union{Nothing, Dates.DateTime},
    len::Union{Nothing, Int64}
) -> Any
get_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    key::InfrastructureSystems.TimeSeriesKey,
    start_time::Union{Nothing, Dates.DateTime},
    len::Union{Nothing, Int64},
    count::Union{Nothing, Int64}
) -> Any

Return a time series corresponding to the given parameters.

Arguments

• owner::TimeSeriesOwners: Component or attribute containing the time series
• key::TimeSeriesKey: the time series' key
• start_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If the time series is a subtype of Forecast then start_time must be the first timstamp of a window.
• len::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.
• count::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.

get_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    name::AbstractString;
    start_time,
    len,
    count,
    features...
) -> Any

Return a time series corresponding to the given parameters.

Arguments

• ::Type{T}: Concrete subtype of TimeSeriesData to return
• owner::TimeSeriesOwners: Component or attribute containing the time series
• name::AbstractString: name of time series
• start_time::Union{Nothing, Dates.DateTime} = nothing: If nothing, use the initial_timestamp of the time series. If T is a subtype of Forecast then start_time must be the first timstamp of a window.
• len::Union{Nothing, Int} = nothing: Length in the time dimension. If nothing, use the entire length.
• count::Union{Nothing, Int} = nothing: Only applicable to subtypes of Forecast. Number of forecast windows starting at start_time to return. Defaults to all available.

get_time_series_array(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries;
    ...
) -> Any
get_time_series_array(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries,
    start_time::Union{Nothing, Dates.DateTime};
    len,
    ignore_scaling_factors
) -> Any

Return a TimeSeries.TimeArray from a cached StaticTimeSeries instance.

If the data are scaling factors then the stored scalingfactormultiplier will be called on the owner and applied to the data unless ignorescalingfactors is true.

See also StaticTimeSeriesCache.

get_time_series_array!(
    cache::InfrastructureSystems.TimeSeriesCache,
    timestamp::Dates.DateTime
) -> Any

Return the TimeSeries.TimeArray starting at timestamp. Reads from storage if the data is not already in cache.

Timestamps must be read sequentially. Repeated reads are allowed. Random access may be added in the future.

Arguments

• cache::StaticTimeSeriesCache: cached instance
• timestamp::Dates.DateTime: starting timestamp for the time series array

get_time_series_array(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    forecast::InfrastructureSystems.Forecast,
    start_time::Dates.DateTime;
    len,
    ignore_scaling_factors
) -> Any

Return a TimeSeries.TimeArray for one forecast window from a cached Forecast instance.

If the data are scaling factors then the stored scalingfactormultiplier will be called on the owner and applied to the data unless ignorescalingfactors is true.

See also ForecastCache.

get_time_series_array(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    name::AbstractString;
    start_time,
    len,
    ignore_scaling_factors,
    features...
) -> Any

Return a TimeSeries.TimeArray from storage for the given time series parameters.

If the data are scaling factors then the stored scalingfactormultiplier will be called on the owner and applied to the data unless ignorescalingfactors is true.

get_time_series_counts(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> InfrastructureSystems.TimeSeriesCounts

Return an instance of TimeSeriesCounts.

get_time_series_counts_by_type(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> Vector

Return a Vector of OrderedDict of stored time series counts by type.

get_time_series_format(file::CSV.File) -> Type

Return the time series format used in the CSV file.

get_time_series_keys(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
) -> Vector

Return information about each time series array attached to the owner. This information can be used to call gettimeseries.

get_time_series_keys(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
) -> Vector

Return information about each time series array attached to the owner. This information can be used to call get_time_series(::TimeSeriesOwners, ::TimeSeriesKey).

get_time_series_manager(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
) -> Any

Return the TimeSeriesManager or nothing if the component/attribute does not support time series.

get_time_series_multiple(
    data::InfrastructureSystems.SystemData;
    ...
) -> Channel{Any}
get_time_series_multiple(
    data::InfrastructureSystems.SystemData,
    filter_func;
    type,
    name
) -> Channel{Any}

Returns an iterator of TimeSeriesData instances attached to the system.

Note that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.

Call collect on the result to get an array.

Arguments

• data::SystemData: system
• filter_func = nothing: Only return time_series for which this returns true.
• type = nothing: Only return time_series with this type.
• name = nothing: Only return time_series matching this value.

get_time_series_multiple(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute};
    ...
) -> Union{Tuple{}, Channel{Any}}
get_time_series_multiple(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    filter_func;
    type,
    name
) -> Union{Tuple{}, Channel{Any}}

Returns an iterator of TimeSeriesData instances attached to the component or attribute.

Note that passing a filter function can be much slower than the other filtering parameters because it reads time series data from media.

Call collect on the result to get an array.

Arguments

• owner::TimeSeriesOwners: component or attribute from which to get time_series
• filter_func = nothing: Only return time_series for which this returns true.
• type = nothing: Only return time_series with this type.
• name = nothing: Only return time_series matching this value.

get_time_series_resolutions(
    store::InfrastructureSystems.TimeSeriesMetadataStore;
    time_series_type
) -> Any

Return a sorted Vector of distinct resolutions for all time series of the given type (or all types).

get_time_series_summary_table(
    store::InfrastructureSystems.TimeSeriesMetadataStore
) -> DataFrames.DataFrame

Return a DataFrame with the number of time series by type for components and supplemental attributes.

get_time_series_timestamps(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    forecast::InfrastructureSystems.Forecast;
    ...
)
get_time_series_timestamps(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    forecast::InfrastructureSystems.Forecast,
    start_time::Union{Nothing, Dates.DateTime};
    len
) -> Vector{D} where D<:Dates.TimeType

Return a vector of timestamps from a cached Forecast instance.

get_time_series_timestamps(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries;
    ...
) -> Vector{D} where D<:Dates.TimeType
get_time_series_timestamps(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries,
    start_time::Union{Nothing, Dates.DateTime};
    len
) -> Vector{D} where D<:Dates.TimeType

Return a vector of timestamps from a cached StaticTimeSeries instance.

get_time_series_timestamps(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    name::AbstractString;
    start_time,
    len,
    features...
) -> Vector{D} where D<:Dates.TimeType

Return a vector of timestamps from storage for the given time series parameters.

get_time_series_type(
    value::InfrastructureSystems.DeterministicMetadata
) -> Type{<:InfrastructureSystems.AbstractDeterministic}

Get DeterministicMetadata time_series_type.

get_time_series_uuid(
    value::InfrastructureSystems.DeterministicMetadata
) -> Base.UUID

Get DeterministicMetadata time_series_uuid.

get_time_series_uuid(
    value::InfrastructureSystems.ProbabilisticMetadata
) -> Base.UUID

Get ProbabilisticMetadata time_series_uuid.

get_time_series_uuid(
    value::InfrastructureSystems.ScenariosMetadata
) -> Base.UUID

Get ScenariosMetadata time_series_uuid.

get_time_series_uuid(
    value::InfrastructureSystems.SingleTimeSeriesMetadata
) -> Base.UUID

Get SingleTimeSeriesMetadata time_series_uuid.

get_time_series_values(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries;
    ...
) -> Any
get_time_series_values(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    time_series::InfrastructureSystems.StaticTimeSeries,
    start_time::Union{Nothing, Dates.DateTime};
    len,
    ignore_scaling_factors
) -> Any

Return an Array of values from a cached StaticTimeSeries instance for the requested time series parameters.

get_time_series_values(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    forecast::InfrastructureSystems.Forecast,
    start_time::Dates.DateTime;
    len,
    ignore_scaling_factors
) -> Any

Return an Array of values for one forecast window from a cached Forecast instance.

get_time_series_values(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    name::AbstractString;
    start_time,
    len,
    ignore_scaling_factors,
    features...
) -> Any

Return an Array of values from storage for the requested time series parameters.

If the data size is small and this will be called many times, consider using the version that accepts a cached TimeSeriesData instance.

get_timestamp(
    _::Type{InfrastructureSystems.TimeSeriesFormatYMDPeriodAsColumn},
    file::CSV.File,
    row_index::Int64
) -> Any

Return a Dates.DateTime for the row in the CSV file.

get_total_period(f::InfrastructureSystems.Forecast) -> Any

Return the total period covered by the forecast.

get_unique_timestamps(
    _::Type{T<:InfrastructureSystems.TimeSeriesFileFormat},
    file::CSV.File
) -> Vector{Dict{String, Any}}

Return a vector of dicts of unique timestamps and their counts.

get_uuid(
    obj::InfrastructureSystems.InfrastructureSystemsType
) -> Base.UUID

Gets the UUID for any InfrastructureSystemsType.

get_value_columns(
    _::Type{InfrastructureSystems.TimeSeriesFormatComponentsAsColumnsNoTime},
    file::CSV.File
) -> Vector{Symbol}

Return the column names with values.

get_value_columns(
    _::Type{InfrastructureSystems.TimeSeriesFormatYMDPeriodAsColumn},
    file::CSV.File
) -> Vector{Symbol}

Return the column names with values (components).

get_window(
    forecast::InfrastructureSystems.Forecast,
    index::Int64;
    len
) -> Any

Return the forecast window corresponsing to interval index.

get_x_coords(
    data::InfrastructureSystems.PiecewiseLinearData
) -> Vector{Float64}

Get the x-coordinates of the points that define the piecewise data

get_x_coords(
    data::InfrastructureSystems.PiecewiseStepData
) -> Vector{Float64}

Get the x-coordinates of the points that define the piecewise data

get_x_lengths(
    pwl::Union{InfrastructureSystems.PiecewiseLinearData, InfrastructureSystems.PiecewiseStepData}
) -> Vector{Float64}

Calculates the x-length of each segment of a piecewise curve.

get_y_coords(
    data::InfrastructureSystems.PiecewiseLinearData
) -> Vector{Float64}

Get the y-coordinates of the points that define the PiecewiseLinearData

get_y_coords(
    data::InfrastructureSystems.PiecewiseStepData
) -> Vector{Float64}

Get the y-coordinates of the segments in the PiecewiseStepData

has_association(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    attribute::InfrastructureSystems.SupplementalAttribute
) -> Bool

Return true if there is at least one association matching the inputs.

has_component(
    components::InfrastructureSystems.Components,
    T::Type{<:InfrastructureSystems.InfrastructureSystemsComponent},
    name::AbstractString
) -> Bool

Check to see if a component with name exists.

has_component(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString,
    component::InfrastructureSystems.InfrastructureSystemsComponent
) -> Bool

Return true if the component is in the subsystem.

has_component(
    data::InfrastructureSystems.SystemData,
    T::Type{<:InfrastructureSystems.InfrastructureSystemsComponent},
    name::AbstractString
) -> Bool

Check to see if a component exists.

has_components(
    components::InfrastructureSystems.Components,
    T::Type{<:InfrastructureSystems.InfrastructureSystemsComponent}
) -> Bool

Check to see if a component if the given type exists.

has_metadata(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    metadata::InfrastructureSystems.TimeSeriesMetadata
) -> Bool

Return True if there is time series metadata matching the inputs.

has_supplemental_attributes(
    component::InfrastructureSystems.InfrastructureSystemsComponent
) -> Bool

Return true if the component has supplemental attributes.

has_supplemental_attributes(
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    _::Type{T<:InfrastructureSystems.SupplementalAttribute}
) -> Bool

Return true if the component has supplemental attributes of the given type.

has_time_series(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    time_series_uuid::Base.UUID
) -> Any

Return True if there is time series matching the UUID.

has_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
) -> Any

Return true if the component or supplemental attribute has time series data.

has_time_series(
    val::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    _::Type{T<:InfrastructureSystems.TimeSeriesData}
) -> Any

Return true if the component or supplemental attribute has time series data of type T.

hash_from_fields(a) -> Any

Compute a hash of the instance a by combining hashes of all its fields

head(
    time_series::InfrastructureSystems.SingleTimeSeries
) -> Any

Return a time_series with only the first num values.

increment_count!(
    tracker::InfrastructureSystems.LogEventTracker,
    event::InfrastructureSystems.LogEvent,
    suppressed::Bool
) -> Union{Nothing, Int64, InfrastructureSystems.LogEvent}

Increments the count of a log event.

index_to_initial_time(
    forecast::InfrastructureSystems.Forecast,
    index::Int64
) -> Any

Return the Dates.DateTime corresponding to an interval index.

is_assigned_to_subsystem(
    data::InfrastructureSystems.SystemData,
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    subsystem_name::AbstractString
) -> Bool

Return true if the component is assigned to the subsystem.

is_assigned_to_subsystem(
    data::InfrastructureSystems.SystemData,
    component::InfrastructureSystems.InfrastructureSystemsComponent
) -> Bool

Return true if the component is assigned to any subsystems.

is_convex(
    pwl::InfrastructureSystems.PiecewiseLinearData
) -> Bool

Returns True/False depending on the convexity of the underlying data

is_ext_valid_for_serialization(value) -> Bool

Perform a test to see if JSON3 can convert this value so that the code can give the user a a comprehensible corrective action.

isequal_from_fields(a, b) -> Any

Compute the conjunction of the isequal values of all the fields in a and b

iterate_components(
    components::InfrastructureSystems.Components
) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{String, <:InfrastructureSystems.InfrastructureSystemsComponent}}}, InfrastructureSystems.var"#112#113"}}

Iterates over all components.

Examples

for component in iterate_components(obj)
    @show component
end

See also: get_components

iterate_container(
    container::InfrastructureSystems.InfrastructureSystemsContainer
) -> Base.Iterators.Flatten{I} where I<:(Base.Generator{_A, InfrastructureSystems.var"#112#113"} where _A)

Iterates over all data in the container.

iterate_supplemental_attributes(
    mgr::InfrastructureSystems.SupplementalAttributeManager
) -> Base.Iterators.Flatten{Base.Generator{Base.ValueIterator{Dict{DataType, Dict{Base.UUID, <:InfrastructureSystems.SupplementalAttribute}}}, InfrastructureSystems.var"#112#113"}}

Iterates over all supplemental_attributes.

Examples

for supplemental_attribute in iterate_supplemental_attributes(obj)
    @show supplemental_attribute
end

list_associated_component_uuids(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    attribute::InfrastructureSystems.SupplementalAttribute
) -> Any

Return the component UUIDs associated with the attribute.

list_associated_supplemental_attribute_uuids(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    component::InfrastructureSystems.InfrastructureSystemsComponent;
    attribute_type
) -> Any

Return the supplemental attribute UUIDs associated with the component and attribute type.

list_existing_metadata(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owners::Vector{Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}},
    metadata::Vector{InfrastructureSystems.TimeSeriesMetadata}
) -> Vector

Return the metadata specified in the passed metadata vector that are already stored.

list_existing_time_series_uuids(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    uuids
) -> Any

Return the time series UUIDs specified in the passed uuids that are already stored.

list_matching_time_series_uuids(
    store::InfrastructureSystems.TimeSeriesMetadataStore;
    time_series_type,
    name,
    features...
) -> Any

Return the time series UUIDs that match the inputs.

list_metadata_with_owner_uuid(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner_type::Type{<:Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}};
    time_series_type,
    name,
    features...
) -> Vector

Return a Vector of NamedTuple of owner UUID and time series metadata matching the inputs.

list_recorder_events(
    ::Type{T<:InfrastructureSystems.AbstractRecorderEvent},
    filename::AbstractString
) -> Vector{T} where T<:InfrastructureSystems.AbstractRecorderEvent
list_recorder_events(
    ::Type{T<:InfrastructureSystems.AbstractRecorderEvent},
    filename::AbstractString,
    filter_func::Union{Nothing, Function}
) -> Vector{T} where T<:InfrastructureSystems.AbstractRecorderEvent

Return the events of type T in filename.

Arguments

• T: event type
• filename::AbstractString: filename containing recorder events
• filter_func::Union{Nothing, Function} = nothing: Optional function that accepts an event of type T and returns a Bool. Apply this function to each event and only return events where the result is true.

load_records!(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    records
)

Add records to the database. Expects output from to_records.

make_time_array(
    forecast::InfrastructureSystems.Forecast,
    start_time::Dates.DateTime;
    len
) -> Any

Return a TimeSeries.TimeArray for one forecast window.

make_time_series!(
    cache::InfrastructureSystems.TimeSeriesParsingCache,
    ts_file_metadata::InfrastructureSystems.TimeSeriesFileMetadata
) -> Any

Return a time series from TimeSeriesFileMetadata.

Arguments

• cache::TimeSeriesParsingCache: cached data
• ts_file_metadata::TimeSeriesFileMetadata: metadata
• resolution::{Nothing, Dates.Period}: skip any time_series that don't match this resolution

mask_component!(
    data::InfrastructureSystems.SystemData,
    component::InfrastructureSystems.InfrastructureSystemsComponent;
    remove_time_series
)

Removes the component from the main container and adds it to the masked container.

open_file_logger(func::Function, filename::String) -> Any
open_file_logger(
    func::Function,
    filename::String,
    level
) -> Any
open_file_logger(
    func::Function,
    filename::String,
    level,
    mode
) -> Any

Opens a file logger using Logging.SimpleLogger.

Example

open_file_logger("log.txt", Logging.Info) do logger
    global_logger(logger)
    @info "hello world"
end

prepare_for_removal!(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
)

This function must be called when a component or attribute is removed from a system.

prepare_for_serialization_to_file!(
    data::InfrastructureSystems.SystemData,
    filename::AbstractString;
    force
)

Parent object should call this prior to serialization so that SystemData can store the appropriate path information for the time series data.

read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    data_file::AbstractString;
    ...
) -> InfrastructureSystems.RawTimeSeries
read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    data_file::AbstractString,
    component_name;
    kwargs...
) -> Any

Return a TimeArray from a CSV file.

Pass component_name when the file does not have the component name in a column header.

read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesFormatPeriodAsHeader},
    ::Type{<:InfrastructureSystems.StaticTimeSeries},
    file::CSV.File,
    component_name::AbstractString;
    kwargs...
) -> InfrastructureSystems.RawTimeSeries

This version of the function supports the format where there is no column header for a component, so the component_name must be passed in.

read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesFormatComponentsAsColumnsNoTime},
    ::Type{<:InfrastructureSystems.StaticTimeSeries},
    file::CSV.File;
    ...
) -> InfrastructureSystems.RawTimeSeries
read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesFormatComponentsAsColumnsNoTime},
    ::Type{<:InfrastructureSystems.StaticTimeSeries},
    file::CSV.File,
    component_name;
    kwargs...
) -> InfrastructureSystems.RawTimeSeries

This version of the function only has component_name to match the interface. It is unused.

Set start_datetime as a keyword argument for the starting timestamp, otherwise the current day is used.

read_time_series(
    ::Type{T<:Union{InfrastructureSystems.TimeSeriesFormatDateTimeAsColumn, InfrastructureSystems.TimeSeriesFormatPeriodAsColumn}},
    ::Type{<:InfrastructureSystems.StaticTimeSeries},
    file::CSV.File;
    ...
) -> InfrastructureSystems.RawTimeSeries
read_time_series(
    ::Type{T<:Union{InfrastructureSystems.TimeSeriesFormatDateTimeAsColumn, InfrastructureSystems.TimeSeriesFormatPeriodAsColumn}},
    ::Type{<:InfrastructureSystems.StaticTimeSeries},
    file::CSV.File,
    component_name;
    kwargs...
) -> InfrastructureSystems.RawTimeSeries

Return a TimeSeries.TimeArray representing the CSV file.

This version of the function only has component_name to match the interface. It is unused.

read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesFormatDateTimeAsColumn},
    ::Type{InfrastructureSystems.Deterministic},
    file::CSV.File;
    ...
) -> InfrastructureSystems.RawTimeSeries
read_time_series(
    ::Type{T<:InfrastructureSystems.TimeSeriesFormatDateTimeAsColumn},
    ::Type{InfrastructureSystems.Deterministic},
    file::CSV.File,
    component_name;
    kwargs...
) -> InfrastructureSystems.RawTimeSeries

Return a RawTimeSeries from a CSV file.

Pass component_name when the file does not have the component name in a column header.

read_time_series_file_metadata(
    file_path::AbstractString
) -> Any

Reads time_series metadata and fixes relative paths to the data files.

redirect_stdout_to_log(func::Function) -> Any

Redirect all data written to stdout by a function to log events.

register_recorder!(name::Symbol; io, mode, directory)

Register a recorder to log events. Afterwards, calls to @record name <event-type>() will record the event as JSON in <name>.log.

Callers should guarantee that unregister_recorder! is called to close the file handle.

Arguments

• name::Symbol: name of recorder
• io::Union{Nothing, IO}: If nothing, record events in a file using name.
• mode = "w": Only used when io is nothing.
• directory = ".": Only used when io is nothing.

remove_association!(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    attribute::InfrastructureSystems.SupplementalAttribute
)

Remove the association between the attribute and component.

remove_associations!(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    type::Type{<:InfrastructureSystems.SupplementalAttribute}
)

Remove all associations of the given type.

remove_component!(
    components::InfrastructureSystems.Components,
    component::InfrastructureSystems.InfrastructureSystemsComponent;
    remove_time_series
) -> InfrastructureSystems.InfrastructureSystemsComponent

Remove a component by its value.

Throws ArgumentError if the component is not stored.

remove_component!(
    ::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    components::InfrastructureSystems.Components,
    name::AbstractString;
    remove_time_series
) -> InfrastructureSystems.InfrastructureSystemsComponent

Remove a component by its name.

Throws ArgumentError if the component is not stored.

remove_component_from_subsystem!(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString,
    component::InfrastructureSystems.InfrastructureSystemsComponent
)

Remove a component from a subsystem.

Throws ArgumentError if the subsystem name or component is not stored.

remove_components!(
    _::Type{T<:InfrastructureSystems.InfrastructureSystemsComponent},
    components::InfrastructureSystems.Components
) -> Base.ValueIterator{T} where T<:(Dict{String, <:InfrastructureSystems.InfrastructureSystemsComponent})

Remove all components of type T.

Throws ArgumentError if the type is not stored.

remove_metadata!(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    metadata::InfrastructureSystems.TimeSeriesMetadata
)

Remove the matching metadata from the store.

remove_subsystem!(
    data::InfrastructureSystems.SystemData,
    subsystem_name::AbstractString
)

Remove a subsystem from the system.

Throws ArgumentError if the subsystem name is not stored.

remove_supplemental_attributes!(
    mgr::InfrastructureSystems.SupplementalAttributeManager,
    _::Type{T<:InfrastructureSystems.SupplementalAttribute}
) -> Base.ValueIterator{T} where T<:(Dict{Base.UUID, <:InfrastructureSystems.SupplementalAttribute})

Remove all supplemental_attributes of type T.

Ignores whether attributes are attached to components.

Throws ArgumentError if the type is not stored.

remove_time_series!(
    mgr::InfrastructureSystems.TimeSeriesManager,
    time_series_type::Type{<:InfrastructureSystems.TimeSeriesData},
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute},
    name::String;
    features...
)

Remove the time series data for a component.

remove_time_series!(
    data::InfrastructureSystems.SystemData,
    ::Type{T<:InfrastructureSystems.TimeSeriesData},
    component::InfrastructureSystems.InfrastructureSystemsComponent,
    name::String;
    features...
)

Remove the time series data for a component.

remove_time_series!(
    data::InfrastructureSystems.SystemData,
    _::Type{T<:InfrastructureSystems.TimeSeriesData}
)

Removes all time series of a particular type from a System.

Arguments

• data::SystemData: system
• type::Type{<:TimeSeriesData}: Type of time series objects to remove.

replace_component_uuid!(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    old_uuid::Base.UUID,
    new_uuid::Base.UUID
)

Replace the component UUID in the table.

replace_iterator(
    container::InfrastructureSystems.LazyDictFromIterator,
    iter
)

Replace the iterator, maintaining the cached dict.

report_log_summary(
    tracker::InfrastructureSystems.LogEventTracker
) -> String

Returns a summary of log event counts by level.

report_log_summary(
    logger::InfrastructureSystems.MultiLogger
) -> String

Returns a summary of log event counts by level.

reset!(cache::InfrastructureSystems.TimeSeriesCache)

Reset parameters in order to start reading data from the beginning with get_next_time_series_array!

reset_iterator(
    container::InfrastructureSystems.LazyDictFromIterator
)

Reset the iterator for cases where underlying arrays have changed.

serialize(
    val::InfrastructureSystems.InfrastructureSystemsType
) -> Dict{String, Any}

Serialize the Julia value into standard types that can be converted to non-Julia formats, such as JSON. In cases where val is an instance of a struct, return a Dict. In cases where val is a scalar value, return that value.

set_component!(
    metadata::InfrastructureSystems.TimeSeriesFileMetadata,
    data::InfrastructureSystems.SystemData,
    mod::Module
) -> Union{Nothing, InfrastructureSystems.InfrastructureSystemsComponent}

Set the component value in metadata by looking up the category in module. This requires that category be a string version of a component's abstract type. Modules can override for custom behavior.

set_count!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata count.

set_count!(
    value::InfrastructureSystems.DeterministicSingleTimeSeries,
    val
) -> Any

Set DeterministicSingleTimeSeries count.

set_count!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata count.

set_count!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata count.

set_data!(
    value::InfrastructureSystems.Deterministic,
    val
) -> Any

Set Deterministic data.

set_data!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic data.

set_data!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios data.

set_data!(
    value::InfrastructureSystems.SingleTimeSeries,
    val
) -> Any

Set SingleTimeSeries data.

set_features!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata features.

set_features!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata features.

set_features!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata features.

set_features!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata features.

set_group_level!(
    logger::InfrastructureSystems.MultiLogger,
    group::Symbol,
    level::Base.CoreLogging.LogLevel
)

Set the minimum log level for a group.

The group field of a log message defaults to its file's base name (no extension) as a symbol. It can be customized by setting _group = :a_group_name.

The minimum log level stored for a console or file logger supercede this setting.

set_group_levels!(
    logger::InfrastructureSystems.MultiLogger,
    group_levels::Dict{Symbol, Base.CoreLogging.LogLevel}
)

Set the minimum log levels for multiple groups. Refer to set_group_level for more information.

set_horizon!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata horizon.

set_horizon!(
    value::InfrastructureSystems.DeterministicSingleTimeSeries,
    val
) -> Any

Set DeterministicSingleTimeSeries horizon.

set_horizon!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata horizon.

set_horizon!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata horizon.

set_initial_timestamp!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata initial_timestamp.

set_initial_timestamp!(
    value::InfrastructureSystems.DeterministicSingleTimeSeries,
    val
) -> Any

Set DeterministicSingleTimeSeries initial_timestamp.

set_initial_timestamp!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata initial_timestamp.

set_initial_timestamp!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata initial_timestamp.

set_initial_timestamp!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata initial_timestamp.

set_internal!(
    value::InfrastructureSystems.Deterministic,
    val
) -> Any

Set Deterministic internal.

set_internal!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata internal.

set_internal!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic internal.

set_internal!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata internal.

set_internal!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios internal.

set_internal!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata internal.

set_internal!(
    value::InfrastructureSystems.SingleTimeSeries,
    val
) -> Any

Set SingleTimeSeries internal.

set_internal!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata internal.

set_interval!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata interval.

set_interval!(
    value::InfrastructureSystems.DeterministicSingleTimeSeries,
    val
) -> Any

Set DeterministicSingleTimeSeries interval.

set_interval!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata interval.

set_interval!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata interval.

set_length!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata length.

set_name!(
    value::InfrastructureSystems.Deterministic,
    val
) -> Any

Set Deterministic name.

set_name!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata name.

set_name!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic name.

set_name!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata name.

set_name!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios name.

set_name!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata name.

set_name!(
    value::InfrastructureSystems.SingleTimeSeries,
    val
) -> Any

Set SingleTimeSeries name.

set_name!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata name.

set_percentiles!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic percentiles.

set_percentiles!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata percentiles.

set_resolution!(
    value::InfrastructureSystems.Deterministic,
    val
) -> Any

Set Deterministic resolution.

set_resolution!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata resolution.

set_resolution!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic resolution.

set_resolution!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata resolution.

set_resolution!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios resolution.

set_resolution!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata resolution.

set_resolution!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata resolution.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.Deterministic,
    val
) -> Any

Set Deterministic scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.Probabilistic,
    val
) -> Any

Set Probabilistic scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.SingleTimeSeries,
    val
) -> Any

Set SingleTimeSeries scaling_factor_multiplier.

set_scaling_factor_multiplier!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata scaling_factor_multiplier.

set_scenario_count!(
    value::InfrastructureSystems.Scenarios,
    val
) -> Any

Set Scenarios scenario_count.

set_scenario_count!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata scenario_count.

set_single_time_series!(
    value::InfrastructureSystems.DeterministicSingleTimeSeries,
    val
) -> Any

Set DeterministicSingleTimeSeries single_time_series.

set_time_series_type!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata time_series_type.

set_time_series_uuid!(
    value::InfrastructureSystems.DeterministicMetadata,
    val
) -> Any

Set DeterministicMetadata time_series_uuid.

set_time_series_uuid!(
    value::InfrastructureSystems.ProbabilisticMetadata,
    val
) -> Any

Set ProbabilisticMetadata time_series_uuid.

set_time_series_uuid!(
    value::InfrastructureSystems.ScenariosMetadata,
    val
) -> Any

Set ScenariosMetadata time_series_uuid.

set_time_series_uuid!(
    value::InfrastructureSystems.SingleTimeSeriesMetadata,
    val
) -> Any

Set SingleTimeSeriesMetadata time_series_uuid.

show_recorder_events(
    ::Type{T<:InfrastructureSystems.AbstractRecorderEvent},
    filename::AbstractString;
    ...
)
show_recorder_events(
    ::Type{T<:InfrastructureSystems.AbstractRecorderEvent},
    filename::AbstractString,
    filter_func::Union{Nothing, Function};
    kwargs...
)

Show the events of type T in filename in a table. Refer to PrettyTables.jl documentation for accepted kwargs.

Arguments

• T: event type
• filename::AbstractString: filename containing recorder events
• filter_func::Union{Nothing, Function} = nothing: Optional function that accepts an event of type T and returns a Bool. Apply this function to each event and only return events where the result is true.
• exclude_columns = Set{String}(): Column names to exclude from the table
• kwargs: Passed to PrettyTables

Examples

show_recorder_events(TestEvent, test_recorder.log)
show_recorder_events(TestEvent, test_recorder.log, x -> x.val2 > 2)

show_supplemental_attributes(
    component::InfrastructureSystems.InfrastructureSystemsComponent
)

Show a table with supplemental attributes attached to the component.

show_time_series(
    owner::Union{InfrastructureSystems.InfrastructureSystemsComponent, InfrastructureSystems.SupplementalAttribute}
)

Show a table with time series data attached to the component.

sql(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    query::String
) -> DataFrames.DataFrame
sql(
    associations::InfrastructureSystems.SupplementalAttributeAssociations,
    query::String,
    params
) -> DataFrames.DataFrame

Run a query and return the results in a DataFrame.

sql(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    query::String
) -> DataFrames.DataFrame
sql(
    store::InfrastructureSystems.TimeSeriesMetadataStore,
    query::String,
    params
) -> DataFrames.DataFrame

Run a query and return the results in a DataFrame.

strip_module_name(name::String) -> String

Strips the module name off of a type. This can be useful to print types as strings and receive consistent results regardless of whether the user used import or using to load a package.

Unlike Base.nameof, this function preserves any parametric types.

Examples

julia> strip_module_name(PowerSystems.RegulationDevice{ThermalStandard})
"RegulationDevice{ThermalStandard}"
julia> string(nameof(PowerSystems.RegulationDevice{ThermalStandard}))
"RegulationDevice"

supertypes(::Type{T}) -> Vector{Any}
supertypes(::Type{T}, types) -> Any

Returns an array of all super types of T.

tail(
    time_series::InfrastructureSystems.SingleTimeSeries
) -> Any

Return a time_series with only the ending num values.

test_generated_structs(
    descriptor_file,
    existing_dir
) -> Bool

Return true if the structs defined in existingdir match structs freshly-generated from descriptorfile.

to(
    time_series::InfrastructureSystems.SingleTimeSeries,
    timestamp
) -> InfrastructureSystems.SingleTimeSeries

Return a time_series truncated after timestamp.

to_dict(
    data::InfrastructureSystems.SystemData
) -> Dict{String, Any}

Serialize all system and component data to a dictionary.

to_json(
    obj::InfrastructureSystems.InfrastructureSystemsType;
    pretty,
    indent
) -> Any

Serializes a InfrastructureSystemsType to a JSON string.

to_json(
    obj::InfrastructureSystems.InfrastructureSystemsType;
    pretty,
    indent
) -> Any

Serializes a InfrastructureSystemsType to a JSON file.

to_records(
    associations::InfrastructureSystems.SupplementalAttributeAssociations
) -> Vector

Return all rows in the table as dictionaries.

transform_single_time_series!(
    data::InfrastructureSystems.SystemData,
    _::Type{<:InfrastructureSystems.DeterministicSingleTimeSeries},
    horizon::Dates.Period,
    interval::Dates.Period
)

Transform all instances of SingleTimeSeries to DeterministicSingleTimeSeries. If all SingleTimeSeries instances cannot be transformed then none will be.

Any existing DeterministicSingleTimeSeries forecasts will be deleted even if the inputs are invalid.

unregister_recorder!(name::Symbol; close_io) -> Any

Unregister the recorder with this name and stop recording events.

validate_exported_names(mod::Module) -> Bool

Return true if all publicly exported names in mod are defined.

validate_struct(
    ist::InfrastructureSystems.InfrastructureSystemsType
) -> Bool

Validates a struct using only information within the struct.

when(
    time_series::InfrastructureSystems.SingleTimeSeries,
    period::Function,
    t::Integer
) -> Any

Refer to TimeSeries.when(). Underlying data is copied.

Throw an AssertionError if conditions like op(exp1, exp2) are false, where op is a conditional infix operator.

Examples

julia> a = 3; b = 4;
julia> @assert_op a == b
ERROR: AssertionError: 3 == 4

julia> @assert_op a + 3 > b + 4
ERROR: AssertionError: 6 > 8

Record an event if the recorder with name is enabled.

Arguments

• name::Symbol: name of recorder
• event::AbstractRecorderEvent: event to record

Examples

@record simulation TestEvent("start", 1, 2.0)

Macro to wrap Enum in a module to keep the top level scope clean.

Examples

julia> @scoped_enum Fruit APPLE = 1 ORANGE = 2

julia> value = Fruit.APPLE
Fruit.APPLE = 1

julia> value = Fruit(1)
Fruit.APPLE = 1

julia> @scoped_enum(Fruit,
    APPLE = 1,  # comment
    ORANGE = 2,  # comment
)