Fang-Robotics-MCB
Fang Robotics Team Codebase
Loading...
Searching...
No Matches
Public Member Functions | List of all members
trap::algorithms::RingRadians Class Reference

#include <ring_radians.hpp>

Inheritance diagram for trap::algorithms::RingRadians:
Inheritance graph
[legend]
Collaboration diagram for trap::algorithms::RingRadians:
Collaboration graph
[legend]

Public Member Functions

 RingRadians ()
 
Radians operator- (const WrappedRadians &other) const
 
 WrappedRadians (const Radians &value)
 
 WrappedRadians (double value)
 
 WrappedRadians (const WrappedFloat< Radians > &value)
 
- Public Member Functions inherited from trap::algorithms::WrappedRadians
 WrappedRadians (const Radians &value)
 
 WrappedRadians (double value)
 
 WrappedRadians (const WrappedFloat< Radians > &value)
 
- Public Member Functions inherited from trap::algorithms::WrappedFloat< Radians >
 WrappedFloat (Radians value, Radians lowerBound, Radians upperBound)
 
 WrappedFloat (const tap::algorithms::WrappedFloat &wrappedFloat)
 
bool operator== (const WrappedFloat &other) const
 
void operator+= (const WrappedFloat &other)
 
void operator-= (const WrappedFloat &other)
 
WrappedFloat operator+ (const WrappedFloat &other) const
 
WrappedFloat operator- (const WrappedFloat &other) const
 
Radians minDifference (const WrappedFloat &other) const
 
Radians minDifference (const Radians &unwrappedValue) const
 
void shiftBounds (Radians shiftMagnitude)
 
bool withinRange (const WrappedFloat &lowerBound, const WrappedFloat upperBound) const
 
Radians getUnwrappedValue () const
 
Radians getWrappedValue () const
 
void setWrappedValue (const Radians &newValue)
 
void setUnwrappedValue (const Radians &newValue)
 
WrappedFloat getNormalized () const
 
int getRevolutions () const
 
Radians getUpperBound () const
 
Radians getLowerBound () const
 
 operator double () const
 
 operator Radians () const
 

Additional Inherited Members

- Public Types inherited from trap::algorithms::WrappedFloat< Radians >
using TappedFloat = tap::algorithms::WrappedFloat
 
- Static Public Member Functions inherited from trap::algorithms::WrappedFloat< Radians >
static Radians limitValue (const WrappedFloat &valueToLimit, const Radians min, const Radians max, int *status)
 
static Radians limitValue (const WrappedFloat &valueToLimit, const WrappedFloat &min, const WrappedFloat &max, int *status)
 
static Radians rangeOverlap (const WrappedFloat &lowerA, const WrappedFloat &upperA, const WrappedFloat &lowerB, const WrappedFloat &upperB)
 
- Static Public Attributes inherited from trap::algorithms::WrappedRadians
static constexpr double k_pi {M_PI}
 
static constexpr double k_tau {M_PI * 2}
 

Detailed Description

This allows interfacing with general pid classes when utilizing rotations

All this does is override operator- to use minDifference which is more suitable for pid

Constructor & Destructor Documentation

◆ RingRadians()

trap::algorithms::RingRadians::RingRadians ( )
inline

Member Function Documentation

◆ operator-()

Radians trap::algorithms::RingRadians::operator- ( const WrappedRadians &  other) const
inline

◆ WrappedRadians() [1/3]

trap::algorithms::WrappedRadians::WrappedRadians ( const Radians &  value)

◆ WrappedRadians() [2/3]

trap::algorithms::WrappedRadians::WrappedRadians ( const WrappedFloat< Radians > &  value)

◆ WrappedRadians() [3/3]

trap::algorithms::WrappedRadians::WrappedRadians ( double  value)
The documentation for this class was generated from the following file: