local_frame_dynamics_control.hpp

/****************************************************************************
 *
 * Copyright 2023 Auterion AG. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#pragma once
 
#include <eigen3/Eigen/Eigen>
#include <functional>
#include <memory>
#include <variant>
 
#include "../../auterion.hpp"
 
namespace auterion {
namespace multicopter {
class LocalFrameDynamicsSetpoint {
   private:
    Eigen::Vector3f _velocity_local_enu_m_s = {NAN, NAN, NAN};
    Eigen::Vector3f _acceleration_local_enu_m_s2 = {NAN, NAN, NAN};
    float _heading_rad = NAN;
    float _heading_rate_rad_s = NAN;
 
   public:
    class Config {};
 
    LocalFrameDynamicsSetpoint() = default;
 
    inline Eigen::Vector3f getVelocity() const { return _velocity_local_enu_m_s; }
 
    inline Eigen::Vector3f getAcceleration() const { return _acceleration_local_enu_m_s2; }
 
    inline float getHeading() const { return _heading_rad; }
 
    inline float getHeadingRate() const { return _heading_rate_rad_s; }
 
    inline LocalFrameDynamicsSetpoint& withAcceleration(
        const Eigen::Vector3f& acceleration_local_enu_m_s2) {
        _acceleration_local_enu_m_s2 = acceleration_local_enu_m_s2;
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withHorizontalAcceleration(
        const Eigen::Vector2f& acceleration_local_enu_m_s2) {
        _acceleration_local_enu_m_s2.x() = acceleration_local_enu_m_s2.x();
        _acceleration_local_enu_m_s2.y() = acceleration_local_enu_m_s2.y();
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withVerticalAcceleration(float acceleration_local_enu_m_s2) {
        _acceleration_local_enu_m_s2.z() = acceleration_local_enu_m_s2;
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withVelocity(const Eigen::Vector3f& velocity_local_enu_m_s) {
        _velocity_local_enu_m_s = velocity_local_enu_m_s;
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withHorizontalVelocity(
        const Eigen::Vector2f& velocity_local_enu_m_s) {
        _velocity_local_enu_m_s.x() = velocity_local_enu_m_s.x();
        _velocity_local_enu_m_s.y() = velocity_local_enu_m_s.y();
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withVerticalVelocity(float velocity_local_enu_m_s) {
        _velocity_local_enu_m_s.z() = velocity_local_enu_m_s;
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withHeading(float heading_rad) {
        _heading_rad = heading_rad;
        return *this;
    }
 
    inline LocalFrameDynamicsSetpoint& withHeadingRate(float heading_rate_rad_s) {
        _heading_rate_rad_s = heading_rate_rad_s;
        return *this;
    }
};
 
}  // namespace multicopter
}  // namespace auterion