ExpressionLanguage (pvmanager 2.9.1-SNAPSHOT API)

java.lang.Object
- org.epics.pvmanager.vtype.ExpressionLanguage

```
public class ExpressionLanguage
extends Object
```
PVManager expression language support for value types.

Author:

carcassi

Method Summary

Methods
Modifier and Type	Method and Description
`static DesiredRateExpression<VDouble>`	`averageOf(SourceRateExpression<VDouble> doublePv)` Aggregates the sample at the scan rate and takes the average.
`static VTableColumn`	`column(String name, DesiredRateExpressionList<?> values)` A column for an aggregated vTable.
`static DesiredRateExpression<VStatistics>`	`statisticsOf(SourceRateExpression<VDouble> doublePv)` Aggregates the sample at the scan rate and calculates statistical information.
`static DesiredRateExpressionList<VStatistics>`	`statisticsOf(SourceRateExpressionList<VDouble> doubleExpressions)` Applies `statisticsOf(org.epics.pvmanager.expression.SourceRateExpression)` to all arguments.
`static DesiredRateExpression<VMultiDouble>`	`synchronizedArrayOf(org.epics.util.time.TimeDuration tolerance, SourceRateExpressionList<VDouble> expressions)` A synchronized array from the given expression.
`static DesiredRateExpression<VMultiDouble>`	`synchronizedArrayOf(org.epics.util.time.TimeDuration tolerance, org.epics.util.time.TimeDuration cacheDepth, SourceRateExpressionList<VDouble> expressions)` A synchronized array from the given expression.
`static <T extends Time> DesiredRateExpression<List<T>>`	`timedCacheOf(SourceRateExpression<T> expression, org.epics.util.time.TimeDuration maxIntervalBetweenSamples)` Returns all the values starting the latest value and older up to the time difference given by the interval.
`static ChannelExpression<VByte,Byte>`	`vByte(String name)` A channel with the given name of type VByte.
`static ChannelExpression<VByteArray,org.epics.util.array.ArrayByte>`	`vByteArray(String name)` A channel with the given name of type VByteArray.
`static DesiredRateExpression<VDoubleArray>`	`vConst(double... values)` A constant representing a double array.
`static DesiredRateExpression<VDouble>`	`vConst(double value)` A constant representing a double.
`static DesiredRateExpression<VIntArray>`	`vConst(int... values)` A constant representing an int array.
`static DesiredRateExpression<VInt>`	`vConst(int value)` A constant representing an int.
`static DesiredRateExpression<VDoubleArray>`	`vConst(org.epics.util.array.ListDouble values)` A constant representing a double array.
`static DesiredRateExpression<VIntArray>`	`vConst(org.epics.util.array.ListInt values)` A constant representing an int array.
`static DesiredRateExpression<VString>`	`vConst(String value)` A constant representing a string.
`static ChannelExpression<VDouble,Double>`	`vDouble(String name)` A channel with the given name of type VDouble.
`static ChannelExpression<VDoubleArray,org.epics.util.array.ArrayDouble>`	`vDoubleArray(String name)` A channel with the given name of type VDoubleArray.
`static DesiredRateExpressionList<VDouble>`	`vDoubleConstants(List<Double> values)` A list of constant expressions of type VDouble.
`static ChannelExpressionList<VDouble,Double>`	`vDoubles(Collection<String> names)` A list of channels with the given names, all of type VDouble.
`static ChannelExpression<VEnum,Integer>`	`vEnum(String name)` A channel with the given name of type VEnum.
`static ChannelExpression<VFloat,Float>`	`vFloat(String name)` A channel with the given name of type VFloat.
`static ChannelExpression<VFloatArray,org.epics.util.array.ArrayFloat>`	`vFloatArray(String name)` A channel with the given name of type VFloatArray.
`static ChannelExpression<VInt,Integer>`	`vInt(String name)` A channel with the given name of type VInt.
`static ChannelExpression<VIntArray,org.epics.util.array.ArrayInt>`	`vIntArray(String name)` A channel with the given name of type VIntArray.
`static DesiredRateExpressionList<VInt>`	`vIntConstants(List<Integer> values)` A list of constant expressions of type VDouble.
`static ChannelExpression<VNumber,Number>`	`vNumber(String name)` A channel with the given name of type VNumber.
`static ChannelExpression<VNumberArray,org.epics.util.array.ListNumber>`	`vNumberArray(String name)` A channel with the given name of type VNumberArray.
`static DesiredRateExpression<VNumberArray>`	`vNumberArrayOf(DesiredRateExpressionList<? extends VNumber> expressions)` Transforms a list of numeric scalar into an array.
`static ChannelExpressionList<VNumber,Number>`	`vNumbers(Collection<String> names)` A list of channels with the given names, all of type VNumber.
`static ChannelExpression<VShort,Short>`	`vShort(String name)` A channel with the given name of type VShort.
`static ChannelExpression<VShortArray,org.epics.util.array.ArrayShort>`	`vShortArray(String name)` A channel with the given name of type VShortArray.
`static ChannelExpression<VString,String>`	`vString(String name)` A channel with the given name of type VString.
`static ChannelExpression<VStringArray,List<String>>`	`vStringArray(String name)` A channel with the given name of type VStringArray.
`static DesiredRateExpressionList<VString>`	`vStringConstants(List<String> values)` A list of constant expressions of type VString.
`static DesiredRateExpression<VString>`	`vStringOf(DesiredRateExpression<? extends VType> expression)` An expression that formats the given expression to a string using the default format.
`static DesiredRateExpression<VString>`	`vStringOf(DesiredRateExpression<? extends VType> expression, ValueFormat valueFormat)` An expression that formats the given expression to a string using the given format.
`static DesiredRateReadWriteExpression<VString,String>`	`vStringOf(DesiredRateReadWriteExpression<? extends VType,? extends Object> expression)` An expression that formats the given expression to a string using the default format.
`static DesiredRateReadWriteExpression<VString,String>`	`vStringOf(DesiredRateReadWriteExpression<? extends VType,? extends Object> expression, ValueFormat valueFormat)` An expression that formats the given expression to a string using the given format.
`static DesiredRateExpression<VTable>`	`vTable(VTableColumn... columns)` Creates a vTable by aggregating different values from different pvs.
`static ChannelExpression<VType,Object>`	`vType(String name)` A channel with the given name that returns any of the value types.
`static ChannelExpressionList<VType,Object>`	`vTypes(Collection<String> names)` A list of channels with the given names that return any of the value types.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - vType
```
public static ChannelExpression<VType,Object> vType(String name)
```
    A channel with the given name that returns any of the value types.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vTypes
```
public static ChannelExpressionList<VType,Object> vTypes(Collection<String> names)
```
    A list of channels with the given names that return any of the value types.
    
    Parameters:
    names - the channel names; can't be null
    
    Returns:
    a list of expressions representing the channels
  - vNumber
```
public static ChannelExpression<VNumber,Number> vNumber(String name)
```
    A channel with the given name of type VNumber.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vNumbers
```
public static ChannelExpressionList<VNumber,Number> vNumbers(Collection<String> names)
```
    A list of channels with the given names, all of type VNumber.
    
    Parameters:
    names - the channel names; can't be null
    
    Returns:
    a list of expressions representing the channels
  - vDouble
```
public static ChannelExpression<VDouble,Double> vDouble(String name)
```
    A channel with the given name of type VDouble.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vFloat
```
public static ChannelExpression<VFloat,Float> vFloat(String name)
```
    A channel with the given name of type VFloat.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vInt
```
public static ChannelExpression<VInt,Integer> vInt(String name)
```
    A channel with the given name of type VInt.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vShort
```
public static ChannelExpression<VShort,Short> vShort(String name)
```
    A channel with the given name of type VShort.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vByte
```
public static ChannelExpression<VByte,Byte> vByte(String name)
```
    A channel with the given name of type VByte.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vNumberArray
```
public static ChannelExpression<VNumberArray,org.epics.util.array.ListNumber> vNumberArray(String name)
```
    A channel with the given name of type VNumberArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vNumberArrayOf
```
public static DesiredRateExpression<VNumberArray> vNumberArrayOf(DesiredRateExpressionList<? extends VNumber> expressions)
```
    Transforms a list of numeric scalar into an array.
    
    Parameters:
    expressions - a list of numeric expressions
    
    Returns:
    a new numeric array expression
  - vFloatArray
```
public static ChannelExpression<VFloatArray,org.epics.util.array.ArrayFloat> vFloatArray(String name)
```
    A channel with the given name of type VFloatArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vDoubleArray
```
public static ChannelExpression<VDoubleArray,org.epics.util.array.ArrayDouble> vDoubleArray(String name)
```
    A channel with the given name of type VDoubleArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vByteArray
```
public static ChannelExpression<VByteArray,org.epics.util.array.ArrayByte> vByteArray(String name)
```
    A channel with the given name of type VByteArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vShortArray
```
public static ChannelExpression<VShortArray,org.epics.util.array.ArrayShort> vShortArray(String name)
```
    A channel with the given name of type VShortArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vIntArray
```
public static ChannelExpression<VIntArray,org.epics.util.array.ArrayInt> vIntArray(String name)
```
    A channel with the given name of type VIntArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vString
```
public static ChannelExpression<VString,String> vString(String name)
```
    A channel with the given name of type VString.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vStringArray
```
public static ChannelExpression<VStringArray,List<String>> vStringArray(String name)
```
    A channel with the given name of type VStringArray.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vEnum
```
public static ChannelExpression<VEnum,Integer> vEnum(String name)
```
    A channel with the given name of type VEnum.
    
    Parameters:
    name - the channel name; can't be null
    
    Returns:
    an expression representing the channel
  - vDoubles
```
public static ChannelExpressionList<VDouble,Double> vDoubles(Collection<String> names)
```
    A list of channels with the given names, all of type VDouble.
    
    Parameters:
    names - the channel names; can't be null
    
    Returns:
    a list of expressions representing the channels
  - vConst
```
public static DesiredRateExpression<VString> vConst(String value)
```
    A constant representing a string. Alarm will be none and timestamp now.
    
    Parameters:
    value - the constant value
    
    Returns:
    a string expression
  - vConst
```
public static DesiredRateExpression<VDouble> vConst(double value)
```
    A constant representing a double. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    value - the constant value
    
    Returns:
    a double expression
  - vConst
```
public static DesiredRateExpression<VInt> vConst(int value)
```
    A constant representing an int. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    value - the constant value
    
    Returns:
    an int expression
  - vConst
```
public static DesiredRateExpression<VDoubleArray> vConst(double... values)
```
    A constant representing a double array. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    values - the constant values
    
    Returns:
    a double array expression
  - vConst
```
public static DesiredRateExpression<VDoubleArray> vConst(org.epics.util.array.ListDouble values)
```
    A constant representing a double array. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    values - the constant values
    
    Returns:
    a double array expression
  - vConst
```
public static DesiredRateExpression<VIntArray> vConst(int... values)
```
    A constant representing an int array. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    values - the constant values
    
    Returns:
    an int array expression
  - vConst
```
public static DesiredRateExpression<VIntArray> vConst(org.epics.util.array.ListInt values)
```
    A constant representing an int array. Alarm will be none, timestamp now and no display information.
    
    Parameters:
    values - the constant values
    
    Returns:
    an int array expression
  - vDoubleConstants
```
public static DesiredRateExpressionList<VDouble> vDoubleConstants(List<Double> values)
```
    A list of constant expressions of type VDouble.
    
    Parameters:
    values - the list of constants
    
    Returns:
    a list of double expression
  - vIntConstants
```
public static DesiredRateExpressionList<VInt> vIntConstants(List<Integer> values)
```
    A list of constant expressions of type VDouble.
    
    Parameters:
    values - the list of constants
    
    Returns:
    a list of int expression
  - vStringConstants
```
public static DesiredRateExpressionList<VString> vStringConstants(List<String> values)
```
    A list of constant expressions of type VString.
    
    Parameters:
    values - the list of constants
    
    Returns:
    a list of string expression
  - vStringOf
```
public static DesiredRateExpression<VString> vStringOf(DesiredRateExpression<? extends VType> expression,
                                       ValueFormat valueFormat)
```
    An expression that formats the given expression to a string using the given format.
    
    Parameters:
    expression - the expression to format
    valueFormat - the format to use for the conversion
    
    Returns:
    an expression with the string representation of the argument
  - vStringOf
```
public static DesiredRateExpression<VString> vStringOf(DesiredRateExpression<? extends VType> expression)
```
    An expression that formats the given expression to a string using the default format.
    
    Parameters:
    expression - the expression to format
    
    Returns:
    an expression with the string representation of the argument
  - vStringOf
```
public static DesiredRateReadWriteExpression<VString,String> vStringOf(DesiredRateReadWriteExpression<? extends VType,? extends Object> expression)
```
    An expression that formats the given expression to a string using the default format.
    
    Parameters:
    expression - the expression to format
    
    Returns:
    an expression with the string representation of the argument
  - vStringOf
```
public static DesiredRateReadWriteExpression<VString,String> vStringOf(DesiredRateReadWriteExpression<? extends VType,? extends Object> expression,
                                                       ValueFormat valueFormat)
```
    An expression that formats the given expression to a string using the given format.
    
    Parameters:
    expression - the expression to format
    valueFormat - the format to use for the conversion
    
    Returns:
    an expression with the string representation of the argument
  - averageOf
```
public static DesiredRateExpression<VDouble> averageOf(SourceRateExpression<VDouble> doublePv)
```
    Aggregates the sample at the scan rate and takes the average.
    
    Parameters:
    doublePv - the expression to take the average of; can't be null
    
    Returns:
    an expression representing the average of the expression
  - statisticsOf
```
public static DesiredRateExpression<VStatistics> statisticsOf(SourceRateExpression<VDouble> doublePv)
```
    Aggregates the sample at the scan rate and calculates statistical information.
    
    Parameters:
    doublePv - the expression to calculate the statistics information on; can't be null
    
    Returns:
    an expression representing the statistical information of the expression
  - statisticsOf
```
public static DesiredRateExpressionList<VStatistics> statisticsOf(SourceRateExpressionList<VDouble> doubleExpressions)
```
    Applies statisticsOf(org.epics.pvmanager.expression.SourceRateExpression) to all arguments.
    
    Parameters:
    doubleExpressions - a list of double expressions
    
    Returns:
    a list of statistical expressions
  - synchronizedArrayOf
```
public static DesiredRateExpression<VMultiDouble> synchronizedArrayOf(org.epics.util.time.TimeDuration tolerance,
                                                      SourceRateExpressionList<VDouble> expressions)
```
    A synchronized array from the given expression.
    
    Parameters:
    tolerance - maximum time difference between samples
    expressions - the expressions from which to reconstruct the array
    
    Returns:
    an expression for the array
  - synchronizedArrayOf
```
public static DesiredRateExpression<VMultiDouble> synchronizedArrayOf(org.epics.util.time.TimeDuration tolerance,
                                                      org.epics.util.time.TimeDuration cacheDepth,
                                                      SourceRateExpressionList<VDouble> expressions)
```
    A synchronized array from the given expression.
    
    Parameters:
    tolerance - maximum time difference between samples in the reconstructed array
    cacheDepth - maximum time difference between samples in the caches used to reconstruct the array
    expressions - the expressions from which to reconstruct the array
    
    Returns:
    an expression for the array
  - timedCacheOf
```
public static <T extends Time> DesiredRateExpression<List<T>> timedCacheOf(SourceRateExpression<T> expression,
                                                           org.epics.util.time.TimeDuration maxIntervalBetweenSamples)
```
    Returns all the values starting the latest value and older up to the time difference given by the interval.
    
    Type Parameters:
    T - type being read
    Parameters:
    expression - expression to read
    maxIntervalBetweenSamples - maximum time difference between values
    
    Returns:
    a new expression
  - column
```
public static VTableColumn column(String name,
                  DesiredRateExpressionList<?> values)
```
    A column for an aggregated vTable.
    
    Parameters:
    name - the name of the column
    values - the value of the column
    
    Returns:
    the column
  - vTable
```
public static DesiredRateExpression<VTable> vTable(VTableColumn... columns)
```
    Creates a vTable by aggregating different values from different pvs.
    
    Parameters:
    columns - columns of the table
    
    Returns:
    an expression for the table

Class ExpressionLanguage

Method Summary

Methods inherited from class java.lang.Object

Method Detail

vType

vTypes

vNumber

vNumbers

vDouble

vFloat

vInt

vShort

vByte

vNumberArray

vNumberArrayOf

vFloatArray

vDoubleArray

vByteArray

vShortArray

vIntArray

vString

vStringArray

vEnum

vDoubles

vConst

vConst

vConst

vConst

vConst

vConst

vConst

vDoubleConstants

vIntConstants

vStringConstants

vStringOf

vStringOf

vStringOf

vStringOf

averageOf

statisticsOf

statisticsOf

synchronizedArrayOf

synchronizedArrayOf

timedCacheOf

column

vTable