Package ch.psi.wica.model.channel.metadata

Class WicaChannelMetadata

java.lang.Object
ch.psi.wica.model.channel.WicaChannelData
ch.psi.wica.model.channel.metadata.WicaChannelMetadata
Direct Known Subclasses:
WicaChannelMetadataInteger, WicaChannelMetadataIntegerArray, WicaChannelMetadataMixins.WicaChannelMetadataSerializerMixin, WicaChannelMetadataReal, WicaChannelMetadataRealArray, WicaChannelMetadataString, WicaChannelMetadataStringArray, WicaChannelMetadataUnknown
@Immutable public abstract class WicaChannelMetadata extends WicaChannelData
Represents the abstract root of a hierarchy of objects which provide fields to describe a control point's general characteristics or basic nature.

The metadata information is obtained by 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 metadata information typically does not change, or changes only very rarely, for example after a control point has been brought back online following a software update.

The set of fields that are provided for each metadata object depend on the underlying control system. Typical fields include: units - a string representing the physical quantity that the control point represents; the numeric precision; the allowed operating range and/or the thresholds which correspond to error or warning conditions.

  • Constructor Details

    • WicaChannelMetadata

      public WicaChannelMetadata(WicaChannelType wicaChannelType)
      Constructs a new instance based on the supplied channel type.
      Parameters:
      wicaChannelType - the channel type.