Nav2 Navigation Stack - jazzy  jazzy
ROS 2 Navigation Stack
Public Member Functions | List of all members
nav2_amcl::MotionModel Class Referenceabstract

An abstract motion model class. More...

#include <nav2_amcl/include/nav2_amcl/motion_model/motion_model.hpp>

Inheritance diagram for nav2_amcl::MotionModel:
Inheritance graph
[legend]

Public Member Functions

virtual void initialize (double alpha1, double alpha2, double alpha3, double alpha4, double alpha5)=0
 An factory to create motion models. More...
 
virtual void odometryUpdate (pf_t *pf, const pf_vector_t &pose, const pf_vector_t &delta)=0
 Update on new odometry data. More...
 

Detailed Description

An abstract motion model class.

Definition at line 33 of file motion_model.hpp.

Member Function Documentation

◆ initialize()

virtual void nav2_amcl::MotionModel::initialize ( double  alpha1,
double  alpha2,
double  alpha3,
double  alpha4,
double  alpha5 
)
pure virtual

An factory to create motion models.

Parameters
typeType of motion model to create in factory
alpha1error parameters, see documentation
alpha2error parameters, see documentation
alpha3error parameters, see documentation
alpha4error parameters, see documentation
alpha5error parameters, see documentation
Returns
MotionModel A pointer to the motion model it created

Implemented in nav2_amcl::OmniMotionModel, and nav2_amcl::DifferentialMotionModel.

◆ odometryUpdate()

virtual void nav2_amcl::MotionModel::odometryUpdate ( pf_t pf,
const pf_vector_t pose,
const pf_vector_t delta 
)
pure virtual

Update on new odometry data.

Parameters
pfThe particle filter to update
posepose of robot in odometry update
deltachange in pose in odometry update

Implemented in nav2_amcl::OmniMotionModel, and nav2_amcl::DifferentialMotionModel.


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