implement TrackedResource

Project.toml

@@ -5,14 +5,16 @@ license = "MIT"
 desc = "A discrete event process oriented simulation framework."
 authors = ["Ben Lauwens and SimJulia and ConcurrentSim contributors"]
 repo = "https://github.com/JuliaDynamics/ConcurrentSim.jl.git"
-version = "1.1.0"
+version = "1.2.0"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 ResumableFunctions = "c5292f4c-5179-55e1-98c5-05642aab7184"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
 [compat]
 DataStructures = "0.18"
 ResumableFunctions = "0.6"
+Tables = "1.10.1"
 julia = "1.6"

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 ConcurrentSim = "6ed1e86c-fcaf-46a9-97e0-2b26a2cdb499"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ResumableFunctions = "c5292f4c-5179-55e1-98c5-05642aab7184"

src/ConcurrentSim.jl

@@ -18,6 +18,7 @@ module ConcurrentSim
   export AbstractProcess, Simulation, run, now, active_process, StopSimulation
   export Process, @process, interrupt
   export Container, Resource, Store, put!, get, cancel, request, tryrequest
+  export TrackedResource
   export nowDatetime
 
   include("base.jl")
@@ -28,6 +29,7 @@ module ConcurrentSim
   include("resources/base.jl")
   include("resources/containers.jl")
   include("resources/stores.jl")
+  include("resources/tracked.jl")
   include("utils/time.jl")
   include("deprecated.jl")
 end

src/resources/tracked.jl

@@ -0,0 +1,101 @@
+import Tables
+
+"""
+A wrapper around a resource that tracks the time at which the resource is interacted with.
+
+```jldoctest
+julia> using ConcurrentSim, DataFrames
+
+julia> env = Simulation(); r = TrackedResource(Resource(env));
+
+julia> run(env, 1); now(env)
+1.0
+
+julia> request(r); run(env, 2); now(env)
+2.0
+
+julia> request(r); run(env, 3); unlock(r); run(env, 4); now(env)
+4.0
+
+julia> DataFrame(r)
+3×2 DataFrame
+ Row │ events    times
+     │ Symbol    Float64
+─────┼───────────────────
+   1 │ increase      1.0
+   2 │ increase      2.0
+   3 │ decrease      3.0
+```
+"""
+struct TrackedResource{T}
+    resource::T
+    events::Vector{Symbol}
+    times::Vector{Float64}
+end
+
+TrackedResource(resource) = TrackedResource(resource, Symbol[], Float64[])
+
+function Base.take!(tr::TrackedResource, args...; kwargs...)
+    r = take!(tr.resource, args...; kwargs...)
+    push!(tr.events, :decrease)
+    push!(tr.times, now(tr.resource.env))
+    return r
+end
+
+function Base.put!(tr::TrackedResource, args...; kwargs...)
+    r = put!(tr.resource, args...; kwargs...)
+    push!(tr.events, :increase)
+    push!(tr.times, now(tr.resource.env))
+    return r
+end
+
+function Base.unlock(tr::TrackedResource, args...; kwargs...)
+    r = unlock(tr.resource, args...; kwargs...)
+    push!(tr.events, :decrease)
+    push!(tr.times, now(tr.resource.env))
+    return r
+end
+
+function request(tr::TrackedResource, args...; kwargs...)
+    r = request(tr.resource, args...; kwargs...)
+    push!(tr.events, :increase)
+    push!(tr.times, now(tr.resource.env))
+    return r
+end
+
+##
+# Tables interface
+##
+
+Tables.istable(::Type{<:TrackedResource}) = true
+Tables.schema(tr::TrackedResource) = Tables.Schema(Tables.columnnames(tr), [Symbol, Float64])
+
+Tables.columnaccess(::Type{<:TrackedResource}) = true
+
+Tables.columns(tr::TrackedResource) = tr
+
+function Tables.getcolumn(tr::TrackedResource, i::Int)
+    if i == 1
+        return tr.events
+    elseif i == 2
+        return tr.times
+    else
+        error("`TrackedResource` has only two columns, but you are attempting to access column $(i).")
+    end
+end
+
+function Tables.getcolumn(tr::TrackedResource, s::Symbol)
+    if s == :events
+        return tr.events
+    elseif s == :times
+        return tr.times
+    else
+        error("`TrackedResource` has only two columns (events and times), but you are attempting to access column $(s).")
+    end
+end
+
+function Tables.columnnames(tr::TrackedResource)
+    return (:events, :times)
+end
+
+# TODO Makie recipes

test/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"