Program Listing for File odometry_2d_interface.hpp

↰ Return to documentation for file (src/tap/algorithms/odometry/odometry_2d_interface.hpp)

/*
 * Copyright (c) 2020-2021 Advanced Robotics at the University of Washington <robomstr@uw.edu>
 *
 * This file is part of Taproot.
 *
 * Taproot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Taproot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Taproot.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef TAPROOT_ODOMETRY_2D_INTERFACE_HPP_
#define TAPROOT_ODOMETRY_2D_INTERFACE_HPP_

// Include instead of forward declare because template uses default arguments
#include "modm/math/geometry/location_2d.hpp"

namespace tap::algorithms::odometry
{
class Odometry2DInterface
{
public:
    virtual modm::Location2D<float> getCurrentLocation2D() const = 0;

    virtual modm::Vector2f getCurrentVelocity2D() const = 0;

    virtual float getYaw() const = 0;

    virtual uint32_t getLastComputedOdometryTime() const = 0;
};

}  // namespace tap::algorithms::odometry

#endif  // TAPROOT_ODOMETRY_2D_INTERFACE_HPP_