org.mbari.siam.core
Interface ScheduleOwner

All Known Implementing Classes:

AanderaaO2, ActiVideoServer, AggregateInstrumentService, AnalogInstrument, Aquadopp, Aquadopp, Averager, AxisCamera, BaseInstrumentService, CO2SubsystemMonitor, CompassKVHC100, ControlLoopService, CPUTempService, DataLogger, DigitalInputService, DigiWorkhorseADCP, DummyInstrument, DummySummarizer, ElmoLouver, ElmoService, ElmoThruster, Environmental, ESWPump, GarminGPS, GashoundSubsystem, HeaveSensor, HydroRad, InstrumentService, ISUS2, M3dmGx1, McLaneProfiler, mdTest, Medusa, Metsys, MotorControl, MSP430, NobskaMAVS, Ocr3000, PhDigital, PolledInstrumentService, PowerCan, PowerSwitch, Pump, PumpedSeabird, PumpUser, SAMI, SatlanticISUS, SBE16plus, SBE18, SBE19plus, SBE37, SBE52MP, ScaledAnalog, ScheduledISUS, Seabird, SeaBird37im, Seahorse, Sensoray518, SerialAdc, Shmoo, ShmooInstrumentService, SimulatedVector, SimulatedVector, SineDummyInstrument, SmartStar, SOON, StreamingInstrumentService, StreamingSBE19, SummarizerBlock, TerminalInstrumentService, TestScheduleOwner, ValveService, VarDummyInstrument, Vector, Vector, WaveSensor, WetLabsECO, WetLabsTriplet, WhoiAsimet, WorkhorseADCP, Ysi

public interface ScheduleOwner

Interface for objects that own scheduled tasks

Author:

Kent Headley

See Also:

ScheduleTask

Method Summary

int	addSchedule(java.lang.String name, java.lang.String specifier, boolean overwrite) Add or replace schedule.
void	doScheduledTask(ScheduleTask task) Default method to execute
java.util.Collection	getAllSchedules() Return schedules
Scheduler.ScheduleKey	getScheduleKey() Return schedule key (unique schedule owner ID)
int	removeAllSchedules() Remove all schedules.
int	removeSchedule(java.lang.String name) Remove specified schedule.
int	resumeSchedule(java.lang.String name) Resume specified schedule.
long	sleepingUntil(ScheduleTask task) If execution thread of specified task is sleeping, return time at which it will resume; otherwise return 0.
int	suspendSchedule(java.lang.String name) Suspend specified schedule.Return integer code defined by Scheduler.
int	syncSchedule(java.lang.String name, long delay) "Synchronize" specified schedule.

Method Detail

getScheduleKey

Scheduler.ScheduleKey getScheduleKey()

Return schedule key (unique schedule owner ID)

getAllSchedules

java.util.Collection getAllSchedules()

Return schedules

doScheduledTask

void doScheduledTask(ScheduleTask task)

Default method to execute

addSchedule

int addSchedule(java.lang.String name,
                java.lang.String specifier,
                boolean overwrite)

Add or replace schedule. Return integer code defined by Scheduler.

removeSchedule

int removeSchedule(java.lang.String name)

Remove specified schedule. Return integer code defined by Scheduler.

removeAllSchedules

int removeAllSchedules()

Remove all schedules. Return integer code defined by Scheduler.

syncSchedule

int syncSchedule(java.lang.String name,
                 long delay)

"Synchronize" specified schedule. Return integer code defined by Scheduler.

suspendSchedule

int suspendSchedule(java.lang.String name)

Suspend specified schedule.Return integer code defined by Scheduler.

resumeSchedule

int resumeSchedule(java.lang.String name)

Resume specified schedule. Return integer code defined by Scheduler.

sleepingUntil

long sleepingUntil(ScheduleTask task)

If execution thread of specified task is sleeping, return time at which it will resume; otherwise return 0.