A B 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 - Interface in org.jmacs.pd

passed to IProgram.wake(Alert).

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

alert triggered.

B

BLOCKED - Static variable in interface org.jmacs.IDi.States

the specified DI name was already in use.

C

checkDiName(String) - Static method in class org.jmacs.IDi.Util

for use by IDi.AbstractFactory impl'n.

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

returns fully-qualified name of program class.

ClientDiException - Exception in org.jmacs

thrown by IDi.IDriver context methods.

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.

CmdException - Exception in org.jmacs

as thrown by (IDi.IDriver.IControl.IContext.executeCmd(String, Serializable)).

CmdExecutionException - Exception in org.jmacs

wraps any exception, apart from CmdNotRecognisedException, thrown by IDi.IDriver.executeCmd(Serializable, boolean, String) impl'ns.

CmdExecutionException(Exception) - Constructor for exception org.jmacs.CmdExecutionException

creates new instance.

CmdNotRecognisedException - Exception in org.jmacs

as may be thrown when impl'ting IDi.IDriver.executeCmd(Serializable, boolean, String).

CmdNotRecognisedException(Object) - Constructor for exception org.jmacs.CmdNotRecognisedException

creates new instance.

CmdUsageException - Exception in org.jmacs

as may be thrown when impl'ting IDi.IDriver.executeCmd(Serializable, boolean, String).

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

creates new instance.

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

returns codebase used to load program class.

Constants - Interface in org.jmacs.pd

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

Context - Interface in org.jmacs.pd

context.

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

creates any nested controls gui, given that required classloader is available as the context classloader.

createDi(String, Class, String, String, Serializable) - Method in class org.jmacs.IDi.AbstractFactory

creates DI.

createDi(String, IDi.IDriver, String, String, Serializable) - Method in class org.jmacs.IDi.AbstractFactory

as above, but supplying the driver instance (rather than class).

createDi(String, IDi.IDriver, Object, String, String, Serializable) - Method in class org.jmacs.IDi.AbstractFactory

as above, but supplying a separate lock object.

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

creates any nested 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.Device.Proxy

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

D

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

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

Device - Class in org.jmacs.pd

programmable device.

Device.IConstants - Interface in org.jmacs.pd

constants.

Device.IDriver - Interface in org.jmacs.pd

driver.

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

driver container.

Device.IStatus - Interface in org.jmacs.pd

status.

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

produces status.

Device.Proxy - Class in org.jmacs.pd

to be extended by the class ~.mydevice.MyDevice, as part of a programmable-device definition.

Device.Proxy(IDi.IDriver.IClient.IContext, String) - Constructor for class org.jmacs.pd.Device.Proxy

creates new instance.

Device.Proxy(IDi.IDriver.IClient.IContext) - Constructor for class org.jmacs.pd.Device.Proxy

creates new instance.

DiNameTakenException - Exception in org.jmacs

thrown by IDi.register() if the name is already taken by another DI

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

creates new instance.

E

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

the program completed normally.

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

overrides Object.

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

returns the error message if an exception was thrown.

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

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

execute(IPdCmd.Context) - Method in interface org.jmacs.pd.IPdCmd

called when the command is executed.

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

executes cmd.

executeCmd(String, Serializable) - Method in interface org.jmacs.IDi.IDriver.IControl.IContext

attempts to have diName execute cmd.

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

executes cmd.

G

getAutoReregister() - Method in interface org.jmacs.IDi

returns this property.

getAutoReregister() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

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.

getConstants(String) - Method in interface org.jmacs.IDi.IDriver.IContext

as passed to the methods of IDi.AbstractFactory.

getConstants() - Method in interface org.jmacs.pd.Context

returns constants, as passed to the Pdi constructor.

getConstants() - Method in class org.jmacs.pd.Device.Proxy

returns constants.

getDefProgCodebase() - Method in interface org.jmacs.pd.Constants

returns default program-codebase URL.

getDevicePkgname() - Method in interface org.jmacs.pd.Constants

returns package name.

getDriver() - Method in interface org.jmacs.pd.Context

returns driver.

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

returns driver.

getInstance() - Static method in class org.jmacs.IDi.AbstractFactory

returns global instance of class specified by the org.jmacs.IDi.AbstractFactory property--default value, com.lafros.jmacs.impln.di.Di$Factory.

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

returns this property.

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

in case sleep not called.

getObservable() - Method in interface org.jmacs.IDi

returns observable.

getObservable() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

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 class org.jmacs.pd.Device.Proxy

returns program info as of the last sampling boundary.

getProgInfo() - Method in interface org.jmacs.pd.IInterpreter.Context

returns program info as of the last sampling boundary.

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

returns reference boundary/ms.

getState() - Method in interface org.jmacs.IDi

returns one of the fields of IDi.States.

getState() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

getStatus() - Method in interface org.jmacs.IDi.IDriver

samples the device's status at regular intervals.

getStatus(String) - Method in interface org.jmacs.IDi.IDriver.ISampler.IContext

attempts to get status of diName.

getStatus(String, long[]) - Method in interface org.jmacs.IDi.IDriver.ISampler.IContext

as above but also returns timestamp.

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

returns status as of the last sampling boundary.

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

returns current status.

getStatus() - Method in class org.jmacs.pd.Device.Proxy

returns device status as of the last sampling boundary.

getStatus(long[]) - Method in class org.jmacs.pd.Device.Proxy

as above, but also returns timestamp.

getStatus_ProgInfo() - Method in class org.jmacs.pd.Device.Proxy

returns device status and program info as of the last sampling boundary.

getStatus_ProgInfo(long[]) - Method in class org.jmacs.pd.Device.Proxy

as above, but also returns timestamp.

getTimer() - Method in interface org.jmacs.pd.IProgram.Context

returns timer.

H

handleException(Exception) - Method in interface org.jmacs.IExceptionHandler

called if the submitted command could not return a result.

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

called when result becomes available.

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

overrides Object.

I

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.

IDi - Interface in org.jmacs

device interface (DI).

IDi.AbstractFactory - Class in org.jmacs

for creating IDi instances.

IDi.AbstractFactory() - Constructor for class org.jmacs.IDi.AbstractFactory

creates new instance (when invoked by JMaCS implementation subclass).

IDi.IDriver - Interface in org.jmacs

device-interface (DI) driver.

IDi.IDriver.IClient - Interface in org.jmacs

wishes to be able to do all of the things which an IDi.IDriver.ISampler, IDi.IDriver.ISubscriber and IDi.IDriver.IControl can do.

IDi.IDriver.IClient.IContext - Interface in org.jmacs

as passed to IDi.IDriver.IClients.

IDi.IDriver.IContext - Interface in org.jmacs

driver context.

IDi.IDriver.IControl - Interface in org.jmacs

wishes to be able to send commands to other DIs.

IDi.IDriver.IControl.IContext - Interface in org.jmacs

as passed to IDi.IDriver.IControls.

IDi.IDriver.ISampler - Interface in org.jmacs

wishes to be able to request the status of another DI.

IDi.IDriver.ISampler.IContext - Interface in org.jmacs

as passed to IDi.IDriver.ISamplers.

IDi.IDriver.ISubscriber - Interface in org.jmacs

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

IDi.IDriver.ISubscriber.IContext - Interface in org.jmacs

as passed to IDi.IDriver.ISubscriber.

IDi.States - Interface in org.jmacs

of the IDi.

IDi.Util - Class in org.jmacs

utility class.

IExceptionHandler - Interface in org.jmacs

exception handler.

IInterpreter - Interface in org.jmacs.pd

command interpreter.

IInterpreter.Context - Interface in org.jmacs.pd

context, as passed to IInterpreter.interpretCmd(Serializable, Context, boolean).

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(IProgram.Context) - Method in interface org.jmacs.pd.IProgram

called once, first, when the program is run.

interpretCmd(Serializable, IInterpreter.Context, 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.

IPdCmd.Context - Interface in org.jmacs.pd

context, as passed to IPdCmd.execute(Context).

IProgram - Interface in org.jmacs.pd

to be implemented by all programs.

IProgram.Context - Interface in org.jmacs.pd

context, as passed to IProgram.init(Context).

IProgram.States - Interface in org.jmacs.pd

program states.

IResultHandler - Interface in org.jmacs

result handler.

ISamplingDependent - Interface in org.jmacs

for implementation by IDi.IDrivers dependent on status-sampling parameters.

N

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

human readable.

NoSuchServerDiException - Exception in org.jmacs

thrown by IDi.IDriver context methods if the intended server-DI isn't currently registered.

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

creates new instance.

NotRegisteredException - Exception in org.jmacs

thrown by IDi.IDriver context methods if the DI is not registered with a target.

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

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

Pdi - Class in org.jmacs.pd

IDi for the deployment of programmable devices.

Pdi(String, String, Class, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

creates new instance.

Pdi(String, String, Device.IDriver, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

as above, but supplying the driver instance (rather than class).

Pdi(String, String, Device.IDriver.IContainer, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

as above, but supplying a driver-container instance (rather than driver instance).

Pdi(String, Class, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

for use where clazz is provided by the device package itself.

Pdi(String, Device.IDriver, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

for use where the driver class is provided by the device package itself.

Pdi(String, Device.IDriver.IContainer, Device.IConstants) - Constructor for class org.jmacs.pd.Pdi

for use where the driverContainer class is provided by the device package itself.

ProgInfo - Interface in org.jmacs.pd

information about any IProgram a Device is running or has run.

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

returns program info.

R

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

refreshes the values displayed.

register() - Method in interface org.jmacs.IDi

registers with the target.

register() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

REGISTERED - Static variable in interface org.jmacs.IDi.States

registered with a JMACS server.

registerLater() - Method in interface org.jmacs.IDi

as IDi.register(), but guaranteed to return, immediately.

registerLater() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

registerOrWait() - Method in interface org.jmacs.IDi

as IDi.register(), but enters a sleep-retry loop if the target is unavailable (rather than throwing an exception).

registerOrWait() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

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

identifies the particular run.

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

program is running.

S

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

called once, first.

setAutoReregister(boolean) - Method in interface org.jmacs.IDi

sets automatic re-registration (in case the target should become unavailable for any reason).

setAutoReregister(boolean) - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

setContext(IDi.IDriver.IClient.IContext) - Method in interface org.jmacs.IDi.IDriver.IClient

sets context.

setContext(IDi.IDriver.IControl.IContext) - Method in interface org.jmacs.IDi.IDriver.IControl

sets context.

setContext(IDi.IDriver.ISampler.IContext) - Method in interface org.jmacs.IDi.IDriver.ISampler

sets context.

setContext(IDi.IDriver.ISubscriber.IContext) - Method in interface org.jmacs.IDi.IDriver.ISubscriber

sets context.

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

called once, first.

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

where (current time + lagMillis) is used in place of the value obtained from the system clock.

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.

setSamplesInPort(int) - Method in interface org.jmacs.IDi

sets a designated local port to which the socket that will be created to receive subscription status samples must bind.

setSamplesInPort(int) - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

setSamplesOutPort(int) - Method in interface org.jmacs.IDi

sets a designated local port to which the socket that will be created to send status samples must bind.

setSamplesOutPort(int) - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

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 class org.jmacs.pd.Device.Proxy

starts the specified program.

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

starts the specified program.

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.ProgInfo

returns the time at which the program was started.

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

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

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

returns device status.

Status_ProgInfo - Class in org.jmacs.pd

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

STOP_PROGRAM - Static variable in class org.jmacs.pd.Device

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 class org.jmacs.pd.Device.Proxy

IProgram.terminate()s the currently running program.

stopProgram() - Method in interface org.jmacs.pd.IInterpreter.Context

IProgram.terminate()s the currently running program.

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

submits cmd.

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, int) - Method in interface org.jmacs.IMonitorGui.IContext

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

subscribe(String, boolean) - Method in interface org.jmacs.IDi.IDriver.ISubscriber.IContext

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

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

causes the status to be obtained automatically.

T

TargetUnavailableException - Exception in org.jmacs

thrown by IDi.register() if target unavailable.

TargetUnavailableException(String, String) - Constructor for exception org.jmacs.TargetUnavailableException

creates new instance.

terminate() - 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.

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

overrides Object.

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

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

U

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

undefined.

unregister() - Method in interface org.jmacs.IDi

return the instance to the IDi.States.UNREGISTERED state.

unregister() - Method in class org.jmacs.pd.Pdi

impl'ts IDi.

UNREGISTERED - Static variable in interface org.jmacs.IDi.States

not registered with any JMACS server.

W

WAITING - Static variable in interface org.jmacs.IDi.States

waiting for the specified JMACS server to become available.

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

program is waiting to run.

wake(Alert) - Method in interface org.jmacs.pd.IProgram

called after IProgram.init(Context), whenever IProgram.Context.getTimer().sleep() returns.

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