Reserves

mutable struct StaticReserve{T <: ReserveDirection} <: Reserve{T}
    name::String
    available::Bool
    time_frame::Float64
    requirement::Float64
    sustained_time::Float64
    max_output_fraction::Float64
    max_participation_factor::Float64
    deployed_fraction::Float64
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

Data Structure for a proportional reserve product for system simulations.

Arguments

• name::String
• available::Bool
• time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing), action if invalid: error
• requirement::Float64: the static value of required reserves in system p.u., validation range: (0, nothing), action if invalid: error
• sustained_time::Float64: the time in secounds reserve contribution must sustained at a specified level, validation range: (0, nothing), action if invalid: error
• max_output_fraction::Float64: the maximum fraction of the device's output that can be assigned to the service, validation range: (0, 1), action if invalid: error
• max_participation_factor::Float64: the maximum limit of reserve contribution per device, validation range: (0, 1), action if invalid: error
• deployed_fraction::Float64: Fraction of ancillary services participation deployed from the assignment, validation range: (0, 1), action if invalid: error
• ext::Dict{String, Any}
• internal::InfrastructureSystemsInternal: power system internal reference, do not modify

get_name(value::StaticReserve) -> String

Get StaticReserve name.

get_available(value::StaticReserve) -> Bool

Get StaticReserve available.

get_deployed_fraction(value::StaticReserve) -> Float64

Get StaticReserve deployed_fraction.

get_ext(value::StaticReserve) -> Dict{String, Any}

Get StaticReserve ext.

get_max_output_fraction(value::StaticReserve) -> Float64

Get StaticReserve max_output_fraction.

get_max_participation_factor(
    value::StaticReserve
) -> Float64

Get StaticReserve max_participation_factor.

get_requirement(value::StaticReserve) -> Any

Get StaticReserve requirement.

get_sustained_time(value::StaticReserve) -> Float64

Get StaticReserve sustained_time.

get_time_frame(value::StaticReserve) -> Float64

Get StaticReserve time_frame.

set_available!(value::StaticReserve, val) -> Any

Set StaticReserve available.

set_deployed_fraction!(value::StaticReserve, val) -> Any

Set StaticReserve deployed_fraction.

set_ext!(value::StaticReserve, val) -> Any

Set StaticReserve ext.

set_max_output_fraction!(value::StaticReserve, val) -> Any

Set StaticReserve max_output_fraction.

set_max_participation_factor!(
    value::StaticReserve,
    val
) -> Any

Set StaticReserve max_participation_factor.

set_requirement!(value::StaticReserve, val) -> Any

Set StaticReserve requirement.

set_sustained_time!(value::StaticReserve, val) -> Any

Set StaticReserve sustained_time.

set_time_frame!(value::StaticReserve, val) -> Any

Set StaticReserve time_frame.

mutable struct StaticReserveGroup{T <: ReserveDirection} <: Service
    name::String
    available::Bool
    requirement::Float64
    ext::Dict{String, Any}
    contributing_services::Vector{Service}
    internal::InfrastructureSystemsInternal
end

Data Structure for a group reserve product for system simulations.

Arguments

• name::String
• available::Bool
• requirement::Float64: the static value of required reserves in system p.u., validation range: (0, nothing), action if invalid: error
• ext::Dict{String, Any}
• contributing_services::Vector{Service}: Services that contribute for this requirement constraint
• internal::InfrastructureSystemsInternal: power system internal reference, do not modify

get_name(value::StaticReserveGroup) -> String

Get StaticReserveGroup name.

get_available(value::StaticReserveGroup) -> Bool

Get StaticReserveGroup available.

get_contributing_services(
    value::StaticReserveGroup
) -> Vector{Service}

Get StaticReserveGroup contributing_services.

get_ext(value::StaticReserveGroup) -> Dict{String, Any}

Get StaticReserveGroup ext.

get_requirement(value::StaticReserveGroup) -> Any

Get StaticReserveGroup requirement.

set_available!(value::StaticReserveGroup, val) -> Any

Set StaticReserveGroup available.

set_ext!(value::StaticReserveGroup, val) -> Any

Set StaticReserveGroup ext.

set_requirement!(value::StaticReserveGroup, val) -> Any

Set StaticReserveGroup requirement.

mutable struct VariableReserve{T <: ReserveDirection} <: Reserve{T}
    name::String
    available::Bool
    time_frame::Float64
    requirement::Float64
    sustained_time::Float64
    max_output_fraction::Float64
    max_participation_factor::Float64
    deployed_fraction::Float64
    ext::Dict{String, Any}
    time_series_container::InfrastructureSystems.TimeSeriesContainer
    internal::InfrastructureSystemsInternal
end

Data Structure for the procurement products for system simulations.

Arguments

• name::String
• available::Bool
• time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing), action if invalid: error
• requirement::Float64: the required quantity of the product should be scaled by a TimeSeriesData
• sustained_time::Float64: the time in secounds reserve contribution must sustained at a specified level, validation range: (0, nothing), action if invalid: error
• max_output_fraction::Float64: the maximum fraction of the device's output that can be assigned to the service, validation range: (0, 1), action if invalid: error
• max_participation_factor::Float64: the maximum limit of reserve contribution per device, validation range: (0, 1), action if invalid: error
• deployed_fraction::Float64: Fraction of ancillary services participation deployed from the assignment, validation range: (0, 1), action if invalid: error
• ext::Dict{String, Any}
• time_series_container::InfrastructureSystems.TimeSeriesContainer: internal time_series storage
• internal::InfrastructureSystemsInternal: power system internal reference, do not modify

get_name(value::VariableReserve) -> String

Get VariableReserve name.

get_time_series_container(
    value::VariableReserve
) -> InfrastructureSystems.TimeSeriesContainer

Get VariableReserve time_series_container.

get_available(value::VariableReserve) -> Bool

Get VariableReserve available.

get_deployed_fraction(value::VariableReserve) -> Float64

Get VariableReserve deployed_fraction.

get_ext(value::VariableReserve) -> Dict{String, Any}

Get VariableReserve ext.

get_max_output_fraction(value::VariableReserve) -> Float64

Get VariableReserve max_output_fraction.

get_max_participation_factor(
    value::VariableReserve
) -> Float64

Get VariableReserve max_participation_factor.

get_requirement(value::VariableReserve) -> Float64

Get VariableReserve requirement.

get_sustained_time(value::VariableReserve) -> Float64

Get VariableReserve sustained_time.

get_time_frame(value::VariableReserve) -> Float64

Get VariableReserve time_frame.

set_available!(value::VariableReserve, val) -> Any

Set VariableReserve available.

set_deployed_fraction!(value::VariableReserve, val) -> Any

Set VariableReserve deployed_fraction.

set_ext!(value::VariableReserve, val) -> Any

Set VariableReserve ext.

set_max_output_fraction!(value::VariableReserve, val) -> Any

Set VariableReserve max_output_fraction.

set_max_participation_factor!(
    value::VariableReserve,
    val
) -> Any

Set VariableReserve max_participation_factor.

set_requirement!(value::VariableReserve, val) -> Any

Set VariableReserve requirement.

set_sustained_time!(value::VariableReserve, val) -> Any

Set VariableReserve sustained_time.

set_time_frame!(value::VariableReserve, val) -> Any

Set VariableReserve time_frame.

set_time_series_container!(
    value::VariableReserve,
    val
) -> Any

Set VariableReserve time_series_container.

mutable struct ReserveDemandCurve{T <: ReserveDirection} <: Reserve{T}
    variable::Union{Nothing, IS.TimeSeriesKey}
    name::String
    available::Bool
    time_frame::Float64
    sustained_time::Float64
    max_participation_factor::Float64
    deployed_fraction::Float64
    ext::Dict{String, Any}
    time_series_container::InfrastructureSystems.TimeSeriesContainer
    internal::InfrastructureSystemsInternal
end

Data Structure for a operating reserve with demand curve product for system simulations.

Arguments

• variable::Union{Nothing, IS.TimeSeriesKey}: Variable Cost TimeSeriesKey
• name::String
• available::Bool
• time_frame::Float64: the saturation time_frame in minutes to provide reserve contribution, validation range: (0, nothing), action if invalid: error
• sustained_time::Float64: the time in secounds reserve contribution must sustained at a specified level, validation range: (0, nothing), action if invalid: error
• max_participation_factor::Float64: the maximum limit of reserve contribution per device, validation range: (0, 1), action if invalid: error
• deployed_fraction::Float64: Fraction of ancillary services participation deployed from the assignment, validation range: (0, 1), action if invalid: error
• ext::Dict{String, Any}
• time_series_container::InfrastructureSystems.TimeSeriesContainer: internal time_series storage
• internal::InfrastructureSystemsInternal: power system internal reference, do not modify

get_name(value::ReserveDemandCurve) -> String

Get ReserveDemandCurve name.

get_time_series_container(
    value::ReserveDemandCurve
) -> InfrastructureSystems.TimeSeriesContainer

Get ReserveDemandCurve time_series_container.

get_available(value::ReserveDemandCurve) -> Bool

Get ReserveDemandCurve available.

get_deployed_fraction(value::ReserveDemandCurve) -> Float64

Get ReserveDemandCurve deployed_fraction.

get_ext(value::ReserveDemandCurve) -> Dict{String, Any}

Get ReserveDemandCurve ext.

get_max_participation_factor(
    value::ReserveDemandCurve
) -> Float64

Get ReserveDemandCurve max_participation_factor.

get_sustained_time(value::ReserveDemandCurve) -> Float64

Get ReserveDemandCurve sustained_time.

get_time_frame(value::ReserveDemandCurve) -> Float64

Get ReserveDemandCurve time_frame.

get_variable(
    value::ReserveDemandCurve
) -> Union{Nothing, InfrastructureSystems.TimeSeriesKey}

Get ReserveDemandCurve variable.

set_available!(value::ReserveDemandCurve, val) -> Any

Set ReserveDemandCurve available.

set_deployed_fraction!(
    value::ReserveDemandCurve,
    val
) -> Any

Set ReserveDemandCurve deployed_fraction.

set_ext!(value::ReserveDemandCurve, val) -> Any

Set ReserveDemandCurve ext.

set_max_participation_factor!(
    value::ReserveDemandCurve,
    val
) -> Any

Set ReserveDemandCurve max_participation_factor.

set_sustained_time!(value::ReserveDemandCurve, val) -> Any

Set ReserveDemandCurve sustained_time.

set_time_frame!(value::ReserveDemandCurve, val) -> Any

Set ReserveDemandCurve time_frame.

set_time_series_container!(
    value::ReserveDemandCurve,
    val
) -> Any

Set ReserveDemandCurve time_series_container.

set_variable!(value::ReserveDemandCurve, val) -> Any

Set ReserveDemandCurve variable.