Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

DeadReckoningBehavior< ParticleT > Class Template Reference

#include <DeadReckoningBehavior.h>

Inheritance diagram for DeadReckoningBehavior< ParticleT >:

List of all members.


Detailed Description

template<class ParticleT>
class DeadReckoningBehavior< ParticleT >

Subscribes to LocomotionEvents and attempts to track robot movement over time using a fairly generic HolonomicMotionModel.

Can be used as a ParticleFilter::MotionModel, or as a component of other behaviors.

If you want a regular report on position, the behavior will output current position on timer events

Definition at line 16 of file DeadReckoningBehavior.h.


Public Member Functions

 DeadReckoningBehavior (const std::string &name="DeadReckoningBehavior")
 constructor
 DeadReckoningBehavior (float xVariance, float yVariance, float aVariance)
 constructor
virtual void DoStart ()
 By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
virtual void processEvent (const EventBase &event)
 By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
virtual std::string getDescription () const
 Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).

Static Public Member Functions

static std::string getClassDescription ()
 Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Protected Member Functions

 DeadReckoningBehavior (const std::string &classname, const std::string &instancename)
 constructor, accepts separate classname and instance name parameters from subclass

Constructor & Destructor Documentation

template<class ParticleT>
DeadReckoningBehavior< ParticleT >::DeadReckoningBehavior ( const std::string &  name = "DeadReckoningBehavior< ParticleT >"  )  [inline, explicit]

constructor

Definition at line 19 of file DeadReckoningBehavior.h.

template<class ParticleT>
DeadReckoningBehavior< ParticleT >::DeadReckoningBehavior ( float  xVariance,
float  yVariance,
float  aVariance 
) [inline]

constructor

Definition at line 22 of file DeadReckoningBehavior.h.

template<class ParticleT>
DeadReckoningBehavior< ParticleT >::DeadReckoningBehavior ( const std::string &  classname,
const std::string &  instancename 
) [inline, protected]

constructor, accepts separate classname and instance name parameters from subclass

Definition at line 50 of file DeadReckoningBehavior.h.


Member Function Documentation

template<class ParticleT>
virtual void DeadReckoningBehavior< ParticleT >::DoStart (  )  [inline, virtual]

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 25 of file DeadReckoningBehavior.h.

template<class ParticleT>
virtual void DeadReckoningBehavior< ParticleT >::processEvent ( const EventBase  )  [inline, virtual]

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 32 of file DeadReckoningBehavior.h.

template<class ParticleT>
static std::string DeadReckoningBehavior< ParticleT >::getClassDescription (  )  [inline, static]

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

If you do override this, also consider overriding getDescription() to return it

Reimplemented from BehaviorBase.

Definition at line 45 of file DeadReckoningBehavior.h.

Referenced by DeadReckoningBehavior< ParticleT >::getDescription().

template<class ParticleT>
virtual std::string DeadReckoningBehavior< ParticleT >::getDescription (  )  const [inline, virtual]

Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).

By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~getClassDescription(), because static functions can't be virtual in C++ (doh!)

This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.

Reimplemented from BehaviorBase.

Definition at line 46 of file DeadReckoningBehavior.h.


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:17 2007 by Doxygen 1.5.4