ESC Class Reference

Superclass for extremum seeking control algorithms. More...

#include <esc.h>

List of all members.

Public Types
enum	inputType { inputStateValue, inputValue }
	Controller input type. More...
enum	outputType { outputVelocity, outputPosition }
	Controller output type. More...
Public Member Functions
virtual inputType	getInputType ()=0
	Get controller input type.
virtual outputType	getOutputType ()=0
	Get controller output type.
virtual bool	isStoppingConditionsMet ()
	Reset control algorithm to initial conditions.
virtual std::vector< double >	monitor ()
	Get internal monitor variables.
virtual std::vector< std::string >	monitorNames ()
	Get internal monitor variable names.
virtual void	reset ()=0
	Reset control algorithm to initial conditions.
virtual std::vector< double >	step (std::vector< double > state, double obj_val)
	Control step function for value-input control algorithms.
virtual std::vector< double >	step (double obj_val)
	Control step function for state-input control algorithms.
virtual	~ESC ()

---

Detailed Description

Superclass for extremum seeking control algorithms.

Definition at line 19 of file esc.h.

---

Member Enumeration Documentation

enum ESC::inputType

Controller input type.

Enumerator:

inputStateValue	State-value input.
inputValue	Value input.

Definition at line 23 of file esc.h.

enum ESC::outputType

Controller output type.

Enumerator:

outputVelocity	Velocity reference output.
outputPosition	Position reference output.

Definition at line 30 of file esc.h.

---

Constructor & Destructor Documentation

virtual ESC::~ESC

(

)

[inline, virtual]

Definition at line 37 of file esc.h.

---

Member Function Documentation

virtual inputType ESC::getInputType

(

)

[pure virtual]

Get controller input type.

virtual outputType ESC::getOutputType

(

)

[pure virtual]

Get controller output type.

virtual bool ESC::isStoppingConditionsMet

(

)

[inline, virtual]

Reset control algorithm to initial conditions.

Definition at line 67 of file esc.h.

virtual std::vector<double> ESC::monitor

(

)

[inline, virtual]

Get internal monitor variables.

Definition at line 43 of file esc.h.

virtual std::vector<std::string> ESC::monitorNames

(

)

[inline, virtual]

Get internal monitor variable names.

Definition at line 40 of file esc.h.

virtual void ESC::reset

(

)

[pure virtual]

Reset control algorithm to initial conditions.

virtual std::vector<double> ESC::step	(	std::vector< double >	state,
		double	obj_val
	)		[inline, virtual]

Control step function for value-input control algorithms.

Definition at line 52 of file esc.h.

virtual std::vector<double> ESC::step

(

double

obj_val

)

[inline, virtual]

Control step function for state-input control algorithms.

Definition at line 58 of file esc.h.

---

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

• esc.h