PHPCoord\WestingSouthingPoint

Complexity

Total Complexity

9

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	calculateSurfaceDistance()	0	11	2
A	__construct()	0	5	1
A	getSouthing()	0	3	1
A	__toString()	0	14	4
A	getWesting()	0	3	1

<?php
/**
 * PHPCoord.
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace PHPCoord;

use PHPCoord\CoordinateReferenceSystem\Projected;
use PHPCoord\CoordinateSystem\Axis;
use PHPCoord\Exception\UnknownAxisException;
use PHPCoord\UnitOfMeasure\Length\Length;
use PHPCoord\UnitOfMeasure\Length\Metre;
use PHPCoord\UnitOfMeasure\UnitOfMeasureFactory;

/**
 * Coordinate representing a point on a map projection.
 * @author Doug Wright
 */
class WestingSouthingPoint extends ProjectedPoint
{
    /**
     * Westing.
     * @var Length
     */
    protected $westing;

    /**
     * Southing.
     * @var Length
     */
    protected $southing;

    /**
     * Constructor.
     * @param Length $westing refer to CRS for preferred unit of measure, but any length unit accepted
     */
    public function __construct(Length $westing, Length $northing, Projected $crs)
    {
        parent::__construct($crs);
        $this->westing = UnitOfMeasureFactory::convertLength($westing, $this->getAxisByName(Axis::WESTING)->getUnitOfMeasureId());
        $this->southing = UnitOfMeasureFactory::convertLength($northing, $this->getAxisByName(Axis::SOUTHING)->getUnitOfMeasureId());
    }

    public function getWesting(): Length
    {
        return $this->westing;
    }

    public function getSouthing(): Length
    {
        return $this->southing;
    }

    /**
     * Calculate distance between two points.
     * Because this is a simple grid, we can use Pythagoras.
     */
    public function calculateSurfaceDistance(Point $to): Length
    {
        if ($to->getCRS()->getEpsgCode() !== $this->crs->getEpsgCode()) {
            throw new \InvalidArgumentException('Can only calculate distances between two points in the same CRS');
        }

        /* @var WestingSouthingPoint $to */
        return new Metre(
            sqrt(
                ($to->getWesting()->getValue() - $this->getWesting()->getValue()) ** 2 +
                ($to->getSouthing()->getValue() - $this->getSouthing()->getValue()) ** 2
            )
        );
    }

    public function __toString(): string
    {
        $values = [];
        foreach ($this->getCRS()->getCoordinateSystem()->getAxes() as $axis) {
            if ($axis->getName() === Axis::WESTING) {
                $values[] = $this->westing;
            } elseif ($axis->getName() === Axis::SOUTHING) {
                $values[] = $this->southing;
            } else {
                throw new UnknownAxisException(); // @codeCoverageIgnore
            }
        }

        return '(' . implode(', ', $values) . ')';
    }
}