cajun::guide_mode_t Class Reference

Abstract base class for providing guide data (heading error, desired_heading, etc). More...

#include <guide_mode.H>

Inheritance diagram for cajun::guide_mode_t:

List of all members.

Public Member Functions
virtual	~guide_mode_t ()
virtual void	guide (guide_data_t &gd, const uniform_path_t &goal_data, unsigned goal_index, double x, double y, double heading, double speed, bool valid_path, bool forward, bool tight_path, double tstamp)=0
Protected Member Functions
void	compute_guide_values (guide_data_t &gd, waypoint_t goal_wp, double x, double y, double heading)
void	set_default_guide_values (guide_data_t &gd, double x, double y, double heading)

---

Detailed Description

Abstract base class for providing guide data (heading error, desired_heading, etc).

---

Constructor & Destructor Documentation

virtual cajun::guide_mode_t::~guide_mode_t

(

)

[inline, virtual]

---

Member Function Documentation

void guide_mode_t::compute_guide_values	(	guide_data_t &	gd,
		waypoint_t	goal_wp,
		double	x,
		double	y,
		double	heading
	)			[protected]

References cajun::waypoint_t::azimuth, cajun::waypoint_t::x, and cajun::waypoint_t::y.

Referenced by cajun::vs_guide_t::guide(), and cajun::ftc_guide_t::guide().

virtual void cajun::guide_mode_t::guide	(	guide_data_t &	gd,
		const uniform_path_t &	goal_data,
		unsigned	goal_index,
		double	x,
		double	y,
		double	heading,
		double	speed,
		bool	valid_path,
		bool	forward,
		bool	tight_path,
		double	tstamp
	)			[pure virtual]

Implemented in cajun::ftc_guide_t, and cajun::vs_guide_t.

Referenced by cajun::drive_t::drive_the_bot().

void guide_mode_t::set_default_guide_values	(	guide_data_t &	gd,
		double	x,
		double	y,
		double	heading
	)			[protected]

Referenced by cajun::vs_guide_t::guide(), and cajun::ftc_guide_t::guide().

---

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

• guide_mode.H
• guide_mode.C