Lafros MaCS API

This document is the API specification for Lafros MaCS 1.2r1

Class Summary
abstract class ClientDiException (s : java.lang.String, e : java.lang.Exception) extends java.lang.Exception with AnyRef
as may be thrown by a OtherDiDependent.Context methods.
class CloneableSerializable extends java.lang.Cloneable with java.io.Serializable with AnyRef
convenience that may be used as the base class of status classes.
abstract class CmdException (s : java.lang.String, e : java.lang.Exception) extends java.lang.Exception with AnyRef
as may be thrown by a NonPollableDriver's interpretCmd method.
case class CmdExecutionException (val e : java.lang.Exception) extends CmdException with scala.Product
e was thrown during execution.
case class CmdNotRecognisedException (val cmd : AnyRef) extends CmdException with scala.Product
cmd was not recognised.
case class CmdUsageException (val advice : java.lang.String) extends CmdException with scala.Product
The command was misused in some way, as explained by advice.
trait ControlsGui extends Gui with AnyRef
control-panel GUI, for controlling the corresponding device interactively. Implementations should also implement ResultHandler if they wish to access the results of commands submitted, and ExceptionHandler, any exception thrown (after cmd has returned). A public constructor is required, optionally taking an argument corr'ding to the constants passed to the Di.Factory.createDi method invoked when deploying the device.
abstract class Di extends Subject
MaCS device-interface (DI). Having created an instance (using the methods of your Di.Factory.instance), deployment code may then manage it using the API shown below. Registering the DI allows it to participate as a node in a logical hierarchy (determined when the Di is created), which may be distributed over a local or wide area network.
class DiNameTakenException (diName : java.lang.String) extends java.lang.RuntimeException with AnyRef
thrown by a Di's register() method, if diName is already in use.
trait ExceptionHandler extends AnyRef
to be impl'ted by ControlsGuis/MonitorGuis wishing to be notified of any exceptions thrown by the commands/queries they submit.
trait Gui extends AnyRef
has abstract scala.swing.Component.
trait MonitorGui extends Gui
monitor window GUI, for displaying the device's status. A public constructor is required, optionally taking an argument corr'ding to the constants passed to the Di.Factory.createDi method invoked when deploying the device.
case class NoSuchServerDiException (val name : java.lang.String) extends ClientDiException with scala.Product
The intended recipient of the command is not registered with the target.
case class NotRegisteredException extends ClientDiException with scala.Product
The DI itself is not registered with the target.
trait OtherDiDependent extends AnyRef
for impl'n by Di.Drivers requiring access to other DIs.
trait ResultHandler extends AnyRef
result handler. To be impl'ted by ControlsGuis and MonitorGuis wishing to receive the results of any commands submitted.
class TargetUnavailableException (hostname : java.lang.String, name : java.lang.String) extends java.lang.RuntimeException with AnyRef
thrown by a Di's register() method (and others).
Object Summary
object CmdExecutionException extends (java.lang.Exception) => CmdExecutionException
object CmdNotRecognisedException extends (AnyRef) => CmdNotRecognisedException
object CmdUsageException extends (java.lang.String) => CmdUsageException
object ControlsGui extends AnyRef
companion.
object Di extends AnyRef
companion.
object NoSuchServerDiException extends (java.lang.String) => NoSuchServerDiException
object NotRegisteredException extends () => NotRegisteredException
object OtherDiDependent extends AnyRef
companion.