org.csstudio.data.values.internal

Class EnumeratedValue

java.lang.Object

org.csstudio.data.values.internal.Value

org.csstudio.data.values.internal.EnumeratedValue

All Implemented Interfaces:

IEnumeratedValue, IValue

public class EnumeratedValue
extends Value
implements IEnumeratedValue

Implementation of IEnumeratedValue.

Author:

Kay Kasemir, Xihui Chen

See Also:

IEnumeratedValue

Nested Class Summary

Nested classes/interfaces inherited from interface org.csstudio.data.values.IValue

IValue.Format

Field Summary

Fields inherited from class org.csstudio.data.values.internal.Value

MAX_FORMAT_VALUE_COUNT

Constructor Summary

Constructors

Constructor and Description
EnumeratedValue(ITimestamp time, ISeverity severity, String status, IEnumeratedMetaData metaData, int[] values) Constructs a new value from pieces.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	format(IValue.Format how, int precision) Format the value as a string.
IEnumeratedMetaData	getMetaData() Meta Data that helps with using the value, mostly for formatting.
int	getValue()
int[]	getValues()
int	hashCode()

Methods inherited from class org.csstudio.data.values.internal.Value

format, getDisplayChar, getSeverity, getStatus, getTime, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.csstudio.data.values.IValue

format, getSeverity, getStatus, getTime

Constructor Detail

EnumeratedValue

public EnumeratedValue(ITimestamp time,
                       ISeverity severity,
                       String status,
                       IEnumeratedMetaData metaData,
                       int[] values)

Constructs a new value from pieces.

Parameters:

time - the timestamp of the value

severity - the severity of the value

status - the status of the value

metaData - the meta info describing the PV

values - the values

Method Detail

getValues

public final int[] getValues()

Specified by:

getValues in interface IEnumeratedValue

Returns:

Returns the whole array of values.

getValue

public final int getValue()

Specified by:

getValue in interface IEnumeratedValue

Returns:

Returns the first array element.

Since most values are probably scalars, this is a convenient way to get that one and only element.

See Also:

IEnumeratedValue.getValues()

format

public final String format(IValue.Format how,
                           int precision)

Description copied from interface: IValue

Format the value as a string.

This means only the numeric or string value. Not the timestamp, not the severity and status.

Specified by:

format in interface IValue

Specified by:

format in class Value

Parameters:

how - Detail on how to format.

precision - Might be used by some format types to select for example the number of digits after the decimal point. A precision of '-1' might select the default-precision obtained from the MetaData.

Returns:

This Value's value as a string.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Value

hashCode

public final int hashCode()

Overrides:

hashCode in class Value

getMetaData

public IEnumeratedMetaData getMetaData()

Description copied from interface: IValue

Meta Data that helps with using the value, mostly for formatting.

It might be OK for some value types to only have null MetaData, while others might require a specific one like NumericMetaData.

Specified by:

getMetaData in interface IEnumeratedValue

Specified by:

getMetaData in interface IValue

Overrides:

getMetaData in class Value

Returns:

The Meta Data.