org.lsst.ccs.subsystem.airwatch.main

Interface Location

All Known Implementing Classes:

DummyLocation, RestfulLocation

public interface Location

Represents a location containing some sensors. For ease of sharing between threads, objects implementing this interface must be immutable. In place of mutators there are methods that produce new instances with altered states.

Author:

tether

Method Summary

Modifier and Type	Method and Description
void	checkData(org.lsst.ccs.services.alert.AlertService alertSvc) Checks sensor data for problems and posts any required alerts (if alerts are enabled).
Location	disable() Produces a new instance that has data-checking alerts disabled.
Location	enable() Produces a new instance that has data-checking alerts enabled.
Map<String,DataPoint>	getDataPoints() Contains the data points resulting from the last reading of the instrument.
LocationStatus	getStatus() Gets the current status of the instrument.
void	publishGoodData(org.lsst.ccs.Subsystem subsys) Publish good data on the CCS status bus.

Method Detail

getDataPoints

Map<String,DataPoint> getDataPoints()

Contains the data points resulting from the last reading of the instrument.

Returns:

A read-only map of data points keyed by channel name.

getStatus

LocationStatus getStatus()

Gets the current status of the instrument. This method will be used in QUERY-type commands, so implementations must rely solely on data in memory and must not perform any hardware operations.

Returns:

The status object.

disable

Location disable()

Produces a new instance that has data-checking alerts disabled.

Returns:

The new instance.

enable

Location enable()

Produces a new instance that has data-checking alerts enabled.

Returns:

The new instance.

checkData

void checkData(org.lsst.ccs.services.alert.AlertService alertSvc)

Checks sensor data for problems and posts any required alerts (if alerts are enabled).

Parameters:

alertSvc - the CCS alert service.

publishGoodData

void publishGoodData(org.lsst.ccs.Subsystem subsys)

Publish good data on the CCS status bus. Good data have quality values of "Good" and have no sensor malfunction reported.

Parameters:

subsys - the CCS subsystem.