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

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

+ Inheritance diagram for return_getMotorEncoderCountsPerRevolution:

Public Types

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

Public Member Functions

 return_getMotorEncoderCountsPerRevolution ()=default
 
 return_getMotorEncoderCountsPerRevolution (const yarp::dev::ReturnValue &ret, const double cpr)
 
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

yarp::dev::ReturnValue ret {}
 
double cpr {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 18 of file return_getMotorEncoderCountsPerRevolution.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ return_getMotorEncoderCountsPerRevolution() [1/2]

return_getMotorEncoderCountsPerRevolution::return_getMotorEncoderCountsPerRevolution ( )
default

◆ return_getMotorEncoderCountsPerRevolution() [2/2]

return_getMotorEncoderCountsPerRevolution::return_getMotorEncoderCountsPerRevolution ( const yarp::dev::ReturnValue &  ret,
const double  cpr 
)

Member Function Documentation

◆ read() [1/2]

bool return_getMotorEncoderCountsPerRevolution::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 38 of file return_getMotorEncoderCountsPerRevolution.cpp.

◆ read() [2/2]

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

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

Definition at line 23 of file return_getMotorEncoderCountsPerRevolution.cpp.

◆ toString()

std::string return_getMotorEncoderCountsPerRevolution::toString ( ) const

◆ write() [1/2]

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

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

Definition at line 51 of file return_getMotorEncoderCountsPerRevolution.cpp.

◆ write() [2/2]

bool return_getMotorEncoderCountsPerRevolution::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 66 of file return_getMotorEncoderCountsPerRevolution.cpp.

Member Data Documentation

◆ cpr

double return_getMotorEncoderCountsPerRevolution::cpr {0.0}

Definition at line 24 of file return_getMotorEncoderCountsPerRevolution.h.

◆ ret

yarp::dev::ReturnValue return_getMotorEncoderCountsPerRevolution::ret {}

Definition at line 23 of file return_getMotorEncoderCountsPerRevolution.h.


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