uk.ac.ed.inf.mois

ProcessGroup

class ProcessGroup extends BaseProcess

A ProcessGroup is a list of BaseProcesses and a Scheduler. It presents the same interface as a BaseProcess and so hierarchies of them can be built.

It is typically created like so

import uk.ac.ed.inf.mois.ProcessGroup
import uk.ac.ed.inf.mois.sched.WeisseScheduler

val group = new ProcessGroup("my group")
group.scheduler = new WeisseScheduler(tolerance=0.1)

group += new SomeSortOfProcess
group += new SomeOtherSortOfProcess
...
Linear Supertypes
BaseProcess, Annotation, VarContainer, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ProcessGroup
  2. BaseProcess
  3. Annotation
  4. VarContainer
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProcessGroup(name: String)

    name

    the name of the process

Type Members

  1. class Dimension extends AnyRef

    Needed for NetCDF et al.

    Needed for NetCDF et al. TODO: explain better

    Definition Classes
    BaseProcess

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +=(proc: BaseProcess): ProcessGroup

    The += operator adds a process to the group.

  4. def -=(proc: BaseProcess): Nothing

    (Unimplemented) The -= operator removes a process from the group.

  5. final def <<<(right: VarContainer): Unit

    Definition Classes
    VarContainer
    Annotations
    @inline()

  6. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  7. final def >>>(right: VarContainer): Unit

    Definition Classes
    VarContainer
    Annotations
    @inline()

  8. def Boolean(meta: VarMeta): BooleanVar

    Definition Classes
    VarContainer

  9. object Dimension

    Definition Classes
    BaseProcess

  10. def Double(meta: VarMeta): DoubleVar

    Definition Classes
    VarContainer

  11. def Float(meta: VarMeta): FloatVar

    Definition Classes
    VarContainer

  12. def Int(meta: VarMeta): IntVar

    Definition Classes
    VarContainer

  13. def Long(meta: VarMeta): LongVar

    Definition Classes
    VarContainer

  14. implicit def String2Meta(s: String): VarMeta

    Definition Classes
    VarContainer
    Annotations
    @inline()

  15. def addBasicAnnotations: Unit

    Automatically annotate the process with its software name and version

    Automatically annotate the process with its software name and version

    Attributes
    protected
    Definition Classes
    BaseProcess

  16. def addStepHandler(sh: StepHandler): Unit

    Add a StepHandler to the list

    Add a StepHandler to the list

    sh

    the step handler, evidently

    Definition Classes
    BaseProcess

  17. def addVar(nv: BooleanVar): BooleanVar

    Definition Classes
    VarContainer

  18. def addVar(nv: DoubleVar): DoubleVar

    Definition Classes
    VarContainer

  19. def addVar(nv: FloatVar): FloatVar

    Definition Classes
    VarContainer

  20. def addVar(nv: LongVar): LongVar

    Definition Classes
    VarContainer

  21. def addVar(nv: IntVar): IntVar

    Definition Classes
    VarContainer

  22. def allVars: Map[VarMeta, Var[_]]

    Definition Classes
    VarContainer

  23. def annotate(k: String, v: Any): Unit

    Add an annotation

    Add an annotation

    Definition Classes
    Annotation

  24. val annotations: Map[String, Any]

    Definition Classes
    Annotation

  25. def apply(t: Double, tau: Double): Unit

    Override the BaseProcess.apply method because we take on responsibility for calling the step handlers.

    Override the BaseProcess.apply method because we take on responsibility for calling the step handlers.

    t

    the time at the beginning of the step

    tau

    the size of the step (delta-t)

    Definition Classes
    ProcessGroup → BaseProcess
    Annotations
    @inline()

  26. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  27. val boolVars: VarMap[Boolean, BooleanVar]

    Definition Classes
    VarContainer

  28. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. val dimensions: Map[Var[_], Int]

    a list of dimensions and their size/index

    a list of dimensions and their size/index

    Definition Classes
    BaseProcess

  30. val doubleVars: VarMap[Double, DoubleVar]

    Definition Classes
    VarContainer

  31. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  33. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  34. def finish: Unit

    Override finish hook by calling all of our children's before our own

    Override finish hook by calling all of our children's before our own

    Definition Classes
    ProcessGroup → BaseProcess

  35. val floatVars: VarMap[Float, FloatVar]

    Definition Classes
    VarContainer

  36. def fromJSON(s: String): Seq[Var[_]]

    Parses a JSON string and adds all variable definitions that it finds to this VarContainer.

    Parses a JSON string and adds all variable definitions that it finds to this VarContainer.

    returns

    the Seq of added variables.

    Definition Classes
    VarContainer

  37. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  38. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  39. def init(t: Double): Unit

    Override init hook by calling all of our children's before our own

    Override init hook by calling all of our children's before our own

    t

    the time at the beginning of the simulation

    Definition Classes
    ProcessGroup → BaseProcess

  40. val intVars: VarMap[Int, IntVar]

    Definition Classes
    VarContainer

  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  42. def leftMerge(right: VarContainer): Unit

    Definition Classes
    VarContainer

  43. def leftUpdate(right: VarContainer): Unit

    Definition Classes
    VarContainer

  44. val longVars: VarMap[Long, LongVar]

    Definition Classes
    VarContainer

  45. val name: String

    the name of the process

    the name of the process

    Definition Classes
    ProcessGroup → BaseProcess

  46. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  47. final def notify(): Unit

    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  49. var processes: ArrayBuffer[BaseProcess]

    The list of child processes

  50. def reset(t: Double): Unit

    Override reset hook by calling all of our children's before our own

    Override reset hook by calling all of our children's before our own

    t

    the new time

    Definition Classes
    ProcessGroup → BaseProcess

  51. var scheduler: Scheduler

    The scheduler

  52. def state: Seq[Var[_]]

    All variables defined in this BaseProcess.

    All variables defined in this BaseProcess.

    Definition Classes
    BaseProcess

  53. def step(t0: Double, tau: Double): Unit

    The BaseProcess.step method of the BaseProcess interface calls the Scheduler on the list of processes together with the group state table and time parameters.

    The BaseProcess.step method of the BaseProcess interface calls the Scheduler on the list of processes together with the group state table and time parameters.

    tau

    the size of the step (delta-t)

    Definition Classes
    ProcessGroup → BaseProcess

  54. val stepHandlers: ArrayBuffer[StepHandler]

    the list of handlers that run after each step

    the list of handlers that run after each step

    Definition Classes
    BaseProcess

  55. def stringPrefix: String

    Definition Classes
    ProcessGroup → BaseProcess

  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  57. def toJSON: String

    Creates a JSON string with all variables in this VarContainer.

    Creates a JSON string with all variables in this VarContainer.

    Definition Classes
    VarContainer

  58. def toString(): String

    Definition Classes
    BaseProcess → AnyRef → Any

  59. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  60. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  61. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BaseProcess

Inherited from Annotation

Inherited from VarContainer

Inherited from AnyRef

Inherited from Any

Ungrouped