trait AnyProgramContext in com.lafros.macs.pd.an

Scala Monitoring and Control System API

com.lafros.macs.pd.an

trait AnyProgramContext

[source: com/lafros/macs/pd/an/AnyProgramContext.scala]

trait AnyProgramContext: extends AnyRef

as passed to the methods of PD Programs.

Author: Rob Dickens

Direct Known Subclasses:: ConstantlessPd.ProgramContext, Pd.ProgramContext, NonPollableConstantlessPd.ProgramContext, NonPollablePd.ProgramContext

Value Summary
`abstract var`	lastBoundaryMillis : Long scheduled time at which the `Program`'s `complete` method was to be called. Unless this or `periodMillis` are modified, or unless the `Program` is `macs.util.Timer.Params.Dependent`, this will always fall exactly midway between successive sampling boundaries, no matter how the prevailing sampling timer parameters may change. Otherwise, the `macs.util.Timer` controlling when the `complete` method is called will only be reconfigured when `lastBoundaryMillis` or `periodMillis` are modified.
`abstract var`	periodMillis : Long period with which `complete` method is called. See also `lastBoundaryMillis`.

Method Summary
`abstract def`	addAlert (msg : java.lang.String, isIntrusive : Boolean) : Unit The alert will be added to the `program.Info.alerts` when the calling program method returns or throws an exception. In the case of the `complete` method, the alert must be added every time the method is called.

Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized

Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf

Value Details

abstract var lastBoundaryMillis : Long

scheduled time at which the Program's complete method was to be called. Unless this or periodMillis are modified, or unless the Program is macs.util.Timer.Params.Dependent, this will always fall exactly midway between successive sampling boundaries, no matter how the prevailing sampling timer parameters may change. Otherwise, the macs.util.Timer controlling when the complete method is called will only be reconfigured when lastBoundaryMillis or periodMillis are modified.

abstract var periodMillis : Long

period with which complete method is called. See also lastBoundaryMillis.

Method Details

abstract def addAlert(msg : java.lang.String, isIntrusive : Boolean) : Unit

The alert will be added to the program.Info.alerts when the calling program method returns or throws an exception. In the case of the complete method, the alert must be added every time the method is called.

	Lafros MaCS 1.2r1

	Lafros MaCS 1.2r1