==================
Calculate Distance
==================

Module calculates
the distance form the lead view feature to every other feature in the distance view.

Parameter
---------

+-----------------------+------------------------+------------------------------------------------------------------------+
|        Name           |          Type          |       Description                                                      |
+=======================+========================+========================================================================+
|lead_view_name         | STRING                 | lead view name                                                         |
+-----------------------+------------------------+------------------------------------------------------------------------+
|distance_view_name     | STRING                 | view to which the distance is calculated                               |
+-----------------------+------------------------+------------------------------------------------------------------------+
|attribute_name         | DOUBLE                 | sum of the distances of the current feature to every other feature     |
+-----------------------+------------------------+------------------------------------------------------------------------+


Data-stream
-----------

+--------------------+---------------------------+------------------+-------+------------------------------------------+
|        View        |          Attribute        |       Type       |Access |    Description                           |
+====================+===========================+==================+=======+==========================================+
| lead_view_name     |                           | NODE, EDGE, FACE | read  |                                          |
+--------------------+---------------------------+------------------+-------+------------------------------------------+
|                    | attribute_name            | DOUBLE           | write |                                          |
+--------------------+---------------------------+------------------+-------+------------------------------------------+
|                    |                           |                  |       |                                          |
+--------------------+---------------------------+------------------+-------+------------------------------------------+
| distance_view_name |                           | NODE, EDGE, FACE | read  |                                          |
+--------------------+---------------------------+------------------+-------+------------------------------------------+

Module Name
-----------

:index:`DM_CalculateDistance <GDALModules; DM_CalculateDistance | Calculate distance>`

Sample Code for Python Simulation
---------------------------------
.. code-block:: python

    distance = sim.add_module('DM_CalculateDistance',
                              {'lead_view_name': 'parcel',
                               'distance_view_name': 'highway',
                               'attribute_name': 'distance'},
                                parcel)
..