#include <yarp/dev/PidDescriptionData.h>
Inheritance diagram for yarp::dev::PidDescriptionData:Public Types | |
| typedef yarp::os::idl::Unwrapped< PidDescriptionData > | unwrapped |
Public Member Functions | |
| PidDescriptionData ()=default | |
| PidDescriptionData (const std::string &pid_description, const std::string &input_data_description, const std::string &output_data_description) | |
| 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 | pid_description {} |
| human-readable description of the pid controller. | |
| std::string | input_data_description {} |
| human-readable description of the input data of pid | |
| std::string | output_data_description {} |
| human-readable description of the output data of pid | |
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 PidDescriptionData.h.
Definition at line 64 of file PidDescriptionData.h.
|
default |
| yarp::dev::PidDescriptionData::PidDescriptionData | ( | const std::string & | pid_description, |
| const std::string & | input_data_description, | ||
| const std::string & | output_data_description | ||
| ) |
Definition at line 16 of file PidDescriptionData.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 45 of file PidDescriptionData.cpp.
|
overridevirtual |
Reimplemented from yarp::os::idl::WirePortable.
Definition at line 27 of file PidDescriptionData.cpp.
| std::string yarp::dev::PidDescriptionData::toString | ( | ) | const |
Definition at line 89 of file PidDescriptionData.cpp.
|
overridevirtual |
Reimplemented from yarp::os::idl::WirePortable.
Definition at line 58 of file PidDescriptionData.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 76 of file PidDescriptionData.cpp.
| std::string yarp::dev::PidDescriptionData::input_data_description {} |
human-readable description of the input data of pid
Definition at line 33 of file PidDescriptionData.h.
| std::string yarp::dev::PidDescriptionData::output_data_description {} |
human-readable description of the output data of pid
Definition at line 37 of file PidDescriptionData.h.
| std::string yarp::dev::PidDescriptionData::pid_description {} |
human-readable description of the pid controller.
Definition at line 29 of file PidDescriptionData.h.