org.csstudio.data.values.internal

Class Value

java.lang.Object

org.csstudio.data.values.internal.Value

All Implemented Interfaces:

IValue

Direct Known Subclasses:

DoubleValue, EnumeratedValue, LongValue, StringValue

public abstract class Value
extends Object
implements IValue

Implementation of the IValue interface.

Author:

Kay Kasemir

Nested Class Summary

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

IValue.Format

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FORMAT_VALUE_COUNT The max count of values to be formatted into string.

Constructor Summary

Constructors

Constructor and Description
Value(ITimestamp time, ISeverity severity, String status, IMetaData metaData) Constructs a new Value from pieces.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	format() Format the value via the Default format.
abstract String	format(IValue.Format how, int precision) Format the value as a string.
protected char	getDisplayChar(char c) Convert char into printable character for Format.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.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FORMAT_VALUE_COUNT

public static final int MAX_FORMAT_VALUE_COUNT

The max count of values to be formatted into string. The value beyond this count will be omitted.

See Also:

Constant Field Values

Constructor Detail

Value

public Value(ITimestamp time,
             ISeverity severity,
             String status,
             IMetaData metaData)

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 data describing the PV

Method Detail

getTime

public final ITimestamp getTime()

Description copied from interface: IValue

Get the time stamp.

Specified by:

getTime in interface IValue

Returns:

The time stamp.

getSeverity

public final ISeverity getSeverity()

Description copied from interface: IValue

Get the severity info.

Specified by:

getSeverity in interface IValue

Returns:

The severity info.

See Also:

ISeverity, IValue.getStatus()

getStatus

public final String getStatus()

Description copied from interface: IValue

Get the status text that might describe the severity.

Specified by:

getStatus in interface IValue

Returns:

The status string.

See Also:

IValue.getSeverity()

getMetaData

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

format

public abstract 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

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

public final String format()

Description copied from interface: IValue

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

Specified by:

format in interface IValue

Returns:

This Value's value as a string.

See Also:

IValue.format(Format, int)

toString

public final String toString()

Overrides:

toString in class Object

getDisplayChar

protected char getDisplayChar(char c)

Convert char into printable character for Format.String.

Parameters:

c - Char, 0 for end-of-string

Returns:

Printable version

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object