PHPCoord\GeocentricPoint

Complexity

Total Complexity

8

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

95.83%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getCRS()	0	3	1
A	getX()	0	3	1
A	__toString()	0	3	1
A	getY()	0	3	1
A	getZ()	0	3	1
A	calculateDistance()	0	12	2

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

namespace PHPCoord;

use InvalidArgumentException;
use PHPCoord\CoordinateReferenceSystem\CoordinateReferenceSystem;
use PHPCoord\CoordinateReferenceSystem\Geocentric;
use PHPCoord\CoordinateSystem\Axis;
use PHPCoord\UnitOfMeasure\Length\Length;
use PHPCoord\UnitOfMeasure\Length\Metre;
use PHPCoord\UnitOfMeasure\UnitOfMeasureFactory;

/**
 * Coordinate representing a point in ECEF geocentric form.
 * @author Doug Wright
 */
class GeocentricPoint extends Point
{
    /**
     * X co-ordinate.
     * @var Length
     */
    protected $x;

    /**
     * Y co-ordinate.
     * @var Length
     */
    protected $y;

    /**
     * Z co-ordinate.
     * @var Length
     */
    protected $z;

    /**
     * Coordinate reference system.
     * @var CoordinateReferenceSystem
     */
    protected $crs;

    /**
     * Constructor.
     * @param Length $x refer to CRS for preferred unit of measure, but any length unit accepted
     * @param Length $y refer to CRS for preferred unit of measure, but any length unit accepted
     * @param Length $z refer to CRS for preferred unit of measure, but any length unit accepted
     */
    public function __construct(Length $x, Length $y, Length $z, Geocentric $crs)
    {
        $this->crs = $crs;
        $this->x = UnitOfMeasureFactory::convertLength($x, $this->getAxisByName(Axis::GEOCENTRIC_X)->getUnitOfMeasureId());
        $this->y = UnitOfMeasureFactory::convertLength($y, $this->getAxisByName(Axis::GEOCENTRIC_Y)->getUnitOfMeasureId());
        $this->z = UnitOfMeasureFactory::convertLength($z, $this->getAxisByName(Axis::GEOCENTRIC_Z)->getUnitOfMeasureId());
    }

    public function getX(): Length
    {
        return $this->x;
    }

    public function getY(): Length
    {
        return $this->y;
    }

    public function getZ(): Length
    {
        return $this->z;
    }

    public function getCRS(): CoordinateReferenceSystem
    {
        return $this->crs;
    }

    /**
     * Calculate surface distance between two points.
     * Note: this implementation is currently not accurate over long distances, it is the straight line distance, not
     * the surface distance.
     */
    public function calculateDistance(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 GeocentricPoint $to */
        return new Metre(
            sqrt(
                ($to->getX()->getValue() - $this->x->getValue()) ** 2 +
                ($to->getY()->getValue() - $this->y->getValue()) ** 2 +
                ($to->getZ()->getValue() - $this->z->getValue()) ** 2
            )
        );
    }

    public function __toString(): string
    {
        return "({$this->x}, {$this->y}, {$this->z})";
    }
}