Table of Contents

Struct Guidance

Namespace
Pamoja.Kit
Assembly
Pamoja.Kit.dll

The command toward a waypoint, with the geometry behind it.

public readonly record struct Guidance : IEquatable<Guidance>
Implements
Inherited Members

Constructors

Guidance(Twist, double, float, bool)

The command toward a waypoint, with the geometry behind it.

public Guidance(Twist Twist, double DistanceM, float HeadingErrorDeg, bool Arrived)

Parameters

Twist Twist

The body motion to drive.

DistanceM double

The distance left to the target, in meters.

HeadingErrorDeg float

The heading error to the target, in degrees, in (-180, 180].

Arrived bool

Whether the target is within the arrival radius.

Properties

Arrived

Whether the target is within the arrival radius.

public bool Arrived { get; init; }

Property Value

bool

DistanceM

The distance left to the target, in meters.

public double DistanceM { get; init; }

Property Value

double

HeadingErrorDeg

The heading error to the target, in degrees, in (-180, 180].

public float HeadingErrorDeg { get; init; }

Property Value

float

Twist

The body motion to drive.

public Twist Twist { get; init; }

Property Value

Twist