P6DofPID Class Reference

#include <P6DofPID.hpp>

Public Member Functions
	P6DofPID ()
	~P6DofPID ()
P6DofPID &	operator= (const P6DofPID &other)=delete
P6DofPID *	Clone () const
	P6DofPID (const P6DofPID &aSrc)
double	CalcOutputFromTargetAndCurrent (double aSetPoint, double aCurValue, double aDt_sec)
double	CalcOutputFromTargetAndCurrentWithLimits (double aSetPoint, double aCurValue, double aDt_sec, double aMinOutput, double aMaxOutput)
double	CalcOutputFromError (double aError, double aDt_sec)
double	CalcOutputFromErrorWithLimits (double aError, double aDt_sec, double aMinOutput, double aMaxOutput)
void	SetCurrentValue (double aCurrentValue)
void	SetTargetValue (double aTargetValue)
void	SetControllingValue (double aControllingValue)
void	ResetPidState ()
std::vector< P6DOF::PidGainData > *	GetPidGainTableData (unsigned char &aPackedFlags)
void	SetPidGainTableData (std::vector< P6DOF::PidGainData > &aDataTables, unsigned char &aPackedFlags)
void	GetPidValueData (P6DOF::SinglePidValueData &aData) const
void	SetBias (double aBias)
void	SetFeedForward (double aFeedForward)
bool	GetFeedForward (double &aFeedForward)
void	AddElementsToGainTable (size_t aTotalElementsInTable)

Constructor & Destructor Documentation

P6DofPID() [1/2]

P6DofPID::P6DofPID

(

)

Referenced by Clone(), operator=(), and P6DofPID().

~P6DofPID()

P6DofPID::~P6DofPID

(

)

P6DofPID() [2/2]

P6DofPID::P6DofPID

(

const P6DofPID &

aSrc

)

References P6DofPID().

Member Function Documentation

AddElementsToGainTable()

void P6DofPID::AddElementsToGainTable

(

size_t

aTotalElementsInTable

)

CalcOutputFromError()

double P6DofPID::CalcOutputFromError	(	double	aError,
		double	aDt_sec )

CalcOutputFromErrorWithLimits()

double P6DofPID::CalcOutputFromErrorWithLimits	(	double	aError,
		double	aDt_sec,
		double	aMinOutput,
		double	aMaxOutput )

CalcOutputFromTargetAndCurrent()

double P6DofPID::CalcOutputFromTargetAndCurrent	(	double	aSetPoint,
		double	aCurValue,
		double	aDt_sec )

CalcOutputFromTargetAndCurrentWithLimits()

double P6DofPID::CalcOutputFromTargetAndCurrentWithLimits	(	double	aSetPoint,
		double	aCurValue,
		double	aDt_sec,
		double	aMinOutput,
		double	aMaxOutput )

Clone()

P6DofPID * P6DofPID::Clone

(

)

const

References P6DofPID().

GetFeedForward()

bool P6DofPID::GetFeedForward

(

double &

aFeedForward

)

GetPidGainTableData()

std::vector< P6DOF::PidGainData > * P6DofPID::GetPidGainTableData

(

unsigned char &

aPackedFlags

)

References P6DOF::Pid::LimitMax, P6DOF::Pid::UseAlpha, P6DOF::Pid::UseKt, P6DOF::Pid::ZeroGtMax, and P6DOF::Pid::ZeroLtMin.

Referenced by P6DofCommonController::AddNewPidGainElement(), P6DofCommonController::GetAutopilotPidGainData(), P6DofCommonController::GetAutopilotPidGainData(), P6DofCommonController::SetPidGainKD(), P6DofCommonController::SetPidGainKI(), P6DofCommonController::SetPidGainKP(), and P6DofCommonController::SetPidMaxAccum().

GetPidValueData()

void P6DofPID::GetPidValueData

(

P6DOF::SinglePidValueData &

aData

)

const

References P6DOF::SinglePidValueData::AccumError, P6DOF::SinglePidValueData::CurrentValue, P6DOF::SinglePidValueData::FFValue, P6DOF::SinglePidValueData::FFValueValid, P6DOF::SinglePidValueData::KdValue, P6DOF::SinglePidValueData::KiValue, P6DOF::SinglePidValueData::KpValue, P6DOF::SinglePidValueData::OutputBase, P6DOF::SinglePidValueData::OutputLimited, and P6DOF::SinglePidValueData::SetPoint.

operator=()

P6DofPID & P6DofPID::operator= ( const P6DofPID & other )

delete

References P6DofPID().

ResetPidState()

void P6DofPID::ResetPidState

(

)

Referenced by P6DofCommonController::ResetAccumulatedPidData().

SetBias()

void P6DofPID::SetBias

(

double

aBias

)

SetControllingValue()

void P6DofPID::SetControllingValue

(

double

aControllingValue

)

SetCurrentValue()

void P6DofPID::SetCurrentValue

(

double

aCurrentValue

)

SetFeedForward()

void P6DofPID::SetFeedForward

(

double

aFeedForward

)

SetPidGainTableData()

void P6DofPID::SetPidGainTableData	(	std::vector< P6DOF::PidGainData > &	aDataTables,
		unsigned char &	aPackedFlags )

References P6DOF::Pid::ClearAccum, P6DOF::Pid::LimitMax, P6DOF::Pid::UseAlpha, P6DOF::Pid::UseKt, P6DOF::Pid::ZeroGtMax, and P6DOF::Pid::ZeroLtMin.

Referenced by P6DofCommonController::ProcessPidInputBlock(), and P6DofCommonController::SetPidGainData().

SetTargetValue()

void P6DofPID::SetTargetValue

(

double

aTargetValue

)

---

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

• P6DofPID.hpp
• P6DofPID.cpp