Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
ROS2::VehicleDynamics::AckermannModelLimits Class Reference

A structure holding limits of vehicle, including speed and steering limits. More...

#include <AckermannModelLimits.h>

Inherits ROS2::VehicleDynamics::VehicleModelLimits.

Public Member Functions

 AZ_RTTI (AckermannModelLimits, "{796928D9-436F-472D-B841-E67F28F9CC82}", VehicleModelLimits)
 
VehicleInputs LimitState (const VehicleInputs &inputState) const
 
VehicleInputs GetMaximumState () const
 
float GetLinearAcceleration () const
 
float GetLinearSpeedLimit () const
 
- Public Member Functions inherited from ROS2::VehicleDynamics::VehicleModelLimits
 AZ_RTTI (VehicleModelLimits, "{76DA392D-64BB-45A8-BC90-84AAE7901991}")
 
virtual VehicleInputs LimitState (const VehicleInputs &inputState) const =0
 
virtual VehicleInputs GetMaximumState () const =0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from ROS2::VehicleDynamics::VehicleModelLimits
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Static Protected Member Functions inherited from ROS2::VehicleDynamics::VehicleModelLimits
static float LimitValue (float value, float absoluteLimit)
 

Detailed Description

A structure holding limits of vehicle, including speed and steering limits.

Member Function Documentation

◆ GetMaximumState()

VehicleInputs ROS2::VehicleDynamics::AckermannModelLimits::GetMaximumState ( ) const
virtual

Returns maximal permissible input states.

Returns
VehicleInputsState

Implements ROS2::VehicleDynamics::VehicleModelLimits.

◆ LimitState()

VehicleInputs ROS2::VehicleDynamics::AckermannModelLimits::LimitState ( const VehicleInputs &  inputState) const
virtual

Limit input state to values that are possible for model.

Parameters
inputStateInput state to filter.
Returns
Filtered, pruned state.

Implements ROS2::VehicleDynamics::VehicleModelLimits.

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