Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
auterion::surface_vehicle::detail::PositionSetpointSpeedsBase< Derived > Class Template Reference

Speed settings shared by the surface vehicle position setpoint types. More...

#include <auterion_sdk/control/surface_vehicle/position_setpoint_common.hpp>

Public Member Functions

Derived & withCruisingSpeed (float cruising_speed_m_s)
 Sets the speed to drive at on the way to the target [m/s].
 
Derived & withArrivalSpeed (float arrival_speed_m_s)
 Sets the speed the vehicle has when it reaches the target [m/s].
 
std::optional< float > getCruisingSpeed () const
 
std::optional< float > getArrivalSpeed () const
 

Detailed Description

template<typename Derived>
class auterion::surface_vehicle::detail::PositionSetpointSpeedsBase< Derived >

Speed settings shared by the surface vehicle position setpoint types.

Member Function Documentation

◆ withArrivalSpeed()

template<typename Derived >
Derived & auterion::surface_vehicle::detail::PositionSetpointSpeedsBase< Derived >::withArrivalSpeed ( float  arrival_speed_m_s)
inline

Sets the speed the vehicle has when it reaches the target [m/s].

This is a magnitude: the sign is ignored, the direction of travel comes from the cruising speed. Use a value above 0 to pass through waypoints without stopping.

◆ withCruisingSpeed()

template<typename Derived >
Derived & auterion::surface_vehicle::detail::PositionSetpointSpeedsBase< Derived >::withCruisingSpeed ( float  cruising_speed_m_s)
inline

Sets the speed to drive at on the way to the target [m/s].

A negative value drives to the target in reverse (stern first).


The documentation for this class was generated from the following file: