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

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

+ Inheritance diagram for yCalibrationParameters:

Public Types

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

Public Member Functions

 yCalibrationParameters ()=default
 
 yCalibrationParameters (const std::int32_t type, const double param1, const double param2, const double param3, const double param4, const double param5, const double paramZero)
 
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::int32_t type {0}
 
double param1 {0.0}
 
double param2 {0.0}
 
double param3 {0.0}
 
double param4 {0.0}
 
double param5 {0.0}
 
double paramZero {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 yCalibrationParameters.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ yCalibrationParameters() [1/2]

yCalibrationParameters::yCalibrationParameters ( )
default

◆ yCalibrationParameters() [2/2]

yCalibrationParameters::yCalibrationParameters ( const std::int32_t  type,
const double  param1,
const double  param2,
const double  param3,
const double  param4,
const double  param5,
const double  paramZero 
)

Definition at line 14 of file yCalibrationParameters.cpp.

Member Function Documentation

◆ read() [1/2]

bool yCalibrationParameters::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 63 of file yCalibrationParameters.cpp.

◆ read() [2/2]

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

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

Definition at line 33 of file yCalibrationParameters.cpp.

◆ toString()

std::string yCalibrationParameters::toString ( ) const

Definition at line 119 of file yCalibrationParameters.cpp.

◆ write() [1/2]

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

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

Definition at line 76 of file yCalibrationParameters.cpp.

◆ write() [2/2]

bool yCalibrationParameters::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 106 of file yCalibrationParameters.cpp.

Member Data Documentation

◆ param1

double yCalibrationParameters::param1 {0.0}

Definition at line 23 of file yCalibrationParameters.h.

◆ param2

double yCalibrationParameters::param2 {0.0}

Definition at line 24 of file yCalibrationParameters.h.

◆ param3

double yCalibrationParameters::param3 {0.0}

Definition at line 25 of file yCalibrationParameters.h.

◆ param4

double yCalibrationParameters::param4 {0.0}

Definition at line 26 of file yCalibrationParameters.h.

◆ param5

double yCalibrationParameters::param5 {0.0}

Definition at line 27 of file yCalibrationParameters.h.

◆ paramZero

double yCalibrationParameters::paramZero {0.0}

Definition at line 28 of file yCalibrationParameters.h.

◆ type

std::int32_t yCalibrationParameters::type {0}

Definition at line 22 of file yCalibrationParameters.h.


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