org.lsst.ccs.gconsole.plugins.trending

Enum Trend.Meta

java.lang.Object

java.lang.Enum<Trend.Meta>

org.lsst.ccs.gconsole.plugins.trending.Trend.Meta

All Implemented Interfaces:

Serializable, Comparable<Trend.Meta>

Enclosing class:

Trend

public static enum Trend.Meta
extends Enum<Trend.Meta>

Enumeration of metadata types that might be plotted for a trending channel. On-point metadata is plotted as vertical bars associated with every data point. Only one on-point metadata type can be displayed at a time. Off-point metadata is plotted as lines.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALARM Alarm triggering level.
RANGE Min/max range of data represented by a single point on the plot.
RMS RMS of data represented by a single point on the plot.
WARNING Warning triggering level.

Method Summary

Modifier and Type	Method and Description
double[][]	getBars(double[][] in) Computes data for displaying error bars.
Color	getColor()
List<String>	getKeys()
static EnumSet<Trend.Meta>	getOffPointSet()
static EnumSet<Trend.Meta>	getOnPointSet()
boolean	isOnPoint()
int	size()
static Trend.Meta	valueOf(String name) Returns the enum constant of this type with the specified name.
static Trend.Meta[]	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

RANGE

public static final Trend.Meta RANGE

Min/max range of data represented by a single point on the plot. On-point.

RMS

public static final Trend.Meta RMS

RMS of data represented by a single point on the plot. On-point.

ALARM

public static final Trend.Meta ALARM

Alarm triggering level. Off-point.

WARNING

public static final Trend.Meta WARNING

Warning triggering level. Off-point.

Method Detail

values

public static Trend.Meta[] 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 (Trend.Meta c : Trend.Meta.values())
    System.out.println(c);

Returns:

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

valueOf

public static Trend.Meta valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOnPointSet

public static EnumSet<Trend.Meta> getOnPointSet()

getOffPointSet

public static EnumSet<Trend.Meta> getOffPointSet()

isOnPoint

public boolean isOnPoint()

getColor

public Color getColor()

size

public int size()

getKeys

public List<String> getKeys()

getBars

public double[][] getBars(double[][] in)

Computes data for displaying error bars.

Parameters:

in - double[size()+1][n] array. The first index: 0 for value, then for all keys.

Returns:

double[2][n] array. The first index is 0 for lower bar.