Field (Protelis Interpreter version 10.1.3 Javadoc API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractField, FieldMapImpl
```
public interface Field
extends Serializable
```
A field is a function associating a collection of devices to values.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSample(DeviceUID n, Object v)` Add a neighbor/value pair to this Field.
`boolean`	`containsNode(DeviceUID n)`
`Iterable<Pair<DeviceUID,Object>>`	`coupleIterator()`
`Class<?>`	`getExpectedType()`
`Object`	`getSample(DeviceUID n)` Get the value associated with a neighbor by this Field.
`boolean`	`isEmpty()`
`Iterable<DeviceUID>`	`nodeIterator()`
`DeviceUID`	`reduceKeys(BinaryOperator<DeviceUID> op, DeviceUID exclude)` Apply an operator to reduce over the set of all devices, selecting a single device.
`Pair<DeviceUID,Object>`	`reducePairs(BinaryOperator<Pair<DeviceUID,Object>> accumulator, DeviceUID exclude)` Apply an operator to reduce over the set of all device/value pairs, selecting a single pair.
`Object`	`reduceVals(BinaryOperator<Object> op, DeviceUID exclude, Object defaultVal)` Apply an operator to reduce over the set of all values, selecting a single value.
`Object`	`removeSample(DeviceUID n)` Remove a neighbor/value pair from this Field.
`int`	`size()`
`Iterable<Object>`	`valIterator()`

- Method Detail
  - addSample
```
void addSample(DeviceUID n,
               Object v)
```
    Add a neighbor/value pair to this Field.
    
    Parameters:
    
    n - Neighbor to add
    
    v - Value associated with the neighbor
  - removeSample
```
Object removeSample(DeviceUID n)
```
    Remove a neighbor/value pair from this Field.
    
    Parameters:
    
    n - Neighbor to remove
    
    Returns:
    
    Value that was associated with this neighbor, null if neighbor was not present
  - getSample
```
Object getSample(DeviceUID n)
```
    Get the value associated with a neighbor by this Field.
    
    Parameters:
    
    n - Neighbor
    
    Returns:
    
    Value that is associated with this neighbor, null if neighbor is not present
  - reduceKeys
```
DeviceUID reduceKeys(BinaryOperator<DeviceUID> op,
                     DeviceUID exclude)
```
    Apply an operator to reduce over the set of all devices, selecting a single device.
    
    Parameters:
    
    op - Order-insensitive operator to reduce devices in pairs
    
    exclude - Device to be excluded (typically self), or null if all devices are to be considered
    
    Returns:
    
    The single device selected by reduction over the set of all devices
  - reduceVals
```
Object reduceVals(BinaryOperator<Object> op,
                  DeviceUID exclude,
                  Object defaultVal)
```
    Apply an operator to reduce over the set of all values, selecting a single value.
    
    Parameters:
    
    op - Order-insensitive operator to reduce values, two at a time, starting with the default
    
    exclude - Device to be excluded (typically self), or null if all devices are to be considered
    
    defaultVal - The value to return if the field contains no devices or only the excluded device
    
    Returns:
    
    The single value created by reduction over the set of all values
  - reducePairs
```
Pair<DeviceUID,Object> reducePairs(BinaryOperator<Pair<DeviceUID,Object>> accumulator,
                                   DeviceUID exclude)
```
    Apply an operator to reduce over the set of all device/value pairs, selecting a single pair.
    
    Parameters:
    
    accumulator - Order-insensitive operator to reduce pairs, two at a time, starting with the default
    
    exclude - Device to be excluded (typically self), or null if all devices are to be considered
    
    Returns:
    
    The single pair selected by reduction over the set of all pairs
  - nodeIterator
```
Iterable<DeviceUID> nodeIterator()
```
    Returns:
    
    An iterator over the set of neighbors.
  - valIterator
```
Iterable<Object> valIterator()
```
    Returns:
    
    An iterator over the set of neighbor values.
  - coupleIterator
```
Iterable<Pair<DeviceUID,Object>> coupleIterator()
```
    Returns:
    
    An iterator over the set of neighbor/value pairs
  - size
```
int size()
```
    Returns:
    
    Number of neighbors with values in the field
  - isEmpty
```
boolean isEmpty()
```
    Returns:
    
    True if there are no neighbors
  - containsNode
```
boolean containsNode(DeviceUID n)
```
    Parameters:
    
    n - The device being checked for
    
    Returns:
    
    True if n is contained in this field
  - getExpectedType
```
Class<?> getExpectedType()
```
    Returns:
    
    The type of the values of this field

Interface Field

Method Summary

Method Detail

addSample

removeSample

getSample

reduceKeys

reduceVals

reducePairs

nodeIterator

valIterator

coupleIterator

size

isEmpty

containsNode

getExpectedType