A C D E G H I N O P R S T U W

A

ABENDED - Static variable in interface org.jmacs.pd.IProgram.States

an exception was thrown.

actionPerformed(ActionEvent, IControlsGui.IContext) - Method in interface org.jmacs.IControlsGui

invoked by listener set by setActionListener.

ALERT_TRIGGERED - Static variable in interface org.jmacs.pd.IProgram.States

alert triggered.

C

classname() - Method in interface org.jmacs.pd.IProgInfo

returns fully-qualified name of program class.

ClientDiDroppedException - Exception in org.jmacs

thrown by IDiDriver.IContext methods if the client DI has itself been dropped.

ClientDiDroppedException() - Constructor for exception org.jmacs.ClientDiDroppedException

creates new instance.

ClientDiException - Exception in org.jmacs

thrown by IDiDriver.IContext methods if the intended server-DI isn't currently reachable.

ClientDiException() - Constructor for exception org.jmacs.ClientDiException

creates new instance.

ClientDiException(String) - Constructor for exception org.jmacs.ClientDiException

creates new instance.

clone() - Method in class org.jmacs.CloneableSerializable

overrides protected method of superclass.

CloneableSerializable - Class in org.jmacs

convenience that may be used as the base class of status classes.

CloneableSerializable() - Constructor for class org.jmacs.CloneableSerializable

only to be instantiated by subclasses.

codebase() - Method in interface org.jmacs.pd.IProgInfo

returns codebase used to load program class.

connect() - Method in interface org.jmacs.IDiClient

to JMACS server.

connect(int) - Method in interface org.jmacs.IDiClient

as above, but specifying the local port to which the socket that creates the connection for sending status samples in the unicast case, must bind.

connect(int, int) - Method in interface org.jmacs.IDiClient

as above, but also specifying the local port to which the socket that creates the connection for receiving subscribed-to status samples in the unicast case, must bind.

connect() - Method in class org.jmacs.pd.DiClient

impl'ts IDiClient.

connect(int) - Method in class org.jmacs.pd.DiClient

impl'ts IDiClient.

connect(int, int) - Method in class org.jmacs.pd.DiClient

impl'ts IDiClient.

Constants - Class in org.jmacs.pd

passed to the constructors of the IMonitorGui and IControlsGui used by DiClient in order that any corr'ding GUIs provided by the device may be nested inside them.

createControlsGui() - Method in class org.jmacs.pd.Constants

returns controls gui, given that required classloader is available as the context classloader.

createMonitorGui() - Method in class org.jmacs.pd.Constants

returns monitor gui, given that required classloader is available as the context classloader.

createProgram(String, URL) - Static method in class org.jmacs.pd.StartProgram

returns a new instance of the specified program, using a new classloader so as to ensure we get the latest version.

createProgram(URL) - Static method in class org.jmacs.pd.StartProgram

deserialises and returns a new instance of the specified serialised program.

createProgram() - Method in class org.jmacs.pd.StartProgram

returns a new instance of the program.

createProxyDriver(Class) - Method in class org.jmacs.pd.ProxyDevice

for use to provide access to driver itself in the form of a dynamic proxy.

D

desc() - Method in interface org.jmacs.pd.IProgInfo

returns program description, as returned by its Object.toString().

DiClient - Class in org.jmacs.pd

IDiClient for the deployment of programmable devices.

DiClient(String, String, String, IDevice.IConstants) - Constructor for class org.jmacs.pd.DiClient

creates new instance.

DiClient(String, String, IDevice.IDriver, IDevice.IConstants) - Constructor for class org.jmacs.pd.DiClient

creates new instance.

DiClient(String, String, IDevice.IDriver, Object, IDevice.IConstants) - Constructor for class org.jmacs.pd.DiClient

creates new instance.

DiClient(String, String, IDevice.IDriver.IContainer, IDevice.IConstants) - Constructor for class org.jmacs.pd.DiClient

creates new instance.

DiClient(String, String, IDevice.IDriver.IContainer, Object, IDevice.IConstants) - Constructor for class org.jmacs.pd.DiClient

creates new instance.

DiClients - Class in org.jmacs

utility class, for use in device-deployment code.

DiDriverException - Exception in org.jmacs

thrown by DI driver (IDiDriver) methods.

DiDriverException(String) - Constructor for exception org.jmacs.DiDriverException

creates new instance--for use when no other exception was thrown.

DiDriverException(Throwable) - Constructor for exception org.jmacs.DiDriverException

creates new instance--for use when another exception was thrown.

disconnect() - Method in interface org.jmacs.IDiClient

from server.

disconnect() - Method in class org.jmacs.pd.DiClient

impl'ts IDiClient.

E

ENDED - Static variable in interface org.jmacs.pd.IProgram.States

the program completed normally.

errMsg() - Method in interface org.jmacs.pd.IProgInfo

returns the error message if an exception was thrown.

eventTime() - Method in interface org.jmacs.pd.IProgInfo

returns the time at which the change to the current program state occurred.

execute(IDevice.IDriver, IDevice.IStatus, IDevice.IConstants, IProgInfo) - Method in interface org.jmacs.pd.IPdCmd

called when the command is executed.

executeCmd(Serializable, boolean, String) - Method in interface org.jmacs.IDiDriver

executes cmd.

executeCmd(String, Serializable) - Method in interface org.jmacs.IDiDriver.IContext.IControlOnly

attempts to have diName execute cmd.

executeCmd(Serializable) - Method in interface org.jmacs.pd.IDevice

executes cmd.

executeCmd(Serializable) - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

G

getComponent() - Method in interface org.jmacs.IControlsGui

returns the root JComponent of the GUI.

getComponent() - Method in interface org.jmacs.IMonitorGui

returns the root JComponent of the GUI.

getDevicePkgName() - Method in class org.jmacs.pd.Constants

returns package name.

getDriver() - Method in interface org.jmacs.pd.IDevice.IDriver.IContainer

returns driver.

getLastBoundaryMillis() - Method in class org.jmacs.util.Timer

in case sleep not called.

getParams() - Method in class org.jmacs.util.Timer

returns parameters.

getPeriodMillis() - Method in class org.jmacs.util.Timer

returns period/ms.

getPeriodMillis() - Method in class org.jmacs.util.Timer.Params

returns period/ms.

getProgInfo() - Method in interface org.jmacs.pd.IDevice

returns program info.

getProgInfo() - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

getRefBoundaryMillis() - Method in class org.jmacs.util.Timer.Params

returns reference boundary/ms.

getSpi() - Static method in class org.jmacs.DiClients

returns the service-provider interface, as determined by the org.jmacs.spiClassname property--default value com.lafros.jmacs.d.Spi.

getStatus() - Method in interface org.jmacs.IDiDriver

samples the device's status at regular intervals.

getStatus(String) - Method in interface org.jmacs.IDiDriver.IContext

attempts to get status of diName.

getStatus(String, IDiDriver.IContext.TimestampContainer) - Method in interface org.jmacs.IDiDriver.IContext

as before but also returns timestamp via container.

getStatus() - Method in interface org.jmacs.pd.IDevice

returns device status as of last boundary.

getStatus() - Method in interface org.jmacs.pd.IDevice.IStatus.IFactory

returns current status.

getStatus() - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

getStatusEtc() - Method in interface org.jmacs.pd.IDevice

returns device status + program info as of last boundary.

getStatusEtc() - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

H

handleResult(Object) - Method in interface org.jmacs.IResultHandler

called when result available.

I

IAlert - Interface in org.jmacs.pd

passed to IProgram.wake(IDevice.IStatus, IAlert).

IControlsGui - Interface in org.jmacs

control panel GUI, for controlling a given device.

IControlsGui.IContext - Interface in org.jmacs

passed to IControlGuis, allowing them to submit commands.

IDevice - Interface in org.jmacs.pd

programmable device.

IDevice.IConstants - Interface in org.jmacs.pd

constants.

IDevice.IDriver - Interface in org.jmacs.pd

driver.

IDevice.IDriver.IContainer - Interface in org.jmacs.pd

driver container.

IDevice.IStatus - Interface in org.jmacs.pd

status.

IDevice.IStatus.IFactory - Interface in org.jmacs.pd

produces status.

IDiClient - Interface in org.jmacs

device-interface client.

IDiDriver - Interface in org.jmacs

device-interface (DI) driver.

IDiDriver.IClient - Interface in org.jmacs

wishes to be able to behave as client in some way.

IDiDriver.IClient.IControlOnly - Interface in org.jmacs

wishes to be able to send commands to other DIs.

IDiDriver.IClient.IFull - Interface in org.jmacs

wishes to be able to both subscribe and send commands.

IDiDriver.IClient.ISubscribeOnly - Interface in org.jmacs

wishes to be able to request to receive status samples from other DIs automatically.

IDiDriver.IContext - Interface in org.jmacs

passed to IDiDriver.IClients.

IDiDriver.IContext.IControlOnly - Interface in org.jmacs

passed to IDiDriver.IClient.IControllers.

IDiDriver.IContext.IFull - Interface in org.jmacs

passed to IDiDriver.IClient.IFulls.

IDiDriver.IContext.ISubscribeOnly - Interface in org.jmacs

passed to IDiDriver.IClient.ISubscribers.

IDiDriver.IContext.TimestampContainer - Class in org.jmacs

timestamp field will be set if instance is supplied when calling IContext.getStatus.

IDiDriver.IContext.TimestampContainer() - Constructor for class org.jmacs.IDiDriver.IContext.TimestampContainer

IInterpreter - Interface in org.jmacs.pd

command interpreter.

IMonitorGui - Interface in org.jmacs

monitor window GUI, for displaying the device's status.

IMonitorGui.IContext - Interface in org.jmacs

passed to monitor windows implementing IMonitorGui.IContextAware, allowing them to submit commands.

IMonitorGui.IContextAware - Interface in org.jmacs

have the IMonitorGui also implement this if it is to submit commands.

init(IDevice.IDriver, IDevice.IStatus, IDevice.IConstants, Timer) - Method in interface org.jmacs.pd.IProgram

called once, first, when the program is run.

interpretCmd(Object, IDevice.IDriver, IDevice.IStatus, IDevice.IConstants, IProgInfo, boolean) - Method in interface org.jmacs.pd.IInterpreter

interprets cmd.

IPdCmd - Interface in org.jmacs.pd

for use where a String may not be used, because the command cannot conveniently be expressed as text.

IProgInfo - Interface in org.jmacs.pd

information about any IProgram an IDevice is running or has run.

IProgram - Interface in org.jmacs.pd

to be implemented by all programs.

IProgram.States - Interface in org.jmacs.pd

program states.

IResultHandler - Interface in org.jmacs

result handler, to be implemented by IControlsGui and IMonitorGui if any commands return a non-null result.

ISamplingDependent - Interface in org.jmacs

for implementation by IDiDrivers dependent on status-sampling parameters.

ISpi - Interface in org.jmacs

service-provider interface, to be implemented by the JMACS Server vendor.

IStatusEtc - Interface in org.jmacs.pd

device status + program info.

N

NAMES - Static variable in interface org.jmacs.pd.IProgram.States

human readable.

newDiClient(String, String, String, String, Serializable) - Method in interface org.jmacs.ISpi

creates DI-client.

newDiClient(String, IDiDriver, String, String, Serializable) - Method in interface org.jmacs.ISpi

creates DI-client.

newDiClient(String, IDiDriver, Object, String, String, Serializable) - Method in interface org.jmacs.ISpi

creates DI-client.

NoSuchServerDiException - Exception in org.jmacs

thrown by IDiDriver.IContext methods if the intended server-DI isn't currently registered.

NoSuchServerDiException(String) - Constructor for exception org.jmacs.NoSuchServerDiException

creates new instance.

O

org.jmacs - package org.jmacs

core classes.

org.jmacs.pd - package org.jmacs.pd

Programmable Device Framework.

org.jmacs.util - package org.jmacs.util

including Timer.

P

progInfo() - Method in interface org.jmacs.pd.IStatusEtc

returns program info.

progInfo() - Method in class org.jmacs.pd.StatusPlusProgInfo

returns program info.

ProxyDevice - Class in org.jmacs.pd

IDevice impl'n to be extended by all programmable-device definitions.

ProxyDevice(IDiDriver.IContext.IFull, String) - Constructor for class org.jmacs.pd.ProxyDevice

creates new instance.

ProxyDevice(IDiDriver.IContext.IFull) - Constructor for class org.jmacs.pd.ProxyDevice

creates new instance.

ProxyDriverException - Exception in org.jmacs.pd

thrown by IDevice.IDriver methods as impl'ted by a dynamic proxy--see ProxyDevice.createProxyDriver(Class).

ProxyDriverException(Throwable) - Constructor for exception org.jmacs.pd.ProxyDriverException

creates new instance.

R

refresh(Object) - Method in interface org.jmacs.IMonitorGui

refreshes the values displayed.

runId() - Method in interface org.jmacs.pd.IProgInfo

identifies the particular run.

RUNNING - Static variable in interface org.jmacs.pd.IProgram.States

program is running.

S

ServerDownException - Exception in org.jmacs

thrown by IDiDriver.IContext methods if the JMACS server is currently down.

ServerDownException() - Constructor for exception org.jmacs.ServerDownException

creates new instance.

setActionListener(ActionListener) - Method in interface org.jmacs.IControlsGui

called once, first.

setContext(IDiDriver.IContext.IControlOnly) - Method in interface org.jmacs.IDiDriver.IClient.IControlOnly

sets context.

setContext(IDiDriver.IContext.IFull) - Method in interface org.jmacs.IDiDriver.IClient.IFull

sets context.

setContext(IDiDriver.IContext.ISubscribeOnly) - Method in interface org.jmacs.IDiDriver.IClient.ISubscribeOnly

sets context.

setContext(IMonitorGui.IContext) - Method in interface org.jmacs.IMonitorGui.IContextAware

called once, first.

setParams(long, long) - Method in class org.jmacs.util.Timer

sets parameters.

setParams(Timer.Params) - Method in class org.jmacs.util.Timer

sets parameters.

setPeriodMillis(long) - Method in class org.jmacs.util.Timer

sets new period/ms.

setRefBoundaryMillis(long) - Method in class org.jmacs.util.Timer

sets new reference boundary/ms.

setSamplingParams(Timer.Params) - Method in interface org.jmacs.ISamplingDependent

called if the status sampling params are changed.

sleep() - Method in class org.jmacs.util.Timer

until the next boundary.

startProgram(IProgram) - Method in interface org.jmacs.pd.IDevice

starts running prog.

startProgram(IProgram) - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

StartProgram - Class in org.jmacs.pd

immutable command to start the specified program.

StartProgram(URL) - Constructor for class org.jmacs.pd.StartProgram

creates new instance.

StartProgram(String, URL) - Constructor for class org.jmacs.pd.StartProgram

creates new instance.

startTime() - Method in interface org.jmacs.pd.IProgInfo

returns the time at which the program was started.

state() - Method in interface org.jmacs.pd.IProgInfo

returns the state of the program (see IProgram.States).

status() - Method in interface org.jmacs.pd.IStatusEtc

returns device status.

status() - Method in class org.jmacs.pd.StatusPlusProgInfo

returns device status.

StatusPlusProgInfo - Class in org.jmacs.pd

passed to the IMonitorGui.refresh(Object) method of the monitor window used by DiClient.

StatusPlusProgInfo() - Constructor for class org.jmacs.pd.StatusPlusProgInfo

STOP_PROGRAM - Static variable in interface org.jmacs.pd.IDevice

command to stop any program that might be running.

STOPPED - Static variable in interface org.jmacs.pd.IProgram.States

program was stopped.

stopProgram() - Method in interface org.jmacs.pd.IDevice

stops any program that might be running.

stopProgram() - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

submitCmd(Serializable) - Method in interface org.jmacs.IControlsGui.IContext

submits cmd.

submitCmd(Serializable, boolean) - Method in interface org.jmacs.IControlsGui.IContext

for use where the classloading is to be specified.

submitCmd(Serializable, IResultHandler) - Method in interface org.jmacs.IControlsGui.IContext

for use where the result is of interest.

submitCmd(Serializable, boolean, IResultHandler) - Method in interface org.jmacs.IControlsGui.IContext

for use where the classloading is to be specified, and the result is of interest.

submitCmd(Serializable) - Method in interface org.jmacs.IMonitorGui.IContext

submits cmd, placing it in a queue if a previous one has yet to complete.

submitCmd(Serializable, boolean) - Method in interface org.jmacs.IMonitorGui.IContext

for use where the classloading is to be specified.

submitCmd(Serializable, int) - Method in interface org.jmacs.IMonitorGui.IContext

as IMonitorGui.IContext.submitCmd(Serializable) but replaces any queued command having the same id.

submitCmd(Serializable, int, boolean) - Method in interface org.jmacs.IMonitorGui.IContext

as IMonitorGui.IContext.submitCmd(Serializable, boolean) but replaces any queued command having the same id.

subscribe(String, boolean) - Method in interface org.jmacs.IDiDriver.IContext.ISubscribeOnly

causes status samples from the specified DI to be fetched and cached as they become available, or that the subscription be ended.

subscribe(boolean) - Method in interface org.jmacs.pd.IDevice

causes the status to be obtained automatically.

subscribe(boolean) - Method in class org.jmacs.pd.ProxyDevice

impl'ts superclass.

T

terminate() - Method in interface org.jmacs.IDiClient

called last, to relinquish allocated resources.

terminate() - Method in class org.jmacs.pd.DiClient

impl'ts IDiClient.

terminate(IDevice.IStatus) - Method in interface org.jmacs.pd.IProgram

called last, if the program is terminated externally, to permit any tidying up to be performed.

Timer - Class in org.jmacs.util

timer which defines a cycle--in terms of its period and some reference boundary--and which is able to sleep until the next boundary of that cycle.

Timer() - Constructor for class org.jmacs.util.Timer

creates new instance.

Timer(long, long) - Constructor for class org.jmacs.util.Timer

creates new instance.

Timer(Timer.Params) - Constructor for class org.jmacs.util.Timer

creates new instance.

Timer.Params - Class in org.jmacs.util

immutable parameters.

Timer.Params(long, long) - Constructor for class org.jmacs.util.Timer.Params

creates new instance.

timestamp - Variable in class org.jmacs.IDiDriver.IContext.TimestampContainer

ms since epoch.

timestamp() - Method in interface org.jmacs.pd.IStatusEtc

returns timestamp.

toString() - Method in class org.jmacs.util.Timer.Params

overrides Object.

trigger(String) - Method in interface org.jmacs.pd.IAlert

sets IProgInfo.state() to IProgram.States.ALERT_TRIGGERED, and IProgInfo.errMsg() to msg.

U

UNDEFINED - Static variable in interface org.jmacs.pd.IProgram.States

undefined.

W

WAITING - Static variable in interface org.jmacs.pd.IProgram.States

program is waiting to run.

wake(IDevice.IStatus, IAlert) - Method in interface org.jmacs.pd.IProgram

called after init, whenever timer.sleep() returns (where timer is one of the arguments passed to init).

A C D E G H I N O P R S T U W