org.epics.pvmanager.expression

Class WriteMap<T>

java.lang.Object

org.epics.pvmanager.expression.WriteExpressionListImpl<W>

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

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

Type Parameters:

T - the type for the values in the map

All Implemented Interfaces:

WriteExpression<Map<String,T>>, WriteExpressionList<Map<String,T>>

public class WriteMap<T>
extends WriteExpressionImpl<Map<String,T>>

A write expression for a key/value map.

This expression will take the values from the map and will write them to each child expression matching the key to the name of 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.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
WriteMap() Creates a new group.

Method Summary

Methods

Modifier and Type	Method and Description
WriteMap<T>	add(WriteExpression<T> expression) Adds the expression to the map.
WriteMap<T>	add(WriteExpressionList<T> expressions) Adds the expressions to the map.
WriteMap<T>	clear() Removes all the expressions currently in the map.
void	fillWriteRecipe(PVWriterDirector director, WriteRecipeBuilder builder) Prepares the recipe to connect the channels needed by this expression.
WriteMap<T>	remove(Collection<String> names) Removes the expressions from the map.
WriteMap<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.WriteExpressionImpl

as, getName, getWriteExpressionImpl, getWriteFunction

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

and, getWriteExpressions

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.WriteExpressionList

and, getWriteExpressions

Constructor Detail

WriteMap

public WriteMap()

Creates a new group.

Method Detail

clear

public WriteMap<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 WriteMap<T> add(WriteExpression<T> expression)

Adds the expression to the map.

Parameters:

expression - the expression to be added

Returns:

this expression

add

public WriteMap<T> add(WriteExpressionList<T> expressions)

Adds the expressions to the map.

Parameters:

expressions - the new list of expressions

Returns:

this expression

remove

public WriteMap<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 WriteMap<T> remove(Collection<String> names)

Removes the expressions from the map.

Parameters:

names - the names of the expressions to remove

Returns:

this expression

fillWriteRecipe

public void fillWriteRecipe(PVWriterDirector director,
                   WriteRecipeBuilder builder)

Description copied from interface: WriteExpression

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:

fillWriteRecipe in interface WriteExpression<Map<String,T>>

Overrides:

fillWriteRecipe in class WriteExpressionImpl<Map<String,T>>

Parameters:

director - the director for the reader

builder - the recipe to fill