org.lsst.ccs.monitor

Class MonitorUpdateTask

java.lang.Object

org.lsst.ccs.monitor.MonitorUpdateTask

public class MonitorUpdateTask
extends Object

A Monitoring Task to update a set of channels.

Author:

The LSST CCS Team

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUBLICATION_KEY

Method Summary

Modifier and Type	Method and Description
void	forceDataPublicationForDuration(Duration duration) Force data publication over the specified duration.
void	forceDataPublicationOnNextUpdates(int nUpdates) Force data publication for the next N times the periodic thread triggers the monitor updates.
List<Channel>	getAllChannels()
Set<String>	getAllGroups()
List<Channel>	getChannelsForDeviceGroup(Device device, String group)
Set<Device>	getDevices()
Set<String>	getGroupsForDevice(Device device)
String	getName()
void	monitorPublish() Invoked by the publish thread to schedule a publication in the next periodic update cycle.
void	monitorUpdate() This method is called by the periodic thread to trigger an update of the Channels in this task.
Future<Void>	pausePeriodicUpdate() Pause the updating of the Channels on the periodic update thread.
void	resetForcedDataPublication() Reset the forced data publication.
void	resumePeriodicUpdate() Resume the reading of the Channels on the periodic update thread.
Future<Void>	scheduleUpdateAndPublishNow() Invoke a monitor update cycle now along with the publication of all its data.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PUBLICATION_KEY

public static final String PUBLICATION_KEY

See Also:

Constant Field Values

Method Detail

monitorPublish

public void monitorPublish()

Invoked by the publish thread to schedule a publication in the next periodic update cycle.

forceDataPublicationOnNextUpdates

public void forceDataPublicationOnNextUpdates(int nUpdates)

Force data publication for the next N times the periodic thread triggers the monitor updates.

Parameters:

nUpdates -

forceDataPublicationForDuration

public void forceDataPublicationForDuration(Duration duration)

Force data publication over the specified duration.

Parameters:

duration - The Duration over which we force data publication.

resetForcedDataPublication

public void resetForcedDataPublication()

Reset the forced data publication.

scheduleUpdateAndPublishNow

public Future<Void> scheduleUpdateAndPublishNow()

Invoke a monitor update cycle now along with the publication of all its data. This invocation happens via the AgentExecutionService.

monitorUpdate

public void monitorUpdate()

This method is called by the periodic thread to trigger an update of the Channels in this task.

pausePeriodicUpdate

public Future<Void> pausePeriodicUpdate()

Pause the updating of the Channels on the periodic update thread. Trending publication is also paused.

Returns:

resumePeriodicUpdate

public void resumePeriodicUpdate()

Resume the reading of the Channels on the periodic update thread. Trending publication will resume when triggered by the publishing thread.

getName

public String getName()

getDevices

public Set<Device> getDevices()

getGroupsForDevice

public Set<String> getGroupsForDevice(Device device)

getChannelsForDeviceGroup

public List<Channel> getChannelsForDeviceGroup(Device device,
                                               String group)

getAllChannels

public List<Channel> getAllChannels()

getAllGroups

public Set<String> getAllGroups()

toString

public String toString()

Overrides:

toString in class Object