org.epics.vtype

Class ValueFactory

java.lang.Object

org.epics.vtype.ValueFactory

public class ValueFactory
extends Object

Factory class for all concrete implementation of the types.

The factory methods do not do anything in terms of defensive copy and immutability to the objects, which they are passed as they are. It's the client responsibility to prepare them appropriately, which is automatically done anyway for all objects except collections.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ValueFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static Alarm	alarmNone() No alarm.
static Display	displayBoolean() Returns a display from 0 to 1, suitable for booleans.
static Display	displayNone() Empty display information.
static VNumberArray	ndArray(VNumberArray data, ArrayDimensionDisplay... dimensions) Constructs and nd array with the data, time and alarm in the first array and the given dimension information.
static Alarm	newAlarm(AlarmSeverity alarmSeverity, String alarmName) New alarm with the given severity and status.
static Alarm	newAlarm(Number value, Display display) Alarm based on the value and the display ranges.
static Display	newDisplay(Double lowerDisplayLimit, Double lowerAlarmLimit, Double lowerWarningLimit, String units, NumberFormat numberFormat, Double upperWarningLimit, Double upperAlarmLimit, Double upperDisplayLimit, Double lowerCtrlLimit, Double upperCtrlLimit) Creates a new display
static ArrayDimensionDisplay	newDisplay(int nCells) Returns an array display where the index is used to calculate the cell boundaries.
static ArrayDimensionDisplay	newDisplay(int size, ListNumberProvider boundaryProvider)
static ArrayDimensionDisplay	newDisplay(int size, ListNumberProvider boundaryProvider, boolean invert)
static ArrayDimensionDisplay	newDisplay(org.epics.util.array.ListNumber boundaries, boolean reversed, String unit)
static ArrayDimensionDisplay	newDisplay(org.epics.util.array.ListNumber boundaries, String unit)
static Time	newTime(org.epics.util.time.Timestamp timestamp) New time, with no user tag and valid data.
static Time	newTime(org.epics.util.time.Timestamp timestamp, Integer timeUserTag, boolean timeValid) Creates a new time.
static VBoolean	newVBoolean(boolean value, Alarm alarm, Time time) Creates a new VBoolean.
static VBooleanArray	newVBooleanArray(org.epics.util.array.ListBoolean data, Alarm alarm, Time time) Creates a new VBooleanArray.
static VByte	newVByte(Byte value, Alarm alarm, Time time, Display display) Creates a new VByte.
static VDouble	newVDouble(Double value) Creates a new VDouble, no alarm, time now, no display.
static VDouble	newVDouble(Double value, Alarm alarm, Time time, Display display) Creates a new VDouble.
static VDouble	newVDouble(Double value, Display display) Creates new immutable VDouble by using metadata from the old value, now as timestamp and computing alarm from the metadata range.
static VDouble	newVDouble(Double value, Time time) Creates a new VDouble, no alarm, no display.
static VDouble	newVDouble(Double value, Time time, Display display) Creates a new VDouble using the given value, time, display and generating the alarm from the value and display information.
static VDoubleArray	newVDoubleArray(org.epics.util.array.ListDouble data, Alarm alarm, Time time, Display display) Creates a new VDoubleArray.
static VEnum	newVEnum(int index, List<String> labels, Alarm alarm, Time time) Create a new VEnum.
static VEnumArray	newVEnumArray(org.epics.util.array.ListInt indexes, List<String> labels, Alarm alarm, Time time) Create a new VEnumArray.
static VFloat	newVFloat(Float value, Alarm alarm, Time time, Display display) Creates a new VFloat.
static VFloatArray	newVFloatArray(org.epics.util.array.ListFloat data, Alarm alarm, Time time, Display display) Creates a new VFloatArray.
static VImage	newVImage(int height, int width, byte[] data) Creates a new VImage given the data and the size.
static VInt	newVInt(Integer value, Alarm alarm, Time time, Display display) Creates a new VInt.
static VIntArray	newVIntArray(org.epics.util.array.ListInt values, Alarm alarm, Time time, Display display) Creates a new VIntArray.
static VLong	newVLong(Long value, Alarm alarm, Time time, Display display) Creates a new VLong.
static VLongArray	newVLongArray(org.epics.util.array.ListLong values, Alarm alarm, Time time, Display display) Creates a new VLongArray.
static VMultiDouble	newVMultiDouble(List<VDouble> values, Alarm alarm, Time time, Display display) Creates a new VMultiDouble.
static VNumber	newVNumber(Number value, Alarm alarm, Time time, Display display) Creates a new VNumber based on the type of the data
static VNumberArray	newVNumberArray(org.epics.util.array.ListNumber data, Alarm alarm, Time time, Display display) Creates a new VNumberArray based on the type of the data.
static VNumberArray	newVNumberArray(org.epics.util.array.ListNumber data, org.epics.util.array.ListInt sizes, List<ArrayDimensionDisplay> dimensionDisplay, Alarm alarm, Time time, Display display) Creates a new VNumberArray based on the type of the data.
static VShort	newVShort(Short value, Alarm alarm, Time time, Display display) Creates a new VShort.
static VShortArray	newVShortArray(org.epics.util.array.ListShort values, Alarm alarm, Time time, Display display) Creates a new VShortArray.
static VStatistics	newVStatistics(double average, double stdDev, double min, double max, int nSamples, Alarm alarm, Time time, Display display) Creates a new VStatistics.
static VString	newVString(String value, Alarm alarm, Time time) Creates a new VString.
static VStringArray	newVStringArray(List<String> data, Alarm alarm, Time time) Creates a new VStringArray.
static VTable	newVTable(List<Class<?>> types, List<String> names, List<Object> values) Creates a new VTable - this method is provisional and will change in the future.
static Time	timeNow() New time with the current timestamp, no user tag and valid data.
static VType	toVType(Object javaObject) Converts a standard java type to VTypes.
static VType	toVType(Object javaObject, Alarm alarm, Time time, Display display) Converts a standard java type to VTypes.
static VType	toVTypeChecked(Object javaObject) As toVType(java.lang.Object) but throws an exception if conversion not possible.
static VType	toVTypeChecked(Object javaObject, Alarm alarm, Time time, Display display) As toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) but throws an exception if conversion not possible.
static VType	wrapValue(Object value) Deprecated. use toVType(java.lang.Object)
static VType	wrapValue(Object value, Alarm alarm) Deprecated. use toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueFactory

public ValueFactory()

Method Detail

newVString

public static VString newVString(String value,
                 Alarm alarm,
                 Time time)

Creates a new VString.

Parameters:

value - the string value

alarm - the alarm

time - the time

Returns:

the new value

newVBoolean

public static VBoolean newVBoolean(boolean value,
                   Alarm alarm,
                   Time time)

Creates a new VBoolean.

Parameters:

value - the boolean value

alarm - the alarm

time - the time

Returns:

the new value

newVMultiDouble

public static VMultiDouble newVMultiDouble(List<VDouble> values,
                           Alarm alarm,
                           Time time,
                           Display display)

Creates a new VMultiDouble.

Parameters:

values - the values

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVLong

public static VLong newVLong(Long value,
             Alarm alarm,
             Time time,
             Display display)

Creates a new VLong.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVInt

public static VInt newVInt(Integer value,
           Alarm alarm,
           Time time,
           Display display)

Creates a new VInt.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVShort

public static VShort newVShort(Short value,
               Alarm alarm,
               Time time,
               Display display)

Creates a new VShort.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVByte

public static VByte newVByte(Byte value,
             Alarm alarm,
             Time time,
             Display display)

Creates a new VByte.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newAlarm

public static Alarm newAlarm(AlarmSeverity alarmSeverity,
             String alarmName)

New alarm with the given severity and status.

Parameters:

alarmSeverity - the alarm severity

alarmName - the alarm name

Returns:

the new alarm

alarmNone

public static Alarm alarmNone()

No alarm.

Returns:

severity and status NONE

newAlarm

public static Alarm newAlarm(Number value,
             Display display)

Alarm based on the value and the display ranges.

Parameters:

value - the value

display - the display information

Returns:

the new alarm

newTime

public static Time newTime(org.epics.util.time.Timestamp timestamp,
           Integer timeUserTag,
           boolean timeValid)

Creates a new time.

Parameters:

timestamp - the timestamp

timeUserTag - the user tag

timeValid - whether the time is valid

Returns:

the new time

newTime

public static Time newTime(org.epics.util.time.Timestamp timestamp)

New time, with no user tag and valid data.

Parameters:

timestamp - the timestamp

Returns:

the new time

timeNow

public static Time timeNow()

New time with the current timestamp, no user tag and valid data.

Returns:

the new time

newDisplay

public static Display newDisplay(Double lowerDisplayLimit,
                 Double lowerAlarmLimit,
                 Double lowerWarningLimit,
                 String units,
                 NumberFormat numberFormat,
                 Double upperWarningLimit,
                 Double upperAlarmLimit,
                 Double upperDisplayLimit,
                 Double lowerCtrlLimit,
                 Double upperCtrlLimit)

Creates a new display

Parameters:

lowerDisplayLimit - lower display limit

lowerAlarmLimit - lower alarm limit

lowerWarningLimit - lower warning limit

units - the units

numberFormat - the formatter

upperWarningLimit - the upper warning limit

upperAlarmLimit - the upper alarm limit

upperDisplayLimit - the upper display limit

lowerCtrlLimit - the lower control limit

upperCtrlLimit - the upper control limit

Returns:

the new display

newDisplay

public static ArrayDimensionDisplay newDisplay(org.epics.util.array.ListNumber boundaries,
                               String unit)

newDisplay

public static ArrayDimensionDisplay newDisplay(org.epics.util.array.ListNumber boundaries,
                               boolean reversed,
                               String unit)

newDisplay

public static ArrayDimensionDisplay newDisplay(int size,
                               ListNumberProvider boundaryProvider,
                               boolean invert)

newDisplay

public static ArrayDimensionDisplay newDisplay(int size,
                               ListNumberProvider boundaryProvider)

newDisplay

public static ArrayDimensionDisplay newDisplay(int nCells)

Returns an array display where the index is used to calculate the cell boundaries.

Parameters:

nCells - the number of cells along the direction

Returns:

a new array display

displayNone

public static Display displayNone()

Empty display information.

Returns:

no display

displayBoolean

public static Display displayBoolean()

Returns a display from 0 to 1, suitable for booleans.

Returns:

a display for boolean

newVNumber

public static VNumber newVNumber(Number value,
                 Alarm alarm,
                 Time time,
                 Display display)

Creates a new VNumber based on the type of the data

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new number

newVDouble

public static VDouble newVDouble(Double value,
                 Alarm alarm,
                 Time time,
                 Display display)

Creates a new VDouble.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVDouble

public static VDouble newVDouble(Double value,
                 Time time,
                 Display display)

Creates a new VDouble using the given value, time, display and generating the alarm from the value and display information.

Parameters:

value - the new value

time - the time

display - the display information

Returns:

the new value

newVDouble

public static VDouble newVDouble(Double value,
                 Display display)

Creates new immutable VDouble by using metadata from the old value, now as timestamp and computing alarm from the metadata range.

Parameters:

value - new numeric value

display - metadata

Returns:

new value

newVDouble

public static VDouble newVDouble(Double value)

Creates a new VDouble, no alarm, time now, no display.

Parameters:

value - the value

Returns:

the new value

newVDouble

public static VDouble newVDouble(Double value,
                 Time time)

Creates a new VDouble, no alarm, no display.

Parameters:

value - the value

time - the time

Returns:

the new value

newVFloat

public static VFloat newVFloat(Float value,
               Alarm alarm,
               Time time,
               Display display)

Creates a new VFloat.

Parameters:

value - the value

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVEnum

public static VEnum newVEnum(int index,
             List<String> labels,
             Alarm alarm,
             Time time)

Create a new VEnum.

Parameters:

index - the index in the label array

labels - the labels

alarm - the alarm

time - the time

Returns:

the new value

newVStatistics

public static VStatistics newVStatistics(double average,
                         double stdDev,
                         double min,
                         double max,
                         int nSamples,
                         Alarm alarm,
                         Time time,
                         Display display)

Creates a new VStatistics.

Parameters:

average - average

stdDev - standard deviation

min - minimum

max - maximum

nSamples - number of samples

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVNumberArray

public static VNumberArray newVNumberArray(org.epics.util.array.ListNumber data,
                           Alarm alarm,
                           Time time,
                           Display display)

Creates a new VNumberArray based on the type of the data.

Parameters:

data - the array data

alarm - the alarm

time - the time

display - the display

Returns:

a new value

newVNumberArray

public static VNumberArray newVNumberArray(org.epics.util.array.ListNumber data,
                           org.epics.util.array.ListInt sizes,
                           List<ArrayDimensionDisplay> dimensionDisplay,
                           Alarm alarm,
                           Time time,
                           Display display)

Creates a new VNumberArray based on the type of the data.

Parameters:

data - the array data

sizes - the array shape

dimensionDisplay - the array axis display information

alarm - the alarm

time - the time

display - the display

Returns:

a new value

ndArray

public static VNumberArray ndArray(VNumberArray data,
                   ArrayDimensionDisplay... dimensions)

Constructs and nd array with the data, time and alarm in the first array and the given dimension information.

Parameters:

data - the array with the data

dimensions - the dimension information

Returns:

a new array

newVDoubleArray

public static VDoubleArray newVDoubleArray(org.epics.util.array.ListDouble data,
                           Alarm alarm,
                           Time time,
                           Display display)

Creates a new VDoubleArray.

Parameters:

data - array data

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVFloatArray

public static VFloatArray newVFloatArray(org.epics.util.array.ListFloat data,
                         Alarm alarm,
                         Time time,
                         Display display)

Creates a new VFloatArray.

Parameters:

data - array data

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVImage

public static VImage newVImage(int height,
               int width,
               byte[] data)

Creates a new VImage given the data and the size.

Parameters:

height - the height

width - the width

data - the data

Returns:

a new object

newVLongArray

public static VLongArray newVLongArray(org.epics.util.array.ListLong values,
                       Alarm alarm,
                       Time time,
                       Display display)

Creates a new VLongArray.

Parameters:

values - array values

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVIntArray

public static VIntArray newVIntArray(org.epics.util.array.ListInt values,
                     Alarm alarm,
                     Time time,
                     Display display)

Creates a new VIntArray.

Parameters:

values - array values

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVShortArray

public static VShortArray newVShortArray(org.epics.util.array.ListShort values,
                         Alarm alarm,
                         Time time,
                         Display display)

Creates a new VShortArray.

Parameters:

values - array values

alarm - the alarm

time - the time

display - the display

Returns:

the new value

newVEnumArray

public static VEnumArray newVEnumArray(org.epics.util.array.ListInt indexes,
                       List<String> labels,
                       Alarm alarm,
                       Time time)

Create a new VEnumArray.

Parameters:

indexes - the indexes in the label array

labels - the labels

alarm - the alarm

time - the time

Returns:

the new value

newVBooleanArray

public static VBooleanArray newVBooleanArray(org.epics.util.array.ListBoolean data,
                             Alarm alarm,
                             Time time)

Creates a new VBooleanArray.

Parameters:

data - the strings

alarm - the alarm

time - the time

Returns:

the new value

newVStringArray

public static VStringArray newVStringArray(List<String> data,
                           Alarm alarm,
                           Time time)

Creates a new VStringArray.

Parameters:

data - the strings

alarm - the alarm

time - the time

Returns:

the new value

newVTable

public static VTable newVTable(List<Class<?>> types,
               List<String> names,
               List<Object> values)

Creates a new VTable - this method is provisional and will change in the future.

Parameters:

types - the types for each column

names - the names for each column

values - the values for each column

Returns:

the new value

wrapValue

@Deprecated
public static VType wrapValue(Object value)

Deprecated. use toVType(java.lang.Object)

Takes a java objects and wraps it into a vType. All numbers are wrapped as VDouble. String is wrapped as VString. double[] and ListDouble are wrapped as VDoubleArray. A List of String is wrapped to a VStringArray. Alarms are alarmNone(), time are timeNow() and display are displayNone();

Parameters:

value - the value to wrap

Returns:

the wrapped value

wrapValue

@Deprecated
public static VType wrapValue(Object value,
                         Alarm alarm)

Deprecated. use toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display)

Takes a java objects and wraps it into a vType. All numbers are wrapped as VDouble. String is wrapped as VString. double[] and ListDouble are wrapped as VDoubleArray. A List of String is wrapped to a VStringArray. Alarms are alarm, time are timeNow() and display are displayNone();

Parameters:

value - the value to wrap

alarm - the alarm for the value

Returns:

the wrapped value

toVType

public static VType toVType(Object javaObject)

Converts a standard java type to VTypes. Returns null if no conversion is possible. Calls toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) with no alarm, time now and no display.

Parameters:

javaObject - the value to wrap

Returns:

the new VType value

toVType

public static VType toVType(Object javaObject,
            Alarm alarm,
            Time time,
            Display display)

Converts a standard java type to VTypes. Returns null if no conversion is possible.

Types are converted as follow:

• Boolean -> VBoolean
• Number -> corresponding VNumber
• String -> VString
• number array -> corresponding VNumberArray
• ListNumber -> corresponding VNumberArray
• List -> if all elements are String, VStringArray

Parameters:

javaObject - the value to wrap

alarm - the alarm

time - the time

display - the display

Returns:

the new VType value

toVTypeChecked

public static VType toVTypeChecked(Object javaObject)

As toVType(java.lang.Object) but throws an exception if conversion not possible.

Parameters:

javaObject - the value to wrap

Returns:

the new VType value

toVTypeChecked

public static VType toVTypeChecked(Object javaObject,
                   Alarm alarm,
                   Time time,
                   Display display)

As toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) but throws an exception if conversion not possible.

Parameters:

javaObject - the value to wrap

alarm - the alarm

time - the time

display - the display

Returns:

the new VType value