orwell::StoppingCriterion< dof > Class Template Reference

base class for a stopping criterion for a Controller More...

#include <StoppingCriterion.hpp>

Public Member Functions
virtual bool	isFinished (const RobotState< dof > &robot_state) const =0
	implement this function in derived classes to check whether the stopping criterion has been reached

Detailed Description

template<int dof>
class orwell::StoppingCriterion< dof >

base class for a stopping criterion for a Controller

Template Parameters

dof	number of degrees of freedom of the controlled system

Definition at line 35 of file StoppingCriterion.hpp.

Member Function Documentation

isFinished()

template<int dof>

virtual bool orwell::StoppingCriterion< dof >::isFinished ( const RobotState< dof > & robot_state ) const

pure virtual

implement this function in derived classes to check whether the stopping criterion has been reached

will be called during Controller::isFinished

Parameters

robot_state

current RobotState

Returns

true if the stopping criterion has been reached

---

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

• StoppingCriterion.hpp