org.lsst.ccs.subsystem.airwatch.main

Class TrendableModbusRecord

java.lang.Object

org.lsst.ccs.subsystem.airwatch.main.TrendableModbusRecord

All Implemented Interfaces:

TrendableRecord

public final class TrendableModbusRecord
extends Object
implements TrendableRecord

Describes an immutable data record matching a record gotten from a directly-connected Lighthouse instrument. Such a record has a single timestamp, a single location key, a single limit violation flag, a single malfunction flag and a set of channel-value pairs.

Author:

tether

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIMIT_VIOLATION_KEY The trending key to use for the flag that tells whether some channel in the record is outside the valid range.
static String	MALFUNCTION_KEY The trending key to use for the flag that tells whether the instrument reported a malfunction for this record.

Constructor Summary

Constructors

Constructor and Description
TrendableModbusRecord(String masterKey, Instant masterTimestamp, Map<String,Serializable> items) Construct an instance.

Method Summary

Modifier and Type	Method and Description
Map<String,Serializable>	getItems() Gets the map of trending keys to serializable values.
String	getMasterKey() Gets the master key for the record.
Instant	getMasterTimestamp() Gets the master timestamp for the record.
boolean	hasLimitViolation() Gets the value of the limit violation flag for this record.
boolean	hasMalfunction() Gets the value of the instrument malfunction flag for this record.
void	post(org.lsst.ccs.Subsystem subsys) Post this data to the local CCS trending database.
String	toString() Create a printable representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

LIMIT_VIOLATION_KEY

public static String LIMIT_VIOLATION_KEY

The trending key to use for the flag that tells whether some channel in the record is outside the valid range.

MALFUNCTION_KEY

public static String MALFUNCTION_KEY

The trending key to use for the flag that tells whether the instrument reported a malfunction for this record.

Constructor Detail

TrendableModbusRecord

public TrendableModbusRecord(String masterKey,
                             Instant masterTimestamp,
                             Map<String,Serializable> items)

Construct an instance.

Parameters:

masterKey - Will become the master key.

masterTimestamp - Will the common timestamp.

items - A Map from value key to serializable value.

Method Detail

getMasterKey

public String getMasterKey()

Gets the master key for the record.

Specified by:

getMasterKey in interface TrendableRecord

Returns:

The key.

getMasterTimestamp

public Instant getMasterTimestamp()

Gets the master timestamp for the record.

Specified by:

getMasterTimestamp in interface TrendableRecord

Returns:

The timestamp.

hasLimitViolation

public boolean hasLimitViolation()

Gets the value of the limit violation flag for this record.

Specified by:

hasLimitViolation in interface TrendableRecord

Returns:

The flag, or false if the flag isn't present.

hasMalfunction

public boolean hasMalfunction()

Gets the value of the instrument malfunction flag for this record.

Specified by:

hasMalfunction in interface TrendableRecord

Returns:

The flag, or false if the flag isn't present.

getItems

public Map<String,Serializable> getItems()

Gets the map of trending keys to serializable values.

Specified by:

getItems in interface TrendableRecord

Returns:

The map (unmodifiable).

post

public void post(org.lsst.ccs.Subsystem subsys)

Post this data to the local CCS trending database. The master key and timestamp become the key and timestamp of a KeyValueDataList to which is added one item for each data channel.

Specified by:

post in interface TrendableRecord

Parameters:

subsys - A reference to the CCS subsystem object.

toString

public String toString()

Create a printable representation of this object.

Overrides:

toString in class Object

Returns:

A number of lines, each terminated with a newline, like so: Master key: foo Master time: 2016-05-28T22:50:06.000Z key1: value1 key2: value2 ...