#include <yarp/dev/PidGainsData.h>
Inheritance diagram for yarp::dev::PidGainsData:Public Types | |
| typedef yarp::os::idl::Unwrapped< PidGainsData > | unwrapped |
Public Member Functions | |
| PidGainsData ()=default | |
| PidGainsData (const double kp, const double kd, const double ki, const double max_int, const double scale, const double max_output, const double offset, const double stiction_up_val, const double stiction_down_val, const double kff) | |
| bool | read (yarp::os::idl::WireReader &reader) override |
| bool | read (yarp::os::ConnectionReader &connection) override |
| Read this object from a network connection. | |
| bool | write (const yarp::os::idl::WireWriter &writer) const override |
| bool | write (yarp::os::ConnectionWriter &connection) const override |
| Write this object to a network connection. | |
| std::string | toString () const |
Public Member Functions inherited from yarp::os::idl::WirePortable | |
| virtual bool | readBare (yarp::os::ConnectionReader &reader) |
| virtual bool | writeBare (yarp::os::ConnectionWriter &writer) const |
| virtual bool | readBottle (yarp::os::ConnectionReader &reader) |
| virtual bool | writeBottle (yarp::os::ConnectionWriter &writer) const |
Public Member Functions inherited from yarp::os::Portable | |
| virtual Type | getType () const |
Public Member Functions inherited from yarp::os::PortReader | |
| virtual | ~PortReader () |
| Destructor. | |
| virtual Type | getReadType () const |
Public Member Functions inherited from yarp::os::PortWriter | |
| virtual | ~PortWriter () |
| Destructor. | |
| virtual void | onCompletion () const |
| This is called when the port has finished all writing operations. | |
| virtual void | onCommencement () const |
| This is called when the port is about to begin writing operations. | |
| virtual yarp::os::Type | getWriteType () const |
Public Attributes | |
| double | kp {0.0} |
| proportional gain | |
| double | kd {0.0} |
| derivative gain | |
| double | ki {0.0} |
| integrative gain | |
| double | max_int {0.0} |
| saturation threshold for the integrator | |
| double | scale {0.0} |
| scale for the pid output | |
| double | max_output {0.0} |
| max output | |
| double | offset {0.0} |
| pwm offset added to the pid output | |
| double | stiction_up_val {0.0} |
| up stiction offset added to the pid output | |
| double | stiction_down_val {0.0} |
| down stiction offset added to the pid output | |
| double | kff {0.0} |
| feedforward gain | |
Additional Inherited Members | |
Static Public Member Functions inherited from yarp::os::Portable | |
| static bool | copyPortable (const PortWriter &writer, PortReader &reader) |
| Copy one portable to another, via writing and reading. | |
Definition at line 21 of file PidGainsData.h.
Definition at line 99 of file PidGainsData.h.
|
default |
| yarp::dev::PidGainsData::PidGainsData | ( | const double | kp, |
| const double | kd, | ||
| const double | ki, | ||
| const double | max_int, | ||
| const double | scale, | ||
| const double | max_output, | ||
| const double | offset, | ||
| const double | stiction_up_val, | ||
| const double | stiction_down_val, | ||
| const double | kff | ||
| ) |
Definition at line 16 of file PidGainsData.cpp.
|
overridevirtual |
Read this object from a network connection.
Override this for your particular class.
| reader | an interface to the network connection for reading |
Implements yarp::os::Portable.
Definition at line 80 of file PidGainsData.cpp.
|
overridevirtual |
Reimplemented from yarp::os::idl::WirePortable.
Definition at line 41 of file PidGainsData.cpp.
| std::string yarp::dev::PidGainsData::toString | ( | ) | const |
Definition at line 145 of file PidGainsData.cpp.
|
overridevirtual |
Reimplemented from yarp::os::idl::WirePortable.
Definition at line 93 of file PidGainsData.cpp.
|
overridevirtual |
Write this object to a network connection.
Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write
| writer | an interface to the network connection for writing |
Implements yarp::os::Portable.
Definition at line 132 of file PidGainsData.cpp.
| double yarp::dev::PidGainsData::kd {0.0} |
derivative gain
Definition at line 33 of file PidGainsData.h.
| double yarp::dev::PidGainsData::kff {0.0} |
feedforward gain
Definition at line 65 of file PidGainsData.h.
| double yarp::dev::PidGainsData::ki {0.0} |
integrative gain
Definition at line 37 of file PidGainsData.h.
| double yarp::dev::PidGainsData::kp {0.0} |
proportional gain
Definition at line 29 of file PidGainsData.h.
| double yarp::dev::PidGainsData::max_int {0.0} |
saturation threshold for the integrator
Definition at line 41 of file PidGainsData.h.
| double yarp::dev::PidGainsData::max_output {0.0} |
max output
Definition at line 49 of file PidGainsData.h.
| double yarp::dev::PidGainsData::offset {0.0} |
pwm offset added to the pid output
Definition at line 53 of file PidGainsData.h.
| double yarp::dev::PidGainsData::scale {0.0} |
scale for the pid output
Definition at line 45 of file PidGainsData.h.
| double yarp::dev::PidGainsData::stiction_down_val {0.0} |
down stiction offset added to the pid output
Definition at line 61 of file PidGainsData.h.
| double yarp::dev::PidGainsData::stiction_up_val {0.0} |
up stiction offset added to the pid output
Definition at line 57 of file PidGainsData.h.