org.lsst.ccs.drivers.lighthouse

Class Client

java.lang.Object

org.lsst.ccs.drivers.lighthouse.Client

public final class Client
extends Object

Encapsulates requests made of Lighthouse particle counter. Only operations and data are visible, not registers or communication protocols. Implements a command set common to the 2016, 3016 and 5016 family of hand-held and wall-mounted units.

Only a single thread should manipulate the instrument using this class. Only a single stream of data records should be in use at any time since advancing to the next record involves updating the record index register on the instrument before reading the record data registers. This lazy retrieval allows you to skip needless I/O if you decide you don't want all the stored records.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
Client(Hardware hw) Stores a reference to a Hardware object used to communicate with the instrument and reads the device model and the register map version.

Method Summary

Modifier and Type	Method and Description
void	clearRecords() Delete all records currently stored in the instrument.
String	getModel() Gets the model of Lighthouse counter hardware (read by constructor).
java.util.stream.Stream<DataRecord>	getRecords() Gets all the data records currently stored in the instrument's memory.
int	getRegisterMapVersion() Gets the version of the Modbus register map used by the hardware (read by constructor).
void	startRecording() Starts automatic data collection.
void	stopRecording() Stops data collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(Hardware hw)
       throws org.lsst.ccs.drivers.commons.DriverException

Stores a reference to a Hardware object used to communicate with the instrument and reads the device model and the register map version.

Parameters:

hw - The communications object.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

Method Detail

getModel

public String getModel()

Gets the model of Lighthouse counter hardware (read by constructor).

Returns:

The model designation string.

getRegisterMapVersion

public int getRegisterMapVersion()

Gets the version of the Modbus register map used by the hardware (read by constructor).

Returns:

An integer with decimal digits xxyy, where xx is the major version and yy the minor version.

stopRecording

public void stopRecording()
                   throws org.lsst.ccs.drivers.commons.DriverException

Stops data collection. Aborts any new record being created. Has no effect if data collection has already been stopped.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

startRecording

public void startRecording()
                    throws org.lsst.ccs.drivers.commons.DriverException

Starts automatic data collection. Has no effect if data collection is already started.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

getRecords

public java.util.stream.Stream<DataRecord> getRecords()
                                               throws org.lsst.ccs.drivers.commons.DriverException

Gets all the data records currently stored in the instrument's memory.

Returns:

The records in ascending order by record index.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise or if data collection hasn't been stopped.

clearRecords

public void clearRecords()
                  throws org.lsst.ccs.drivers.commons.DriverException

Delete all records currently stored in the instrument.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise or if data collection hasn't been stopped.