autoware::drivers::vehicle_interface::Limits< T > Class Template Reference

#include <safety_state_machine.hpp>

Public Member Functions
	Limits (T min, T max, T threshold)
T	min () const noexcept
T	max () const noexcept
T	threshold () const noexcept
bool8_t	clamp_warn (T &value) const noexcept
	Clamps value to max/min range; return true if value is threshold past limits. More...

Detailed Description

template<typename T>
class autoware::drivers::vehicle_interface::Limits< T >

A simple class representing 1D limits and a threshold value for when something is considered warning worthy.

Constructor & Destructor Documentation

Limits()

template<typename T>

autoware::drivers::vehicle_interface::Limits< T >::Limits ( T  min, T  max, T  threshold  )

inline

Constructor

Exceptions

std::domain_error

if min >= max

Member Function Documentation

clamp_warn()

template<typename T>

bool8_t autoware::drivers::vehicle_interface::Limits< T >::clamp_warn ( T &  value ) const

inlinenoexcept

Clamps value to max/min range; return true if value is threshold past limits.

max()

template<typename T>

T autoware::drivers::vehicle_interface::Limits< T >::max ( ) const

inlinenoexcept

min()

template<typename T>

T autoware::drivers::vehicle_interface::Limits< T >::min ( ) const

inlinenoexcept

threshold()

template<typename T>

T autoware::drivers::vehicle_interface::Limits< T >::threshold ( ) const

inlinenoexcept

---

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

• safety_state_machine.hpp