Move operators.jl to utils and introduce scheduling with datetimes

Author: BenLauwens

README.md

@@ -39,6 +39,23 @@ julia> Pkg.add("SimJulia")
 
 * Version 0.4 is a complete rewrite: more julian and less pythonic.
 * Only supports Julia v0.6 and above.
+* Scheduling of events can be done with `Base.Dates.Datetime` and `Base.Dates.Period`:
+```
+using SimJulia
+using Base.Dates
+
+function datetimetest(sim::Simulation)
+  println(nowDatetime(sim))
+  yield(Timeout(sim, Day(2)))
+  println(nowDatetime(sim))
+end
+
+datetime = now()
+sim = Simulation(datetime)
+@process datetimetest(sim)
+run(sim, datetime+Month(3))
+println(nowDatetime(sim))
+```
 * The discrete event features are on par with version 0.3. (STABLE)
 * Two ways of making `Processes` are provided:
   - using the existing concept of `Tasks`:
@@ -54,7 +71,7 @@ julia> Pkg.add("SimJulia")
   end
 
   sim = Simulation()
-  @Process fibonnaci(sim)
+  @process fibonnaci(sim)
   run(sim, 10)
   ```
   - using a novel finite-statemachine approach:
@@ -70,7 +87,7 @@ julia> Pkg.add("SimJulia")
   end
 
   sim = Simulation()
-  @Coroutine fibonnaci(sim)
+  @coroutine fibonnaci(sim)
   run(sim, 10)
   ```
 * The continuous time simulation is based on a quantized state system solver. (EXPERIMENTAL)

src/SimJulia.jl

@@ -19,6 +19,7 @@ module SimJulia
   export (&), (|)
   export Simulation
   export run, now, active_process
+  export nowDatetime
   export Process, @process
   export yield, interrupt
   export FiniteStateMachine, @stateful, @yield
@@ -28,10 +29,10 @@ module SimJulia
 
   include("base.jl")
   include("events.jl")
-  include("operators.jl")
-  include("tasks/base.jl")
+  include("utils/operators.jl")
   include("simulations.jl")
   include("utils/time.jl")
+  include("tasks/base.jl")
   include("processes.jl")
   include("finitestatemachines/utils.jl")
   include("finitestatemachines/transforms.jl")

src/base.jl

@@ -61,7 +61,7 @@ function schedule(ev::AbstractEvent, delay::Number=zero(Float64); priority::Int8
   env = environment(ev)
   bev = ev.bev
   bev.value = value
-  env.heap[bev] = EventKey(env.time + delay, priority, env.sid+=one(UInt))
+  env.heap[bev] = EventKey(now(env) + delay, priority, env.sid+=one(UInt))
   bev.state = scheduled
 end
 

src/operators.jl src/utils/operators.jlsrc/operators.jl renamed to src/utils/operators.jl

@@ -3,11 +3,15 @@ function Simulation(initial_time::DateTime)
 end
 
 function run(env::Environment, until::DateTime)
-  run(env, Base.Dates.datetime2epochms(until)-now(env))
+  run(env, Base.Dates.datetime2epochms(until))
 end
 
 function Timeout(env::Environment, delay::Period; priority::Int8=zero(Int8), value::Any=nothing)
   time = now(env)
   del = Base.Dates.datetime2epochms(Base.Dates.epochms2datetime(time)+delay)-time
   Timeout(env, del;priority=priority, value=value)
 end
+
+function nowDatetime(env::Environment)
+  Base.Dates.epochms2datetime(now(env))
+end

src/utils/time.jl

@@ -2,9 +2,10 @@ testpath(f) = joinpath(dirname(@__FILE__), f)
 
 for test_file in [
   "base.jl",
-  "simulations.jl",
   "events.jl",
-  "operators.jl",
+  "utils/operators.jl",
+  "simulations.jl",
+  "utils/time.jl",
   "tasks/base.jl",
   "processes.jl",
   "finitestatemachines/utils.jl",

test/runtests.jl

@@ -0,0 +1,14 @@
+using SimJulia
+using Base.Dates
+
+function datetimetest(sim::Simulation)
+  println(nowDatetime(sim))
+  yield(Timeout(sim, Day(2)))
+  println(nowDatetime(sim))
+end
+
+datetime = now()
+sim = Simulation(datetime)
+@process datetimetest(sim)
+run(sim, datetime+Month(3))
+println(nowDatetime(sim))