scalation.event

Model

Related Doc: package event

class Model extends Modelable with Identifiable

The Model class schedules events and implements the time advance mechanism for simulation model following the event-scheduling world view.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Model
  2. Identifiable
  3. Error
  4. Modelable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Model(name: String, animating: Boolean = false)

    name

    the name of the model

    animating

    whether to animate the model (only for Event Graphs)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. val HOUR: Double

    The number of seconds in one hour

    The number of seconds in one hour

    Attributes
    protected
    Definition Classes
    Modelable
  5. val MINUTE: Double

    The number of seconds in one minute

    The number of seconds in one minute

    Attributes
    protected
    Definition Classes
    Modelable
  6. var _clock: Double

    The clock that keep track of the current simulation time

    The clock that keep track of the current simulation time

    Attributes
    protected
    Definition Classes
    Modelable
  7. def addStats(stat: Statistic*): Unit

    Add statistical collector to the model.

    Add statistical collector to the model.

    stat

    one or more statistical collectors

  8. def animate(who: Identifiable, what: animation.CommandType.Value, color: Color, shape: Shape, from: Event, to: Event, at: Array[Double] = Array ()): Unit

    Put a edge command on the animation queue.

    Put a edge command on the animation queue.

    who

    who is being animated

    what

    what animation command

    color

    the color the edge

    shape

    the shape of the edge

    from

    the location of the origination node

    to

    the location of the destination node

    at

    the location of the edge (empty array => implicitly determined)

  9. def animate(who: Identifiable, what: animation.CommandType.Value, color: Color, shape: Shape, at: Array[Double]): Unit

    Put a node/token command on the animation queue.

    Put a node/token command on the animation queue.

    who

    who is being animated

    what

    what animation command

    color

    the color the node/token

    shape

    the shape of the node/token

    at

    the location of the node/token

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def cancel(event: Event): Unit

    Cancel the specified 'event' so it will not occur.

    Cancel the specified 'event' so it will not occur.

    event

    the event to cancel

  12. def clock: Double

    Return the current value of the director's clock.

    Return the current value of the director's clock.

    Definition Classes
    Modelable
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(that: Any): Boolean

    Determine whether Identifiable object 'this' equals Identifiable object 'that'.

    Determine whether Identifiable object 'this' equals Identifiable object 'that'. Works since 'id' is unique for all Identifiable objects.

    Definition Classes
    Identifiable → AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flaw(method: String, message: String): Unit

    Show the flaw by printing the error message.

    Show the flaw by printing the error message.

    method

    the method where the error occurred

    message

    the error message

    Definition Classes
    Error
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def getStatistics: ListBuffer[Statistic]

    Return the statistical results of the simulation (statistics for each part).

  20. def hashCode(): Int

    Return the hashCode as the unique id.

    Return the hashCode as the unique id.

    Definition Classes
    Identifiable → AnyRef → Any
  21. def id: Int

    Get the id (unique identifier).

    Get the id (unique identifier).

    Definition Classes
    Identifiable
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def leave(entity: Entity): Unit

    Leave the model recording the entity's time in the sYstem.

    Leave the model recording the entity's time in the sYstem.

    entity

    the entity leaving the model

  24. def me: String

    Return the full identity.

    Return the full identity.

    Definition Classes
    Identifiable
  25. def name: String

    Get the name.

    Get the name.

    Definition Classes
    Identifiable
  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. def report(vars: (String, Double)*): Unit

    Report values of the specified model result/output variables.

    Report values of the specified model result/output variables.

    vars

    the result/output variables for the simulation

  30. def reportStats: Unit

    Report statistical results of the simulation for all the collectors.

  31. def schedule(event: Event): Unit

    Place an event on the Future Event List (FEL) for later execution, thus scheduling the event to occur sometime in the future.

    Place an event on the Future Event List (FEL) for later execution, thus scheduling the event to occur sometime in the future. Events are ordered by their event/act time.

    event

    the event to schedule

  32. def setName(label: String): Unit

    Set the name.

    Set the name.

    label

    the name to assign

    Definition Classes
    Identifiable
  33. def simType: String

    Get the type of the simulation object.

    Get the type of the simulation object.

    Definition Classes
    Identifiable
  34. def simulate(startTime: Double = 0.0): Unit

    Run the simulation by iteratively processing events in time order.

    Run the simulation by iteratively processing events in time order. Requires at least one to already be scheduled (see next method).

    startTime

    the time at which the simulation is to begin

    Definition Classes
    ModelModelable
  35. var simulating: Boolean

    Simulation execution/termination flag

    Simulation execution/termination flag

    Attributes
    protected
    Definition Classes
    Modelable
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Identifiable

Inherited from Error

Inherited from Modelable

Inherited from AnyRef

Inherited from Any

Ungrouped