Package dev.narlyx.tweetybird.Odometers

Class ThreeWheeled

java.lang.Object

dev.narlyx.tweetybird.Odometers.ThreeWheeled

All Implemented Interfaces:

TweetyBird.Odometer

public class ThreeWheeled
extends Object
implements TweetyBird.Odometer

This is an example odometer for the common three wheel odometer setup.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThreeWheeled.Builder	Used to configure and start the odometer.

Constructor Summary

Constructors

Constructor	Description
ThreeWheeled(ThreeWheeled.Builder builder)	Constructor used to setup all variables from builder.

Method Summary

Modifier and Type	Method	Description
double	getX()	Returns estimated X (lateral) coordinate.
double	getY()	Returns estimated Y (axial) coordinate.
double	getZ()	Returns estimated Z (yaw) coordinate.
void	resetTo(double x, double y, double z)	Will reset the estimated position based on imputed values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThreeWheeled

public ThreeWheeled(ThreeWheeled.Builder builder)

Constructor used to setup all variables from builder.

Parameters:

builder - Passed builder

Method Details

getX

public double getX()

Returns estimated X (lateral) coordinate.

Specified by:

getX in interface TweetyBird.Odometer

Returns:

Unit of measurement

getY

public double getY()

Returns estimated Y (axial) coordinate.

Specified by:

getY in interface TweetyBird.Odometer

Returns:

Unit of measurement

getZ

public double getZ()

Returns estimated Z (yaw) coordinate.

Specified by:

getZ in interface TweetyBird.Odometer

Returns:

Unit of measurement

resetTo

public void resetTo(double x,
 double y,
 double z)

Will reset the estimated position based on imputed values.

Specified by:

resetTo in interface TweetyBird.Odometer

Parameters:

x - Lateral unit of measurement

y - Axial unit of measurement

z - Yaw unit of measurement