org.epics.pvmanager
Class DesiredRateExpression<T>

java.lang.Object
  extended by org.epics.pvmanager.DesiredRateExpression<T>
Type Parameters:
T - type of the expression output

public class DesiredRateExpression<T>
extends java.lang.Object

An expression that represents a PV that is read at the UI scan rate. Objects of this class are not created directly but through the operators defined in ExpressionLanguage.

Author:
carcassi

Constructor Summary
DesiredRateExpression(DesiredRateExpression<?> expression, Function<T> function, java.lang.String defaultName)
          Creates a new aggregated expression.
DesiredRateExpression(java.util.List<DesiredRateExpression<?>> childExpressions, Function<T> function, java.lang.String defaultName)
          Creates a new aggregated expression.
DesiredRateExpression(SourceRateExpression<?> expression, Function<T> collector, java.lang.String defaultName)
          Creates a new expression at the desired rate.
 
Method Summary
 DataRecipe getDataRecipe()
          The recipe for connect the channels for this expression.
 java.lang.String getDefaultName()
          The default name for a PV of this expression.
 Function<T> getFunction()
          The function that calculates new values for this expression.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DesiredRateExpression

public DesiredRateExpression(SourceRateExpression<?> expression,
                             Function<T> collector,
                             java.lang.String defaultName)
Creates a new expression at the desired rate. Use this constructor when making an DesiredRateExpression out of a collector and a SourceRateExpression.

Parameters:
expression - the original source rate expression
collector - the collector for the original source
defaultName - the display name of the expression

DesiredRateExpression

public DesiredRateExpression(DesiredRateExpression<?> expression,
                             Function<T> function,
                             java.lang.String defaultName)
Creates a new aggregated expression. Use this constructor when making a DesiredRateExpression that is a function of another DesiredRateExpression.

Parameters:
expression - the expression for the argument of the function
function - the function to calculate the new expression
defaultName - the name of the expression

DesiredRateExpression

public DesiredRateExpression(java.util.List<DesiredRateExpression<?>> childExpressions,
                             Function<T> function,
                             java.lang.String defaultName)
Creates a new aggregated expression. Use this constructor when making a DesiredRateExpression that is a function of a number of DesiredRateExpressions.

Parameters:
childExpressions - expressions for the arguments of the function
function - the function that calculates the value of the new expression
defaultName - the display name of the expression
Method Detail

getDefaultName

public java.lang.String getDefaultName()
The default name for a PV of this expression.

Returns:
the default name

getDataRecipe

public DataRecipe getDataRecipe()
The recipe for connect the channels for this expression.

Returns:
a data recipe

getFunction

public Function<T> getFunction()
The function that calculates new values for this expression.

Returns:
a function


Copyright © 2011. All Rights Reserved.