IValue.Quality (CSS Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.csstudio.data.values
Enum IValue.Quality

java.lang.Object
  java.lang.Enum<IValue.Quality>
      org.csstudio.data.values.IValue.Quality

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<IValue.Quality>

Enclosing interface:: IValue

public static enum IValue.Quality
extends java.lang.Enum<IValue.Quality>
extends java.lang.Enum<IValue.Quality>

Describe the data quality.

Control system data can originate directly from a front-end controller, or from a data history archive that stored such front-end controller values. We consider this the 'original' data.

Mid-level data servers or history data servers might also offer processed data, which reduces several 'original' samples to for example an 'averaged' sample. For those processed values, the time stamp actually no longer matches one specific instance in time when the front-end controller obtained a sample.

While the quality code does not fully describe what happened to the data, it provides a hint to for example a plotting tool, so that processed samples can be shown in a different way from original samples.

Enum Constant Summary
`Interpolated` This value is the result of interpolating 'original' samples.
`Original` This is a raw, original sample.

Method Summary
`static IValue.Quality`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static IValue.Quality[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

Original

public static final IValue.Quality Original

This is a raw, original sample.

Interpolated

public static final IValue.Quality Interpolated

This value is the result of interpolating 'original' samples.

There are several possible examples:

The data type was changed from 'double' to 'integer', with a possible loss off precision.
This sample results from linear interpolation between two original samples.
This sample results from averaging over several original values.

Method Detail

values

public static IValue.Quality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IValue.Quality c : IValue.Quality.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static IValue.Quality valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null