distance.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Kilian Volmer, Rene Schmiedling
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_GEOGRAPHY_DISTANCE_H
#define MIO_GEOGRAPHY_DISTANCE_H
 
#include "memilio/config.h"
#include "memilio/io/default_serialize.h"
 
namespace mio
{
 
namespace geo
{
 
class Distance
{
public:
    Distance() = default;
    explicit constexpr Distance(ScalarType meters)
        : m_meters(meters)
    {
    }
 
    ScalarType kilometers() const
    {
        return ScalarType(m_meters) / 1000;
    }
 
    ScalarType meters() const
    {
        return m_meters;
    }
 
    bool operator==(const Distance& other) const
    {
        return m_meters == other.m_meters;
    }
    bool operator!=(const Distance& other) const
    {
        return !(*this == other);
    }
    bool operator<(const Distance& other) const
    {
        return m_meters < other.m_meters;
    }
    bool operator<=(const Distance& other) const
    {
        return m_meters <= other.m_meters;
    }
    bool operator>(const Distance& other) const
    {
        return m_meters > other.m_meters;
    }
    bool operator>=(const Distance& other) const
    {
        return m_meters >= other.m_meters;
    }
    Distance operator+(const Distance& m) const
    {
        return Distance{m_meters + m.meters()};
    }
    Distance& operator+=(const Distance& m)
    {
        m_meters += m.meters();
        return *this;
    }
    Distance operator-(const Distance& m) const
    {
        return Distance{m_meters - m.meters()};
    }
    Distance& operator-=(const Distance& m)
    {
        m_meters -= m.meters();
        return *this;
    }
    auto default_serialize()
    {
        return Members("Distance").add("meters", m_meters);
    }
 
private:
    ScalarType m_meters; 
};
 
constexpr inline Distance meters(ScalarType meters)
{
    return Distance(meters);
}
 
constexpr inline Distance kilometers(ScalarType kilometers)
{
    return Distance(kilometers * 1000);
}
 
} // namespace geo
} // namespace mio
 
#endif // MIO_GEOGRAPHY_DISTANCE_H