YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yMotorTorqueParameters Class Reference

#include <messages/ControlBoardMsgs/idl_generated_code/yMotorTorqueParameters.h>

+ Inheritance diagram for yMotorTorqueParameters:

Public Types

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

Public Member Functions

 yMotorTorqueParameters ()=default
 
 yMotorTorqueParameters (const double bemf, const double bemf_scale, const double ktau, const double ktau_scale, const double viscousPos, const double viscousNeg, const double coulombPos, const double coulombNeg, const double velocityThres)
 
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 bemf {0.0}
 
double bemf_scale {0.0}
 
double ktau {0.0}
 
double ktau_scale {0.0}
 
double viscousPos {0.0}
 
double viscousNeg {0.0}
 
double coulombPos {0.0}
 
double coulombNeg {0.0}
 
double velocityThres {0.0}
 

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 17 of file yMotorTorqueParameters.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ yMotorTorqueParameters() [1/2]

yMotorTorqueParameters::yMotorTorqueParameters ( )
default

◆ yMotorTorqueParameters() [2/2]

yMotorTorqueParameters::yMotorTorqueParameters ( const double  bemf,
const double  bemf_scale,
const double  ktau,
const double  ktau_scale,
const double  viscousPos,
const double  viscousNeg,
const double  coulombPos,
const double  coulombNeg,
const double  velocityThres 
)

Definition at line 14 of file yMotorTorqueParameters.cpp.

Member Function Documentation

◆ read() [1/2]

bool yMotorTorqueParameters::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 73 of file yMotorTorqueParameters.cpp.

◆ read() [2/2]

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

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

Definition at line 37 of file yMotorTorqueParameters.cpp.

◆ toString()

std::string yMotorTorqueParameters::toString ( ) const

Definition at line 135 of file yMotorTorqueParameters.cpp.

◆ write() [1/2]

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

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

Definition at line 86 of file yMotorTorqueParameters.cpp.

◆ write() [2/2]

bool yMotorTorqueParameters::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 122 of file yMotorTorqueParameters.cpp.

Member Data Documentation

◆ bemf

double yMotorTorqueParameters::bemf {0.0}

Definition at line 22 of file yMotorTorqueParameters.h.

◆ bemf_scale

double yMotorTorqueParameters::bemf_scale {0.0}

Definition at line 23 of file yMotorTorqueParameters.h.

◆ coulombNeg

double yMotorTorqueParameters::coulombNeg {0.0}

Definition at line 29 of file yMotorTorqueParameters.h.

◆ coulombPos

double yMotorTorqueParameters::coulombPos {0.0}

Definition at line 28 of file yMotorTorqueParameters.h.

◆ ktau

double yMotorTorqueParameters::ktau {0.0}

Definition at line 24 of file yMotorTorqueParameters.h.

◆ ktau_scale

double yMotorTorqueParameters::ktau_scale {0.0}

Definition at line 25 of file yMotorTorqueParameters.h.

◆ velocityThres

double yMotorTorqueParameters::velocityThres {0.0}

Definition at line 30 of file yMotorTorqueParameters.h.

◆ viscousNeg

double yMotorTorqueParameters::viscousNeg {0.0}

Definition at line 27 of file yMotorTorqueParameters.h.

◆ viscousPos

double yMotorTorqueParameters::viscousPos {0.0}

Definition at line 26 of file yMotorTorqueParameters.h.


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