org.csstudio.data.values

Interface IEnumeratedValue

All Superinterfaces:

IValue

All Known Implementing Classes:

EnumeratedValue

public interface IEnumeratedValue
extends IValue

An enumerated value.

Enumerated types carry a limited number of integer values, where each possible value represents a state with a string representation.

IEnumeratedValue values go with EnumeratedMetaData

Author:

Kay Kasemir

See Also:

IValue, EnumeratedMetaData

Nested Class Summary

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

IValue.Format

Method Summary

Modifier and Type	Method and Description
IEnumeratedMetaData	getMetaData() Meta Data that helps with using the value, mostly for formatting.
int	getValue()
int[]	getValues()

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

format, format, getSeverity, getStatus, getTime

Method Detail

getValues

int[] getValues()

Returns:

Returns the whole array of values.

getValue

int getValue()

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:

getValues()

getMetaData

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 IValue

Returns:

The Meta Data.