CScalarPID Class Reference

#include <ScalarPID.h>

Inheritance diagram for CScalarPID:

Collaboration diagram for CScalarPID:

List of all members.

Public Member Functions
bool	SetGoal (double dfGoal)
bool	SetLogPath (std::string &sPath)
bool	SetLog (bool bLog)
bool	SetName (std::string sName)
void	SetLimits (double dfIntegralLimit, double dfOutputLimit)
bool	Run (double dfeIn, double dfErrorTime, double &dfOut)
	CScalarPID ()
	CScalarPID (double dfKp, double dfKd, double dfKi, double dfIntegralLimit, double dfOutputLimit)
virtual	~CScalarPID ()
void	SetGains (double dfKp, double dfKd, double dfKi)
Public Attributes
unsigned int	m_nHistorySize
std::list< double >	m_DiffHistory
Protected Member Functions
bool	Log ()
Protected Attributes
double	m_dfKi
double	m_dfKd
double	m_dfKp
double	m_dfe
double	m_dfeSum
double	m_dfeOld
double	m_dfeDiff
double	m_dfDT
double	m_dfOldTime
double	m_dfOut
double	m_dfIntegralLimit
double	m_dfOutputLimit
std::string	m_sName
std::string	m_sLogPath
double	m_dfGoal
int	m_nIterations
bool	m_bLog
std::ofstream	m_LogFile

---

Detailed Description

Definition at line 46 of file ScalarPID.h.

---

Constructor & Destructor Documentation

CScalarPID::CScalarPID

(

)

Definition at line 45 of file ScalarPID.cpp.

CScalarPID::CScalarPID	(	double	dfKp,
		double	dfKd,
		double	dfKi,
		double	dfIntegralLimit,
		double	dfOutputLimit
	)

Definition at line 68 of file ScalarPID.cpp.

CScalarPID::~CScalarPID

(

)

[virtual]

Definition at line 93 of file ScalarPID.cpp.

---

Member Function Documentation

bool CScalarPID::Log

(

)

[protected]

Definition at line 215 of file ScalarPID.cpp.

bool CScalarPID::Run	(	double	dfeIn,
		double	dfErrorTime,
		double &	dfOut
	)

Definition at line 98 of file ScalarPID.cpp.

void CScalarPID::SetGains	(	double	dfKp,
		double	dfKd,
		double	dfKi
	)

Definition at line 190 of file ScalarPID.cpp.

bool CScalarPID::SetGoal

(

double

dfGoal

)

Reimplemented in CPitchZPID.

Definition at line 289 of file ScalarPID.cpp.

void CScalarPID::SetLimits	(	double	dfIntegralLimit,
		double	dfOutputLimit
	)

Definition at line 197 of file ScalarPID.cpp.

bool CScalarPID::SetLog

(

bool

bLog

)

Definition at line 209 of file ScalarPID.cpp.

bool CScalarPID::SetLogPath

(

std::string &

sPath

)

Reimplemented in CPitchZPID.

Definition at line 283 of file ScalarPID.cpp.

bool CScalarPID::SetName

(

std::string

sName

)

---

Member Data Documentation

bool CScalarPID::m_bLog [protected]

Definition at line 93 of file ScalarPID.h.

double CScalarPID::m_dfDT [protected]

Definition at line 78 of file ScalarPID.h.

double CScalarPID::m_dfe [protected]

Definition at line 74 of file ScalarPID.h.

double CScalarPID::m_dfeDiff [protected]

Definition at line 77 of file ScalarPID.h.

double CScalarPID::m_dfeOld [protected]

Definition at line 76 of file ScalarPID.h.

double CScalarPID::m_dfeSum [protected]

Definition at line 75 of file ScalarPID.h.

double CScalarPID::m_dfGoal [protected]

Definition at line 91 of file ScalarPID.h.

double CScalarPID::m_dfIntegralLimit [protected]

Definition at line 81 of file ScalarPID.h.

double CScalarPID::m_dfKd [protected]

Definition at line 72 of file ScalarPID.h.

double CScalarPID::m_dfKi [protected]

Definition at line 71 of file ScalarPID.h.

double CScalarPID::m_dfKp [protected]

Definition at line 73 of file ScalarPID.h.

double CScalarPID::m_dfOldTime [protected]

Definition at line 79 of file ScalarPID.h.

double CScalarPID::m_dfOut [protected]

Definition at line 80 of file ScalarPID.h.

double CScalarPID::m_dfOutputLimit [protected]

Definition at line 82 of file ScalarPID.h.

std::list<double> CScalarPID::m_DiffHistory

Definition at line 57 of file ScalarPID.h.

std::ofstream CScalarPID::m_LogFile [protected]

Definition at line 94 of file ScalarPID.h.

unsigned int CScalarPID::m_nHistorySize

Definition at line 55 of file ScalarPID.h.

int CScalarPID::m_nIterations [protected]

Definition at line 92 of file ScalarPID.h.

std::string CScalarPID::m_sLogPath [protected]

Definition at line 88 of file ScalarPID.h.

std::string CScalarPID::m_sName [protected]

Definition at line 87 of file ScalarPID.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Essentials/MOOSUtilityLib/ScalarPID.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Essentials/MOOSUtilityLib/ScalarPID.cpp