Package repast.simphony.valueLayer

Interface ValueLayer

All Known Subinterfaces:
IGridValueLayer
All Known Implementing Classes:
BufferedGridValueLayer, ContinuousValueLayer, GridValueLayer
public interface ValueLayer
Interface for classes that produce some numeric value when given spatial coordinates. For example, a grid value layer may have a value in each grid cell and would return the value of the cell at the specified coordinates. Alternatively, a function type ValueLayer would take the coordinates and return some value based on a function.
Version:
$Revision$ $Date$
Author:
Nick Collier

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    get(double... coordinates)
    Gets a value given the specified coordinates.
    Dimensions
    getDimensions()
    Gets the dimensions of this ValueLayer.
    String
    getName()
    Gets the name of this ValueLayer.

  • Method Details

    • getName

      String getName()
      Gets the name of this ValueLayer.
      Returns:
      the name of this ValueLayer.

    • get

      double get(double... coordinates)
      Gets a value given the specified coordinates.
      Parameters:
      coordinates - the coordinates used to return the value.
      Returns:
      a value given the specified coordinates.

    • getDimensions

      Dimensions getDimensions()
      Gets the dimensions of this ValueLayer.
      Returns:
      the dimensions of this ValueLayer.