org.epics.pvmanager.expression

Class ReadMap<T>

java.lang.Object

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

org.epics.pvmanager.expression.DesiredRateExpressionImpl<Map<String,T>>

org.epics.pvmanager.expression.ReadMap<T>

Type Parameters:

T - the type for the values in the map

All Implemented Interfaces:

DesiredRateExpression<Map<String,T>>, DesiredRateExpressionList<Map<String,T>>

public class ReadMap<T>
extends DesiredRateExpressionImpl<Map<String,T>>

A read expression for a key/value map.

This expression returns a map where the key is the name of the child expression and the value is the value returned by the child expression. The map is dynamic: the child expressions can be added and removed while the reader is active.

There is currently no way to retrieve the individual errors for each element of the map. If the value is a VType, the connection can be retrieved by looking at the alarm.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ReadMap() Creates a new group.

Method Summary

Methods

Modifier and Type	Method and Description
ReadMap<T>	add(DesiredRateExpression<T> expression) Adds the expression to the map.
ReadMap<T>	add(DesiredRateExpressionList<T> expressions) Adds the expressions to the map.
ReadMap<T>	clear() Removes all the expressions currently in the map.
void	fillReadRecipe(PVDirector director, ReadRecipeBuilder builder) Prepares the recipe to connect the channels needed by this expression.
ReadMap<T>	remove(Collection<String> names) Removes the expressions from the map.
ReadMap<T>	remove(String name) Removes the expression with the given name.
int	size() Returns the number of expressions in the group.

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

as, getDesiredRateExpressionImpl, getFunction, getName

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

ReadMap

public ReadMap()

Creates a new group.

Method Detail

clear

public ReadMap<T> clear()

Removes all the expressions currently in the map.

Returns:

this expression

size

public int size()

Returns the number of expressions in the group.

Returns:

number of expressions in the group

add

public ReadMap<T> add(DesiredRateExpression<T> expression)

Adds the expression to the map.

Parameters:

expression - the expression to be added

Returns:

this expression

add

public ReadMap<T> add(DesiredRateExpressionList<T> expressions)

Adds the expressions to the map.

Parameters:

expressions - the new list of expressions

Returns:

this expression

remove

public ReadMap<T> remove(String name)

Removes the expression with the given name.

Parameters:

name - the name of the expression to remove

Returns:

this expression

remove

public ReadMap<T> remove(Collection<String> names)

Removes the expressions from the map.

Parameters:

names - the names of the expressions to remove

Returns:

this expression

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<Map<String,T>>

Overrides:

fillReadRecipe in class DesiredRateExpressionImpl<Map<String,T>>

Parameters:

director - the director for the reader

builder - the recipe to fill