src/libgpx/geographic.php

   1 <?php
   2 /**
   3  * geographic.php
   4  *
   5  * Copyright 2018 Andy Street <andy@street.me.uk>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301, USA.
  21  *
  22  *
  23  */
  24
  25 namespace libgpx;
  26
  27 /**
  28  * Common functions for geographic elements.
  29  *
  30  * @author Andy Street <andy@street.me.uk>
  31  */
  32 interface Geographic
  33 {
  34
  35   /**
  36    * Fetch a bounding box that covers the feature.
  37    *
  38    * @return Bounds|null A bounding box covering the extent of the feature or
  39    *         null if not applicable.
  40    */
  41   public function getBounds();
  42
  43   /**
  44    * Fetch the length of a geographic element.
  45    *
  46    * @return float The length in meters.
  47    */
  48   public function getLength();
  49
  50 }