Package ch.psi.wica.model.channel.value

Class WicaChannelValue

java.lang.Object

ch.psi.wica.model.channel.WicaChannelData

ch.psi.wica.model.channel.value.WicaChannelValue

Direct Known Subclasses:

WicaChannelValueConnected, WicaChannelValueDisconnected, WicaChannelValueMixins.WicaChannelValueSerializerMixin

@Immutable
public abstract class WicaChannelValue
extends WicaChannelData

Represents the abstract root of a hierarchy of objects which provide fields to describe a control point's instantaneous state.

The value information typically changes often and is obtained by continuous communication with the control system hosting the control point. Subsequently, the information is captured and made available for JSON string serialisation and for inclusion as part of a wica stream.

The set of fields that are concretely provided for each control point depend on the underlying control system. Typical fields include: whether the channel is online or offline, the raw value and timestamp obtained when the channel was last read out, and whether an alarm or warning condition exists.

Constructor Summary

Constructors

Constructor	Description
WicaChannelValue(WicaChannelType wicaChannelType, LocalDateTime wicaServerTimestamp, boolean connected)	Constructs a new instance of a value for a channel.

Method Summary

Modifier and Type	Method	Description
boolean	isConnected()
String	toString()

Methods inherited from class ch.psi.wica.model.channel.WicaChannelData

getType, getWicaServerTimestamp

Methods inherited from class java.lang.Object

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

Constructor Details

WicaChannelValue

public WicaChannelValue(WicaChannelType wicaChannelType,
 LocalDateTime wicaServerTimestamp,
 boolean connected)

Constructs a new instance of a value for a channel.

Parameters:

wicaChannelType - the channel type.

wicaServerTimestamp - the data source timestamp.

Method Details

isConnected

public boolean isConnected()

toString

public String toString()

Overrides:

toString in class Object