YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::PidUnitsData Class Reference

#include <yarp/dev/PidUnitsData.h>

+ Inheritance diagram for yarp::dev::PidUnitsData:

Public Types

typedef yarp::os::idl::Unwrapped< PidUnitsData > unwrapped
 

Public Member Functions

 PidUnitsData ()=default
 
 PidUnitsData (const std::string &units_kp, const std::string &units_kd, const std::string &units_ki, const std::string &units_max_int, const std::string &units_scale, const std::string &units_max_output, const std::string &units_offset, const std::string &units_stiction_up_val, const std::string &units_stiction_down_val, const std::string &units_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

std::string units_kp {}
 proportional gain
 
std::string units_kd {}
 derivative gain
 
std::string units_ki {}
 integrative gain
 
std::string units_max_int {}
 saturation threshold for the integrator
 
std::string units_scale {}
 scale for the pid output
 
std::string units_max_output {}
 max output
 
std::string units_offset {}
 pwm offset added to the pid output
 
std::string units_stiction_up_val {}
 up stiction offset added to the pid output
 
std::string units_stiction_down_val {}
 down stiction offset added to the pid output
 
std::string units_kff {}
 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.
 

Detailed Description

Definition at line 21 of file PidUnitsData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ PidUnitsData() [1/2]

yarp::dev::PidUnitsData::PidUnitsData ( )
default

◆ PidUnitsData() [2/2]

yarp::dev::PidUnitsData::PidUnitsData ( const std::string &  units_kp,
const std::string &  units_kd,
const std::string &  units_ki,
const std::string &  units_max_int,
const std::string &  units_scale,
const std::string &  units_max_output,
const std::string &  units_offset,
const std::string &  units_stiction_up_val,
const std::string &  units_stiction_down_val,
const std::string &  units_kff 
)

Definition at line 16 of file PidUnitsData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::PidUnitsData::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 80 of file PidUnitsData.cpp.

◆ read() [2/2]

bool yarp::dev::PidUnitsData::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 41 of file PidUnitsData.cpp.

◆ toString()

std::string yarp::dev::PidUnitsData::toString ( ) const

Definition at line 145 of file PidUnitsData.cpp.

◆ write() [1/2]

bool yarp::dev::PidUnitsData::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 93 of file PidUnitsData.cpp.

◆ write() [2/2]

bool yarp::dev::PidUnitsData::write ( yarp::os::ConnectionWriter &  writer) const
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

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 132 of file PidUnitsData.cpp.

Member Data Documentation

◆ units_kd

std::string yarp::dev::PidUnitsData::units_kd {}

derivative gain

Definition at line 33 of file PidUnitsData.h.

◆ units_kff

std::string yarp::dev::PidUnitsData::units_kff {}

feedforward gain

Definition at line 65 of file PidUnitsData.h.

◆ units_ki

std::string yarp::dev::PidUnitsData::units_ki {}

integrative gain

Definition at line 37 of file PidUnitsData.h.

◆ units_kp

std::string yarp::dev::PidUnitsData::units_kp {}

proportional gain

Definition at line 29 of file PidUnitsData.h.

◆ units_max_int

std::string yarp::dev::PidUnitsData::units_max_int {}

saturation threshold for the integrator

Definition at line 41 of file PidUnitsData.h.

◆ units_max_output

std::string yarp::dev::PidUnitsData::units_max_output {}

max output

Definition at line 49 of file PidUnitsData.h.

◆ units_offset

std::string yarp::dev::PidUnitsData::units_offset {}

pwm offset added to the pid output

Definition at line 53 of file PidUnitsData.h.

◆ units_scale

std::string yarp::dev::PidUnitsData::units_scale {}

scale for the pid output

Definition at line 45 of file PidUnitsData.h.

◆ units_stiction_down_val

std::string yarp::dev::PidUnitsData::units_stiction_down_val {}

down stiction offset added to the pid output

Definition at line 61 of file PidUnitsData.h.

◆ units_stiction_up_val

std::string yarp::dev::PidUnitsData::units_stiction_up_val {}

up stiction offset added to the pid output

Definition at line 57 of file PidUnitsData.h.


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