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

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

A

absolute - Variable in class org.lsst.ccs.subsystem.airwatch.main.CounterPoint: The absolute number of particles detected in the air sample.
AirwatchMain - Class in org.lsst.ccs.subsystem.airwatch.main: The main module for the Airwatch subsystem.
AirwatchMain() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Constructor.
Alerts - Class in org.lsst.ccs.subsystem.airwatch.main: Contains a set of static factory functions for the alerts used by the subsystem.
Alerts() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.Alerts
alertService - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: Grants access to the CCS alert service.
AnalogPoint - Class in org.lsst.ccs.subsystem.airwatch.main: Contains all the values for one reading of one analog channel such as temperature or humidity.
AnalogPoint(Double, Boolean, Boolean) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.AnalogPoint

C

canClearAlert(Alert, AlertState) - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Handles all alerts by allowing them to be cleared.
CCSConfiguration - Class in org.lsst.ccs.subsystem.airwatch.main: Implements a local configuration service based on the CCS subsystem configuration API.
CCSConfiguration() - Constructor for class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Makes an instance.
checkHardware() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Attempts to start all configured instruments that are operational.
checkStopped() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Cancels periodic readout if this hasn't already been done (part of shutdown).
conn - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The information needed to open a connection to an instrument.
CounterPoint - Class in org.lsst.ccs.subsystem.airwatch.main: Contains all the data for one reading of one particle counter channel.
CounterPoint(Double, Double, Boolean, Boolean) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.CounterPoint

D

density - Variable in class org.lsst.ccs.subsystem.airwatch.main.CounterPoint: The particle density (particles/volume).
DEW_POINT_KEY - Static variable in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain
dewPoint(double, double) - Static method in class org.lsst.ccs.subsystem.airwatch.main.Utility: Calculates the dew point temperature from current conditions.
disable(int) - 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.LighthouseOPC: 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() - Static method in class org.lsst.ccs.subsystem.airwatch.main.Alerts: Creates an alert about a failure to build or deliver an email message.
EmailSender - Class in org.lsst.ccs.subsystem.airwatch.main: Sends email messages using some simple scheduling in order to avoid spamming.
EmailSender(LocalConfigService, AlertService) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.EmailSender
enable(int) - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Enables periodic readout for an instrument.
enable() - 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() - 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() - Method in class org.lsst.ccs.subsystem.airwatch.main.LighthouseOPC: 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

getAlerts() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord
getAlerts() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Returns any alerts that should be raised by this set of readings.
getAlerts() - Method in interface org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Returns any alerts that should be raised by this set of readings.
getConfigName() - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Gets the instrument type name as it should appear in configuration data.
getDewShortNames() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets the list of short names of instruments to be used in the dew point calculation.
getDewShortNames() - Method in interface org.lsst.ccs.subsystem.airwatch.main.LocalConfigService: Gets the list of short names of instruments to be used in the dew point calculation.
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.LocalConfigService: 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.LocalConfigService: Gets the list of recipients of alarm emails.
getEmailSender() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Gets the value of the "From" fields for alarm emails.
getEmailSender() - Method in interface org.lsst.ccs.subsystem.airwatch.main.LocalConfigService: 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.LighthouseOPC: 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.LocalConfigService: Gets an InstrumentConfig for each instrument described by the configuration data.
getItems() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord
getItems() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Gets the map of trending keys to serializable values.
getItems() - Method in interface 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.LighthouseOPC: Gets the exception thrown (if any) the last time we tried to operate on this instrument.
getMasterKey() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord
getMasterKey() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Gets the master key for the record.
getMasterKey() - Method in interface org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the master key for the record.
getMasterTimestamp() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord
getMasterTimestamp() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Gets the master timestamp for the record.
getMasterTimestamp() - Method in interface org.lsst.ccs.subsystem.airwatch.main.TrendableRecord: Gets the master timestamp for the record.
getOPCServerInfo(String) - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration
getOPCServerInfo(String) - Method in interface org.lsst.ccs.subsystem.airwatch.main.LocalConfigService: Gets the list of information needed to contact a Lighthouse OPC server.
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.LocalConfigService: 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.LocalConfigService: 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.LighthouseOPC: 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.LighthouseOPC: Gets all the trendable data resulting from the last reading of the instrument.

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
init() - Method in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain: Checks whether all the subsystem components have been constructed.
init() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration
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 that may be 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, String, boolean, LocalConfigService, AlertService) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig
instrumentIOAlert(String) - Static method in class org.lsst.ccs.subsystem.airwatch.main.Alerts: Creates an alert about a failure to read an instrument.
instrumentMalfunctionAlert(String, String) - Static method in class org.lsst.ccs.subsystem.airwatch.main.Alerts: Creates an alert about a sensor malfunction reported by the instrument.
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, 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.InstrumentStatus
LighthouseOPC - Class in org.lsst.ccs.subsystem.airwatch.main: Represents an instrument connected to PC running Lighthouse's LMS Express RT program.
LighthouseOPC(InstrumentConfig) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.LighthouseOPC: Constructs a new instance from configuration data.
limitViolation - Variable in class org.lsst.ccs.subsystem.airwatch.main.AnalogPoint: Non-zero if the sensor value is outside the bounds set for the channel.
limitViolation - Variable in class org.lsst.ccs.subsystem.airwatch.main.CounterPoint: Non-zero if the density was over the limit set for the channel.
limitViolationAlert(String, String) - Static method in class org.lsst.ccs.subsystem.airwatch.main.Alerts: Creates an alert about an a sensor reading that's outside of the desired range.
loc - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The current location being monitored by the instrument.
localConfig - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: Grants access to the configuration info that doesn't fit the general pattern.
LocalConfigService - Interface in org.lsst.ccs.subsystem.airwatch.main: Represents a repository of configuration information.
location - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus

M

make(InstrumentConfig) - Method in enum org.lsst.ccs.subsystem.airwatch.main.InstrumentType: Makes the right kind of Instrument objects using InstrumentConfigs.
makeConfigurationObjects() - Method in class org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration: Checks configuration and persistent data and makes the configuration objects.
makeConfigurationObjects() - Method in interface org.lsst.ccs.subsystem.airwatch.main.LocalConfigService: Read the external configuration info, from whatever source, and use it to create the InstrumentConfig and LocationConfig objects.
malfunction - Variable in class org.lsst.ccs.subsystem.airwatch.main.AnalogPoint: Non-zero if there was a malfunction during measurement.
malfunction - Variable in class org.lsst.ccs.subsystem.airwatch.main.CounterPoint: Non-zero if the channel experienced a malfunction during measurement.

N

N_DEW_HUMIDS_KEY - Static variable in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain
N_DEW_TEMPS_KEY - Static variable in class org.lsst.ccs.subsystem.airwatch.main.AirwatchMain

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.TrendableDummyRecord
post(Subsystem) - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Post this data to the local CCS trending database.
post(Subsystem) - Method in interface 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.LighthouseOPC: Produces a new instance that contains a fresh set of data read from the instrument.

S

send(String, Throwable) - Method in class org.lsst.ccs.subsystem.airwatch.main.EmailSender
shortName - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The "short name" assigned to the instrument location.
shortName - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentStatus
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: Creates the email sender.
states - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentReport: The status of each instrument.

T

toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.AnalogPoint
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.CounterPoint
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.InstrumentReport
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord: Create a printable representation of this object.
toString() - Method in class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Create a printable representation of this object.
TrendableDummyRecord - Class in org.lsst.ccs.subsystem.airwatch.main: The trendable record for dummy instruments.
TrendableDummyRecord(String, Instant, Map<String, Serializable>) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.TrendableDummyRecord
TrendableOPCRecord - Class in org.lsst.ccs.subsystem.airwatch.main: A trendable record for Lighthouse OPC instruments.
TrendableOPCRecord(String, Instant, Map<String, Serializable>) - Constructor for class org.lsst.ccs.subsystem.airwatch.main.TrendableOPCRecord: Construct an instance.
TrendableRecord - Interface in org.lsst.ccs.subsystem.airwatch.main: Defines the interface to trendable data from an instrument.
type - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: The make and/or model of the instrument.

U

Utility - Class in org.lsst.ccs.subsystem.airwatch.main: Static functions other things without their own classes.

V

value - Variable in class org.lsst.ccs.subsystem.airwatch.main.AnalogPoint: The value read from the channel.
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.

W

working - Variable in class org.lsst.ccs.subsystem.airwatch.main.InstrumentConfig: Is the instrument present and operational?

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