Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
position_setpoint_common.hpp
1/****************************************************************************
2 *
3 * Copyright 2026 Auterion AG. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 ****************************************************************************/
32
33#pragma once
34
35#include <optional>
36
37namespace auterion {
38namespace surface_vehicle {
39namespace detail {
40
47template <typename Derived>
49 public:
54 Derived& withDefaultCruisingSpeed(float cruising_speed_m_s) {
55 _default_cruising_speed_m_s = cruising_speed_m_s;
56 return static_cast<Derived&>(*this);
57 }
58
63 Derived& withDefaultArrivalSpeed(float arrival_speed_m_s) {
64 _default_arrival_speed_m_s = arrival_speed_m_s;
65 return static_cast<Derived&>(*this);
66 }
67
68 inline std::optional<float> getDefaultCruisingSpeed() const {
69 return _default_cruising_speed_m_s;
70 }
71 inline float getDefaultArrivalSpeed() const { return _default_arrival_speed_m_s; }
72
73 private:
74 std::optional<float> _default_cruising_speed_m_s{};
75 float _default_arrival_speed_m_s{0.f};
76};
77
81template <typename Derived>
83 public:
89 Derived& withCruisingSpeed(float cruising_speed_m_s) {
90 _cruising_speed_m_s = cruising_speed_m_s;
91 return static_cast<Derived&>(*this);
92 }
93
100 Derived& withArrivalSpeed(float arrival_speed_m_s) {
101 _arrival_speed_m_s = arrival_speed_m_s;
102 return static_cast<Derived&>(*this);
103 }
104
105 inline std::optional<float> getCruisingSpeed() const { return _cruising_speed_m_s; }
106 inline std::optional<float> getArrivalSpeed() const { return _arrival_speed_m_s; }
107
108 private:
109 std::optional<float> _cruising_speed_m_s{};
110 std::optional<float> _arrival_speed_m_s{};
111};
112
113} // namespace detail
114} // namespace surface_vehicle
115} // namespace auterion
Mode-wide defaults shared by the surface vehicle position setpoint types.
Definition position_setpoint_common.hpp:48
Derived & withDefaultArrivalSpeed(float arrival_speed_m_s)
Sets the default speed the vehicle has when it reaches the target [m/s]. Default is 0,...
Definition position_setpoint_common.hpp:63
Derived & withDefaultCruisingSpeed(float cruising_speed_m_s)
Sets the default cruising speed [m/s]. Negative drives to the target in reverse. Unset means the vehi...
Definition position_setpoint_common.hpp:54
Speed settings shared by the surface vehicle position setpoint types.
Definition position_setpoint_common.hpp:82
Derived & withCruisingSpeed(float cruising_speed_m_s)
Sets the speed to drive at on the way to the target [m/s].
Definition position_setpoint_common.hpp:89
Derived & withArrivalSpeed(float arrival_speed_m_s)
Sets the speed the vehicle has when it reaches the target [m/s].
Definition position_setpoint_common.hpp:100