class Quartz::Simulation
- Quartz::Simulation
- Reference
- Object
Overview
This class represent the interface to the simulation
Included Modules
- Enumerable(Quartz::Duration)
- Iterable(Quartz::Duration)
Defined in:
quartz/simulation.crConstructors
Instance Method Summary
-
#abort
Abort the currently running or initialized simulation.
- #aborted?(*args, **options)
- #aborted?(*args, **options, &)
-
#default_scheduler : Symbol
Returns the default scheduler to use.
- #done?(*args, **options)
- #done?(*args, **options, &)
-
#each
Must return an
Iterator
over the elements in this collection. -
#each(&)
Must yield this collection's elements to the block.
- #elapsed_secs
- #final_time : Time::Span?
- #generate_graph(io : IO)
- #generate_graph(path = "model_hierarchy.dot")
- #initialize_simulation
- #initialized?(*args, **options)
- #initialized?(*args, **options, &)
- #inspect(io)
- #model : Quartz::CoupledModel
- #notifier : Hooks::Notifier
- #percentage
- #ready?(*args, **options)
- #ready?(*args, **options, &)
-
#restart
Restart a terminated simulation (either done or aborted) and goes to a ready state.
-
#run_validations? : Bool
Whether
Quartz::Validations
will be run during simulation. - #running?(*args, **options)
- #running?(*args, **options, &)
-
#simulate
TODO error hook
- #start_time : Time::Span?
- #status : Status
- #step : Duration | Nil
-
#termination_condition(&block : TimePoint, CoupledModel -> Bool)
Set the termination condition
-
#transition_stats
Returns the number of transitions per model along with the total
- #virtual_time : TimePoint
Instance methods inherited from class Reference
==(other : Quartz::Any)
==
Instance methods inherited from class Object
===(other : Quartz::Any)
===
Constructor Detail
def self.new(model : Model, *, scheduler : Symbol = :binary_heap, maintain_hierarchy : Bool = true, duration : Duration | TimePoint = Duration::INFINITY, run_validations : Bool = false, notifier : Hooks::Notifier = Hooks::Notifier.new)
#
Instance Method Detail
def each
#
Description copied from module Iterable(Quartz::Duration)
Must return an Iterator
over the elements in this collection.
def each(&)
#
Description copied from module Enumerable(Quartz::Duration)
Must yield this collection's elements to the block.
Set the termination condition