org.diirt.datasource.expression

Interface DesiredRateExpression<R>

Type Parameters:

R - type of the read payload

All Superinterfaces:

DesiredRateExpressionList<R>

All Known Subinterfaces:

DesiredRateReadWriteExpression<R,W>, Graph2DExpression<T>

All Known Implementing Classes:

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

public interface DesiredRateExpression<R>
extends DesiredRateExpressionList<R>

An expression to read at the desired rate.

Don't implement objects with this interface, use DesiredRateExpressionImpl.

Author:

carcassi

Method Summary

Modifier and Type	Method and Description
DesiredRateExpression<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 of this expression.
ReadFunction<R>	getFunction() The function that calculates this expression.
String	getName() Name of this expression.

Methods inherited from interface org.diirt.datasource.expression.DesiredRateExpressionList

and, getDesiredRateExpressions

Method Detail

as

DesiredRateExpression<R> as(String name)

Changes the name for this expression

Parameters:

name - new name

Returns:

this

getName

String getName()

Name of this expression.

Returns:

the expression name

fillReadRecipe

void fillReadRecipe(PVDirector director,
                    ReadRecipeBuilder builder)

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.

Parameters:

director - the director for the reader

builder - the recipe to fill

getFunction

ReadFunction<R> getFunction()

The function that calculates this expression.

Returns:

the expression function

getDesiredRateExpressionImpl

DesiredRateExpressionImpl<R> getDesiredRateExpressionImpl()

The implementation of this expression.

Returns:

the implementation