org.csstudio.data.values

Interface IValue

All Known Subinterfaces:

IDoubleValue, IEnumeratedValue, ILongValue, IStringValue

All Known Implementing Classes:

DoubleValue, EnumeratedValue, LongValue, StringValue, Value

public interface IValue

Base interface for all control system values.

The Value handles all the other 'stuff' that comes with a control system value except for the actual value itself:

• Time stamp
• A severity code that indicates if the data reflects some sort of warning or error state.
• A status string that explains the severity.
• Meta data that might be useful for displaying the data.

It also offers convenience routines for displaying values.

In some cases, that's already all that there might be, because a sample can have a severity that indicates that there was no value, and the status describes why.

In most cases, however, access to the actual data requires the specific subtypes DoubleValue, StringValue etc.

Author:

Kay Kasemir

See Also:

IDoubleValue, ILongValue, IStringValue, IEnumeratedValue

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IValue.Format

Method Summary

Modifier and Type	Method and Description
String	format() Format the value via the Default format.
String	format(IValue.Format how, int precision) Format the value as a string.
IMetaData	getMetaData() Meta Data that helps with using the value, mostly for formatting.
ISeverity	getSeverity() Get the severity info.
String	getStatus() Get the status text that might describe the severity.
ITimestamp	getTime() Get the time stamp.

Method Detail

getTime

ITimestamp getTime()

Get the time stamp.

Returns:

The time stamp.

getSeverity

ISeverity getSeverity()

Get the severity info.

Returns:

The severity info.

See Also:

ISeverity, getStatus()

getStatus

String getStatus()

Get the status text that might describe the severity.

Returns:

The status string.

See Also:

getSeverity()

getMetaData

IMetaData 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.

Returns:

The Meta Data.

format

String format(IValue.Format how,
              int precision)

Format the value as a string.

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

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.

format

String format()

Format the value via the Default format. Typically this means: using the meta data.

Returns:

This Value's value as a string.

See Also:

format(Format, int)