org.epics.pvmanager.expression

Class DesiredRateExpressionImpl<R>

java.lang.Object

org.epics.pvmanager.expression.DesiredRateExpressionListImpl<R>

org.epics.pvmanager.expression.DesiredRateExpressionImpl<R>

Type Parameters:

R - type of the read payload

All Implemented Interfaces:

DesiredRateExpression<R>, DesiredRateExpressionList<R>

Direct Known Subclasses:

BubbleGraph2DExpression, Cache, DynamicGroup, HistogramGraph2DExpression, IntensityGraph2DExpression, LineGraph2DExpression, MultiAxisLineGraph2DExpression, MultilineGraph2DExpression, Queue, ReadMap, ScatterGraph2DExpression, SparklineGraph2DExpression, WaterfallPlot

public class DesiredRateExpressionImpl<R>
extends DesiredRateExpressionListImpl<R>
implements DesiredRateExpression<R>

Implementation class for DesiredRateExpression.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
DesiredRateExpressionImpl(DesiredRateExpressionList<?> childExpressions, ReadFunction<R> function, String defaultName) Creates a new aggregated expression.
DesiredRateExpressionImpl(SourceRateExpression<?> expression, Collector<?,R> collector, String defaultName) Creates a new expression at the desired rate.

Method Summary

Methods

Modifier and Type	Method and Description
DesiredRateExpressionImpl<R>	as(String name) Changes the name for this expression
void	fillReadRecipe(PVDirector director, ReadRecipeBuilder builder) Prepares the recipe to connect the channels needed by this expression.
DesiredRateExpressionImpl<R>	getDesiredRateExpressionImpl() The implementation for this expression.
ReadFunction<R>	getFunction() The function that calculates new values for this expression.
String	getName() The default name for a PV of this expression.

Methods inherited from class org.epics.pvmanager.expression.DesiredRateExpressionListImpl

and, getDesiredRateExpressions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.epics.pvmanager.expression.DesiredRateExpressionList

and, getDesiredRateExpressions

Constructor Detail

DesiredRateExpressionImpl

public DesiredRateExpressionImpl(SourceRateExpression<?> expression,
                         Collector<?,R> collector,
                         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

DesiredRateExpressionImpl

public DesiredRateExpressionImpl(DesiredRateExpressionList<?> childExpressions,
                         ReadFunction<R> function,
                         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

as

public final DesiredRateExpressionImpl<R> as(String name)

Description copied from interface: DesiredRateExpression

Changes the name for this expression

Specified by:

as in interface DesiredRateExpression<R>

Parameters:

name - new name

Returns:

this

getName

public final String getName()

The default name for a PV of this expression.

Specified by:

getName in interface DesiredRateExpression<R>

Returns:

the default name

fillReadRecipe

public void fillReadRecipe(PVDirector director,
                  ReadRecipeBuilder builder)

Description copied from interface: DesiredRateExpression

Prepares the recipe to connect the channels needed by this expression.

A dynamic expression, one for which the child expressions can change, can keep a reference to the director to connect/disconnect new child expressions.

Specified by:

fillReadRecipe in interface DesiredRateExpression<R>

Parameters:

director - the director for the reader

builder - the recipe to fill

getFunction

public final ReadFunction<R> getFunction()

The function that calculates new values for this expression.

Specified by:

getFunction in interface DesiredRateExpression<R>

Returns:

a function

getDesiredRateExpressionImpl

public final DesiredRateExpressionImpl<R> getDesiredRateExpressionImpl()

The implementation for this expression.

Specified by:

getDesiredRateExpressionImpl in interface DesiredRateExpression<R>

Returns:

returns the implementation for this desired rate