YARP
Yet Another Robot Platform
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
yarp::dev::MobileBaseVelocity Class Reference

#include <yarp/dev/MobileBaseVelocity.h>

+ Inheritance diagram for yarp::dev::MobileBaseVelocity:

Classes

class  Editor
 

Public Types

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

Public Member Functions

 MobileBaseVelocity ()
 
 MobileBaseVelocity (const double vel_x, const double vel_y, const double vel_theta)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
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. More...
 
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. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

double vel_x
 velocity of the robot [m/s] More...
 
double vel_y
 velocity of the robot [m/s] More...
 
double vel_theta
 angular velocity of the robot [deg/s] More...
 

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. More...
 

Detailed Description

Definition at line 25 of file MobileBaseVelocity.h.

Member Typedef Documentation

◆ unwrapped

typedef yarp::os::idl::Unwrapped<MobileBaseVelocity> yarp::dev::MobileBaseVelocity::unwrapped

Definition at line 67 of file MobileBaseVelocity.h.

Constructor & Destructor Documentation

◆ MobileBaseVelocity() [1/2]

yarp::dev::MobileBaseVelocity::MobileBaseVelocity ( )

Definition at line 20 of file MobileBaseVelocity.cpp.

◆ MobileBaseVelocity() [2/2]

yarp::dev::MobileBaseVelocity::MobileBaseVelocity ( const double  vel_x,
const double  vel_y,
const double  vel_theta 
)

Definition at line 29 of file MobileBaseVelocity.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::MobileBaseVelocity::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 55 of file MobileBaseVelocity.cpp.

◆ read() [2/2]

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

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

Definition at line 40 of file MobileBaseVelocity.cpp.

◆ toString()

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

Definition at line 90 of file MobileBaseVelocity.cpp.

◆ write() [1/2]

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

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

Definition at line 65 of file MobileBaseVelocity.cpp.

◆ write() [2/2]

bool yarp::dev::MobileBaseVelocity::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 80 of file MobileBaseVelocity.cpp.

Member Data Documentation

◆ vel_theta

double yarp::dev::MobileBaseVelocity::vel_theta

angular velocity of the robot [deg/s]

Definition at line 41 of file MobileBaseVelocity.h.

◆ vel_x

double yarp::dev::MobileBaseVelocity::vel_x

velocity of the robot [m/s]

Definition at line 33 of file MobileBaseVelocity.h.

◆ vel_y

double yarp::dev::MobileBaseVelocity::vel_y

velocity of the robot [m/s]

Definition at line 37 of file MobileBaseVelocity.h.

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