IEnumeratedValue (CSS Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.csstudio.data.values
Interface IEnumeratedValue

All Superinterfaces:: IValue, java.io.Serializable

public interface IEnumeratedValue
extends IValue
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 IEnumeratedMetaData

Author:: Kay Kasemir
See Also:: IValue, EnumeratedMetaData

Nested Class Summary

Nested classes/interfaces inherited from interface org.csstudio.data.values.IValue
`IValue.Format, IValue.Quality`

Method Summary
`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, getQuality, 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()

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.