PythonProcess

Instance Constructors

new PythonProcess(name: String)

Type Members

class Dimension extends AnyRef

Needed for NetCDF et al.
Needed for NetCDF et al. TODO: explain better

Definition Classes
BaseProcess
implicit class DoubleVarMap extends AnyRef

implicit utility class for extra operations on a group of DoubleVars
implicit utility class for extra operations on a group of DoubleVars

Definition Classes
VarConversions
type F = (Double, Double, Seq[DoubleVar]) ⇒ Unit
case class Python(module: String) extends Dynamic with Product with Serializable
case class py(vs: DoubleVar*) extends Product with Serializable

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def <<<(right: VarContainer): Unit

Definition Classes
VarContainer
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def >>>(right: VarContainer): Unit

Definition Classes
VarContainer
Annotations
@inline()
def Boolean(meta: VarMeta): BooleanVar

Definition Classes
VarContainer
object Dimension

Definition Classes
BaseProcess
def Double(meta: VarMeta): DoubleVar

Definition Classes
VarContainer
def Float(meta: VarMeta): FloatVar

Definition Classes
VarContainer
def Int(meta: VarMeta): IntVar

Definition Classes
VarContainer
def Long(meta: VarMeta): LongVar

Definition Classes
VarContainer
implicit def String2Meta(s: String): VarMeta

Definition Classes
VarContainer
Annotations
@inline()
implicit def Var2Meta(v: Var[_]): VarMeta

Definition Classes
VarConversions
Annotations
@inline()
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
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
def addVar(nv: BooleanVar): BooleanVar

Definition Classes
VarContainer
def addVar(nv: DoubleVar): DoubleVar

Definition Classes
VarContainer
def addVar(nv: FloatVar): FloatVar

Definition Classes
VarContainer
def addVar(nv: LongVar): LongVar

Definition Classes
VarContainer
def addVar(nv: IntVar): IntVar

Definition Classes
VarContainer
def allVars: Map[VarMeta, Var[_]]

Definition Classes
VarContainer
def annotate(k: String, v: Any): Unit

Add an annotation
Add an annotation

Definition Classes
Annotation
val annotations: Map[String, Any]

Definition Classes
Annotation
def apply(t: Double, tau: Double): Unit

A wrapper around the user defined step function to calculate changes.
A wrapper around the user defined step function to calculate changes. This wrapper is the main way that the step function should be called and it has the additional responsibility of calling any StepHandlers.
t
the time at the beginning of the step
tau
the size of the step (delta-t)

Definition Classes
BaseProcess
final def asInstanceOf[T0]: T0

Definition Classes
Any
val boolVars: VarMap[Boolean, BooleanVar]

Definition Classes
VarContainer
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dimensions: Map[Var[_], Int]

a list of dimensions and their size/index
a list of dimensions and their size/index

Definition Classes
BaseProcess
val doubleVars: VarMap[Double, DoubleVar]

Definition Classes
VarContainer
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Finish hook.
Finish hook. Expected to be called once at the end of theprocess. Finishes the step handlers. Remember to call super.finish if you override this!

Definition Classes
BaseProcess
val floatVars: VarMap[Float, FloatVar]

Definition Classes
VarContainer
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
implicit def getVarValue[T](v: Var[T]): T

Definition Classes
VarConversions
Annotations
@inline()
def hashCode(): Int

Definition Classes
AnyRef → Any
def init(t: Double): Unit

Initialisation hook.
Initialisation hook. Expected to be called once before the process runs for the first time. Initialises step handlers and adds basic annotations. Remember to call super.init(t) if you override this!
t
the time at the beginning of the simulation

Definition Classes
BaseProcess
val intVars: VarMap[Int, IntVar]

Definition Classes
VarContainer
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def leftMerge(right: VarContainer): Unit

Definition Classes
VarContainer
def leftUpdate(right: VarContainer): Unit

Definition Classes
VarContainer
val longVars: VarMap[Long, LongVar]

Definition Classes
VarContainer
val name: String

a process is required to have a name (XXX: really? why?)
a process is required to have a name (XXX: really? why?)

Definition Classes
Process → BaseProcess
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reset(t: Double): Unit

Reset hook.
Reset hook. May be called as necessary. Resets the step handlers. May be overridden in sub-classes to reset internal state. Rember to call super.reset(t) if you do this!
t
the new time

Definition Classes
BaseProcess
def state: Seq[Var[_]]

All variables defined in this BaseProcess.
All variables defined in this BaseProcess.

Definition Classes
BaseProcess
def step(t: Double, tau: Double): Unit

This function takes the state from where it is at time t to where it is at t + tau.
This function takes the state from where it is at time t to where it is at t + tau. This must be supplied by concrete sub-classes. Except for testing, it is always called via the BaseProcess.apply method so that any StepHandlers also get executed.
t
the time at the beginning of the step
tau
the size of the step (delta-t)

Definition Classes
PythonProcess → BaseProcess
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
def stringPrefix: String

Definition Classes
Process → BaseProcess
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

abstract class PythonProcess extends Process

Instance Constructors

new PythonProcess(name: String)

Type Members

class Dimension extends AnyRef

implicit class DoubleVarMap extends AnyRef

type F = (Double, Double, Seq[DoubleVar]) ⇒ Unit

case class Python(module: String) extends Dynamic with Product with Serializable

case class py(vs: DoubleVar*) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

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

final def ==(arg0: Any): Boolean

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

def Boolean(meta: VarMeta): BooleanVar

object Dimension

def Double(meta: VarMeta): DoubleVar

def Float(meta: VarMeta): FloatVar

def Int(meta: VarMeta): IntVar

def Long(meta: VarMeta): LongVar

implicit def String2Meta(s: String): VarMeta

implicit def Var2Meta(v: Var[_]): VarMeta

def addBasicAnnotations: Unit

def addStepHandler(sh: StepHandler): Unit

def addVar(nv: BooleanVar): BooleanVar

def addVar(nv: DoubleVar): DoubleVar

def addVar(nv: FloatVar): FloatVar

def addVar(nv: LongVar): LongVar

def addVar(nv: IntVar): IntVar

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

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

val annotations: Map[String, Any]

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

final def asInstanceOf[T0]: T0

val boolVars: VarMap[Boolean, BooleanVar]

def clone(): AnyRef

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

val doubleVars: VarMap[Double, DoubleVar]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def finish: Unit

val floatVars: VarMap[Float, FloatVar]

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

final def getClass(): Class[_]

implicit def getVarValue[T](v: Var[T]): T

def hashCode(): Int

def init(t: Double): Unit

val intVars: VarMap[Int, IntVar]

final def isInstanceOf[T0]: Boolean

def leftMerge(right: VarContainer): Unit

def leftUpdate(right: VarContainer): Unit

val longVars: VarMap[Long, LongVar]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reset(t: Double): Unit

def state: Seq[Var[_]]

def step(t: Double, tau: Double): Unit

val stepHandlers: ArrayBuffer[StepHandler]

def stringPrefix: String

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

def toJSON: String

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Process

Inherited from VarConversions

Inherited from BaseProcess

Inherited from Annotation

Inherited from VarContainer

Inherited from AnyRef

Inherited from Any

Ungrouped