Index (LSST CCS - Airwatch Subsystem (Main) 1.0.2 API)

A C D E G H I L M N O P R S T U V

A

AirwatchMain - Class in org.lsst.ccs.subsystem.airwatch.main: The main module for the Airwatch subsystem.
AirwatchMain(String) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Constructor.

C

CCSConfiguration - Class in org.lsst.ccs.subsystem.airwatch.main: Implements a configuration service based on the CCS subsystem configuration API.
CCSConfiguration() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Makes an instance.
ChannelLimitAlert - Class in org.lsst.ccs.subsystem.airwatch.main: Raised when some channel value on the instrument is out of bounds.
ChannelLimitAlert() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.ChannelLimitAlert: Sets the alert ID and description.
checkHardware() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Attempts to start all configured instruments.
checkStarted() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Checks whether all the instruments are running.
checkStopped() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Checks whether future readouts have been canceled.
ConfigurationService - Interface in org.lsst.ccs.subsystem.airwatch.main: Represents a repository of configuration information.
conn - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The information needed to open a connection to an instrument.

D

disable(String) - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Prevents an instrument from being read until further notice.
disable() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Produces a new instance that has readout disabled.
disable() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Produces a new instance that has readout disabled.
disable() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Produces a new instance that has readout disabled.
DummyInstrument - Class in org.lsst.ccs.subsystem.airwatch.main: A dummy instrument used to test the subsystem.
DummyInstrument(InstrumentConfig) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument

E

EmailDeliveryAlert - Class in org.lsst.ccs.subsystem.airwatch.main: Raised when an email message couldn't be constructed or delivered.
EmailDeliveryAlert() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.EmailDeliveryAlert: Sets the alert ID and description.
enable(String, String) - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Sets a new location for an instrument then enables periodic readout for it.
enable(LocationConfig) - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Produces a new instance that has been enabled for readout and is serving a new location.
enable(LocationConfig) - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Produces a new instance that has been enabled for readout and is serving a new location.
enable(LocationConfig) - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Produces a new instance that has been enabled for readout and is serving a new location.
enabled - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus

G

getConfigName() - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Gets the instrument type name as it should appear in configuration data.
getEmailBounceAddress() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Get the value of the "bounce-to" and "reply-to" fields for alarm emails.
getEmailBounceAddress() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Get the value of the "bounce-to" and "reply-to" fields for alarm emails.
getEmailRecipients() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets the list of recipients of alarm emails.
getEmailRecipients() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets the list of recipients of alarm emails.
getEmailSender() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration
getEmailSender() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets the value of the "From" fields for alarm emails.
getIndex() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Gets the position of this instrument in the list of instruments.
getIndex() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Gets the position of this instrument in the list of instruments.
getIndex() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Gets the position of this instrument in the list of instruments.
getInstrumentConfigs() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets an InstrumentConfig for each instrument described by the configuration data.
getInstrumentConfigs() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets an InstrumentConfig for each instrument described by the configuration data.
getItems() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the map of trending keys to serializable values.
getKey() - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel: Gets the trending key used to identify the channel.
getLastException() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Gets the exception thrown (if any) the last time we tried to operate on this instrument.
getLastException() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Gets the exception thrown (if any) the last time we tried to operate on this instrument.
getLastException() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Gets the exception thrown (if any) the last time we tried to operate on this instrument.
getLocationConfigs() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets a LocationConfig for each location described by the configuration data.
getLocationConfigs() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets a LocationConfig for each location described by the configuration data.
getMasterKey() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the master key given to the constructor.
getMasterTimestamp() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the master timestamp given to the constructor.
getReadoutInterval() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets the time between instrument readouts.
getReadoutInterval() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets the time between instrument readouts.
getSMTPServer() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets the host name or IPv4 address of the SMTP server used to send emails.
getSMTPServer() - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Gets the host name or IPv4 address of the SMTP server used to send emails.
getStatus() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Gets the current status of the instrument.
getStatus() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Gets the current status of the instrument.
getStatus() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Gets the current status of the instrument.
getTrendables() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Gets all the trendable data resulting from the last reading of the instrument.
getTrendables() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Gets all the trendable data resulting from the last reading of the instrument.
getTrendables() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Gets all the trendable data resulting from the last reading of the instrument.

H

hasLimitViolation() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the value of the limit violation flag for this record.
hasMalfunction() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the value of the instrument malfunction flag for this record.

I

index - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The position of the configuration in the list, counting from zero.
index - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus
index - Variable in class org.lsst.ccs.subsystem.airwatch.main.LocationConfig: The zero-based position of the name in the list of legal location names.
initModule() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Checks whether all the subsystem components have been constructed and registers the ClearAlertHandler.
Instrument - Interface in org.lsst.ccs.subsystem.airwatch.main: Represents a particle-counting instrument.
InstrumentChannel - Enum in org.lsst.ccs.subsystem.airwatch.main: The quantities monitored by each instrument.
InstrumentConfig - Class in org.lsst.ccs.subsystem.airwatch.main: The configuration information maintained for each instrument.
InstrumentConfig(int, InstrumentType, String, String, Instant) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig
InstrumentIOAlert - Class in org.lsst.ccs.subsystem.airwatch.main: Raised when some command given to an instrument fails.
InstrumentIOAlert() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentIOAlert: Sets the alert ID and description.
InstrumentMalfunctionAlert - Class in org.lsst.ccs.subsystem.airwatch.main: Raised when the instrument signals a malfunction (bad laser, broken pump, etc.).
InstrumentMalfunctionAlert() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentMalfunctionAlert: Sets the alert ID and description.
InstrumentReport - Class in org.lsst.ccs.subsystem.airwatch.main: A snapshot of the status of all instruments.
InstrumentReport(List<Instrument>) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentReport
instruments() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Gives the status of each of the instruments.
InstrumentStatus - Class in org.lsst.ccs.subsystem.airwatch.main
InstrumentStatus(int, boolean, String, Instant) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus
InstrumentType - Enum in org.lsst.ccs.subsystem.airwatch.main: The different kinds of instruments recognized by the subsystem.
isParticleChannel() - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel: Determines whether a channel is a particle count.

L

lastDataTime - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The next readout of the instrument will fetch only data newer than this time.
lastDataTime - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus
LighthouseInstrument - Class in org.lsst.ccs.subsystem.airwatch.main: Lighthouse Worldwide Solutions 3016-like instrument.
LighthouseInstrument(InstrumentConfig) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Constructs a new instance from configuration data.
LIMIT_VIOLATION_KEY - Static variable in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: The trending key to use for the flag that tells whether some channel in the record is outside the valid range.
loc - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The current location being monitored by the instrument.
location - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus
LocationConfig - Class in org.lsst.ccs.subsystem.airwatch.main: Holds configuration information about a location.
LocationConfig(String, int, Map<InstrumentChannel, Long>) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.LocationConfig: Constructs an instance.

M

make(InstrumentConfig) - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Makes the right kind of Instrument objects using InstrumentConfigs.
MALFUNCTION_KEY - Static variable in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: The trending key to use for the flag that tells whether the instrument reported a malfunction for this record.

N

name - Variable in class org.lsst.ccs.subsystem.airwatch.main.LocationConfig: The name of the location.

O

org.lsst.ccs.subsystem.airwatch.main - package org.lsst.ccs.subsystem.airwatch.main: The main package for the AirWatch subsystem.

P

parse(String) - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel: Converts a trending key string into the corresponding channel.
parse(String) - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Converts a string to one of the instances of this enum.
post(Subsystem) - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Post this data to the local CCS trending database.
postStart() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Does nothing.

R

read() - Method in class org.lsst.ccs.subsystem.airwatch.main.DummyInstrument: Produces a new instance that contains a fresh set of data read from the instrument.
read() - Method in interface org.lsst.ccs.subsystem.airwatch.main.Instrument: Produces a new instance that contains a fresh set of data read from the instrument.
read() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseInstrument: Produces a new instance that contains a fresh set of data read from the instrument.

S

signal(Signal) - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Signal handler for stop and abort.
start() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Does nothing.
start() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Checks configuration data and makes the configuration objects.
states - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentReport: The status of each instrument.

T

thresholds - Variable in class org.lsst.ccs.subsystem.airwatch.main.LocationConfig: The thresholds to apply to each instrument particle channel.
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.InstrumentReport
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Create a printable representation of this object.
TrendableRecord - Class in org.lsst.ccs.subsystem.airwatch.main: An immutable data record in a form independent of instrument type.
TrendableRecord(String, Instant, Map<String, Serializable>) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Construct an instance.
type - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The make and/or model of the instrument.

U

updateInstrument(InstrumentStatus) - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Updates the information in the configuration database for a particular instrument.
updateInstrument(InstrumentStatus) - Method in interface org.lsst.ccs.subsystem.airwatch.main.ConfigurationService: Updates the information in the configuration database for a particular instrument.

V

valueOf(String) - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I L M N O P R S T U V