swarmsim.metrics.DistanceToGoal
===============================

.. currentmodule:: swarmsim.metrics

.. autoclass:: DistanceToGoal

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~DistanceToGoal.__init__
      ~DistanceToGoal.as_config_dict
      ~DistanceToGoal.attach_world
      ~DistanceToGoal.calc_dist_to_goal
      ~DistanceToGoal.calculate
      ~DistanceToGoal.draw
      ~DistanceToGoal.out_average
      ~DistanceToGoal.out_current
      ~DistanceToGoal.reset
      ~DistanceToGoal.set_value
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~DistanceToGoal.average
      ~DistanceToGoal.instantaneous
      ~DistanceToGoal.value