org.lsst.ccs.drivers.opc

Class OPCItem

java.lang.Object

org.lsst.ccs.drivers.opc.OPCItem

public class OPCItem
extends Object

Contains one data item read from the OPC DA server; the actual value plus metadata.

Author:

tether

Method Summary

Modifier and Type	Method and Description
String	getModifier() Gets a string containing more detailed information about the item's quality.
Quality	getQuality() Gets the basic quality of the item.
String	getTag() Gets the name of the item on the server.
Instant	getTimestamp() Gets the time at which the item was updated by the server.
ScalarType	getType() Gets the server type of the item (if scalar) or the server type of the array elements.
Object	getValue() Returns the value as an Object which will be an instance of one of a few standard Java classes, or an array of same.
boolean	isArray() Determines if this item is an array.

Methods inherited from class java.lang.Object

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

Method Detail

getTag

public String getTag()

Gets the name of the item on the server.

Returns:

The name.

getValue

public Object getValue()

Returns the value as an Object which will be an instance of one of a few standard Java classes, or an array of same.

• Double for VT_R{8, 4}.
• Long for VT_{I,UI}{1, 2, 4} and VT_ERROR.
• BigDecimal for VT_CY.
• String for VT_BSTR.
• Boolean for VT_BOOL.
• Instant for VT_DATE.
• String for anything else.

Returns:

The value.

getType

public ScalarType getType()

Gets the server type of the item (if scalar) or the server type of the array elements.

Returns:

The type.

isArray

public boolean isArray()

Determines if this item is an array.

Returns:

true for arrays, false for scalars.

getQuality

public Quality getQuality()

Gets the basic quality of the item.

Returns:

The quality.

getModifier

public String getModifier()

Gets a string containing more detailed information about the item's quality.

Returns:

The expanded quality string.

getTimestamp

public Instant getTimestamp()

Gets the time at which the item was updated by the server.

Returns:

The timestamp.