libstp::motion::DirectionalLineFollowMotion Class Reference

#include <directional_line_follow_motion.hpp>

Inheritance diagram for libstp::motion::DirectionalLineFollowMotion:

Collaboration diagram for libstp::motion::DirectionalLineFollowMotion:

Public Member Functions
	DirectionalLineFollowMotion (MotionContext ctx, DirectionalLineFollowMotionConfig config)
void	start () override
void	update (double dt) override
bool	isFinished () const override
void	setSensorError (double error)
const std::vector< DirectionalLineFollowMotionTelemetry > &	getTelemetry () const
Public Member Functions inherited from libstp::motion::Motion
	Motion (MotionContext ctx)
virtual	~Motion ()=default

Additional Inherited Members
Protected Member Functions inherited from libstp::motion::Motion
drive::Drive &	drive ()
const drive::Drive &	drive () const
odometry::IOdometry &	odometry ()
const odometry::IOdometry &	odometry () const
Protected Attributes inherited from libstp::motion::Motion
MotionContext	ctx_
bool	started_ {false}

Detailed Description

Definition at line 61 of file directional_line_follow_motion.hpp.

Constructor & Destructor Documentation

DirectionalLineFollowMotion()

libstp::motion::DirectionalLineFollowMotion::DirectionalLineFollowMotion	(	MotionContext	ctx,
		DirectionalLineFollowMotionConfig	config )

Member Function Documentation

getTelemetry()

const std::vector< DirectionalLineFollowMotionTelemetry > & libstp::motion::DirectionalLineFollowMotion::getTelemetry ( ) const

inlinenodiscard

Definition at line 71 of file directional_line_follow_motion.hpp.

isFinished()

bool libstp::motion::DirectionalLineFollowMotion::isFinished ( ) const

nodiscardoverridevirtual

Return true once the primitive has met its completion criteria.

Implements libstp::motion::Motion.

setSensorError()

void libstp::motion::DirectionalLineFollowMotion::setSensorError

(

double

error

)

start()

void libstp::motion::DirectionalLineFollowMotion::start ( )

overridevirtual

Capture initial state and prepare controller internals.

Implements libstp::motion::Motion.

update()

void libstp::motion::DirectionalLineFollowMotion::update ( double dt )

overridevirtual

Advance the controller by one iteration using the loop delta in seconds.

Implements libstp::motion::Motion.

---

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

• /home/runner/work/raccoon-lib/raccoon-lib/modules/libstp-motion/include/motion/directional_line_follow_motion.hpp