org.lsst.ccs.subsystem.doorman.main

Class DummyInstrument

java.lang.Object

org.lsst.ccs.subsystem.doorman.main.DummyInstrument

All Implemented Interfaces:

Instrument

public class DummyInstrument
extends Object
implements Instrument

A dummy instrument used to test the subsystem. Produces a trendable cosine wave of unit amplitude on the room temperature channel. Every fifth simulated operation fails. Read operations take ten seconds unless interrupted or unless they experience a simulated exception.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
DummyInstrument(InstrumentConfig config)

Method Summary

Modifier and Type	Method and Description
Instrument	disable() Produces a new instance that has readout disabled.
Instrument	enable() Produces a new instance that has been enabled for readout.
int	getExceptionCount() Gets the number of consecutive operations that were terminated by an exception.
int	getIndex() Gets the position of this instrument in the list of instruments.
Optional<org.lsst.ccs.HardwareException>	getLastException() Gets the exception thrown (if any) the last time we tried to operate on this instrument.
InstrumentStatus	getStatus() Gets the current status of the instrument.
Stream<TrendableRecord>	getTrendables() Gets all the trendable data resulting from the last reading of the instrument.
Instrument	read() Produces a new instance that contains a fresh set of data read from the instrument.

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyInstrument

public DummyInstrument(InstrumentConfig config)

Method Detail

getLastException

public Optional<org.lsst.ccs.HardwareException> getLastException()

Gets the exception thrown (if any) the last time we tried to operate on this instrument.

Specified by:

getLastException in interface Instrument

Returns:

An empty Optional if there have been no operations or if the last operation was successful. Otherwise an Optional containing the exception that terminated the operation. Getters are not considered operations.

getExceptionCount

public int getExceptionCount()

Gets the number of consecutive operations that were terminated by an exception.

Specified by:

getExceptionCount in interface Instrument

Returns:

The consecutive exception count, which is zero if no exception occurred on the last operation.

getIndex

public int getIndex()

Gets the position of this instrument in the list of instruments.

Specified by:

getIndex in interface Instrument

Returns:

The index.

See Also:

LocalConfigurationService.getInstrumentConfigs()

getStatus

public InstrumentStatus 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.

Specified by:

getStatus in interface Instrument

Returns:

The status object.

getTrendables

public Stream<TrendableRecord> getTrendables()

Gets all the trendable data resulting from the last reading of the instrument.

Specified by:

getTrendables in interface Instrument

Returns:

A stream of TrendableRecord instances, empty if no data is available. The master key of each record is the location for which the data were taken. The master timestamp is the time at which the record was made. Each key/value pair consists of a channel name and value.

See Also:

Instrument.read()

disable

public Instrument disable()

Produces a new instance that has readout disabled.

Specified by:

disable in interface Instrument

Returns:

The new instance.

enable

public Instrument enable()

Produces a new instance that has been enabled for readout.

Specified by:

enable in interface Instrument

Returns:

The new instance.

read

public Instrument read()

Produces a new instance that contains a fresh set of data read from the instrument. The Instrument.getTrendables() method relies on this data to produce its result.

Specified by:

read in interface Instrument

Returns:

The new instance.