Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

OutputPID Class Reference

#include <OutputPID.h>

List of all members.

Detailed Description

This object holds all the information needed to control a single output.

Definition at line 6 of file OutputPID.h.

Public Member Functions

 OutputPID ()
 Constructor.

 OutputPID (const float p[3])
 Constructor.

 OutputPID (const float p[3], float w)
 Constructor.

 OutputPID (const OutputPID &a, const OutputPID &b, float w)
 Constructor, see set(a,b,w).

void set (const float p[3], float w=1)
 sets the value to v and weight to w

void set (const OutputPID &a, const OutputPID &b, float w)
 sets the value to a weighted average of a and b (higher w, more a)

void unset ()
 sets value and weight to 0


Public Attributes

float pid [3]
 pid value of the output

float weight
 weight to be used in averaging, 0 to "fall through"


Protected Member Functions

void set_pid (const float p[3])

Constructor & Destructor Documentation

OutputPID::OutputPID (   )  [inline]
 

Constructor.

Definition at line 8 of file OutputPID.h.

References pid, and weight.

OutputPID::OutputPID (  const float  p[3]  )  [inline]
 

Constructor.

Definition at line 9 of file OutputPID.h.

References set_pid(), and weight.

Here is the call graph for this function:

OutputPID::OutputPID (  const float  p[3],
float  w
)  [inline]
 

Constructor.

Definition at line 10 of file OutputPID.h.

References set_pid(), and weight.

Here is the call graph for this function:

OutputPID::OutputPID (  const OutputPID &  a,
const OutputPID &  b,
float  w
)  [inline]
 

Constructor, see set(a,b,w).

Definition at line 11 of file OutputPID.h.

References set(), and weight.

Here is the call graph for this function:

Member Function Documentation

void OutputPID::set (  const OutputPID &  a,
const OutputPID &  b,
float  w
)  [inline]
 

sets the value to a weighted average of a and b (higher w, more a)

Definition at line 16 of file OutputPID.h.

References pid, and weight.

void OutputPID::set (  const float  p[3],
float  w = 1
)  [inline]
 

sets the value to v and weight to w

Definition at line 13 of file OutputPID.h.

References set_pid(), and weight.

Here is the call graph for this function:

void OutputPID::set_pid (  const float  p[3]  )  [inline, protected]
 

< handy utility function

Definition at line 28 of file OutputPID.h.

References pid.

void OutputPID::unset (   )  [inline]
 

sets value and weight to 0

Definition at line 22 of file OutputPID.h.

References weight.

Member Data Documentation

float OutputPID::pid[3]
 

pid value of the output

Definition at line 24 of file OutputPID.h.

float OutputPID::weight
 

weight to be used in averaging, 0 to "fall through"

Definition at line 25 of file OutputPID.h.

The documentation for this class was generated from the following file:
Tekkotsu v1.5
 		Generated Fri Oct 10 15:57:10 2003 by Doxygen 1.3.4