YARP
Yet Another Robot Platform
yarp::dev::OdometryData::Editor Class Reference

#include <yarp/dev/OdometryData.h>

+ Inheritance diagram for yarp::dev::OdometryData::Editor:

Public Member Functions

 Editor ()
 
 Editor (OdometryData &obj)
 
 ~Editor () override
 
 Editor (const Editor &rhs)=delete
 
 Editor (Editor &&rhs)=delete
 
Editoroperator= (const Editor &rhs)=delete
 
Editoroperator= (Editor &&rhs)=delete
 
bool edit (OdometryData &obj, bool dirty=true)
 
bool isValid () const
 
OdometryDatastate ()
 
void start_editing ()
 
void begin ()
 
void stop_editing ()
 
void end ()
 
void set_odom_x (const double odom_x)
 
double get_odom_x () const
 
virtual bool will_set_odom_x ()
 
virtual bool did_set_odom_x ()
 
void set_odom_y (const double odom_y)
 
double get_odom_y () const
 
virtual bool will_set_odom_y ()
 
virtual bool did_set_odom_y ()
 
void set_odom_theta (const double odom_theta)
 
double get_odom_theta () const
 
virtual bool will_set_odom_theta ()
 
virtual bool did_set_odom_theta ()
 
void set_base_vel_x (const double base_vel_x)
 
double get_base_vel_x () const
 
virtual bool will_set_base_vel_x ()
 
virtual bool did_set_base_vel_x ()
 
void set_base_vel_y (const double base_vel_y)
 
double get_base_vel_y () const
 
virtual bool will_set_base_vel_y ()
 
virtual bool did_set_base_vel_y ()
 
void set_base_vel_theta (const double base_vel_theta)
 
double get_base_vel_theta () const
 
virtual bool will_set_base_vel_theta ()
 
virtual bool did_set_base_vel_theta ()
 
void set_odom_vel_x (const double odom_vel_x)
 
double get_odom_vel_x () const
 
virtual bool will_set_odom_vel_x ()
 
virtual bool did_set_odom_vel_x ()
 
void set_odom_vel_y (const double odom_vel_y)
 
double get_odom_vel_y () const
 
virtual bool will_set_odom_vel_y ()
 
virtual bool did_set_odom_vel_y ()
 
void set_odom_vel_theta (const double odom_vel_theta)
 
double get_odom_vel_theta () const
 
virtual bool will_set_odom_vel_theta ()
 
virtual bool did_set_odom_vel_theta ()
 
void clean ()
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
- Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLinkyarp ()
 Get YARP state associated with this object. More...
 
- 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
 

Detailed Description

Definition at line 99 of file OdometryData.h.

Constructor & Destructor Documentation

◆ Editor() [1/4]

yarp::dev::OdometryData::Editor::Editor ( )

Definition at line 152 of file OdometryData.cpp.

◆ Editor() [2/4]

yarp::dev::OdometryData::Editor::Editor ( OdometryData obj)

Definition at line 162 of file OdometryData.cpp.

◆ ~Editor()

yarp::dev::OdometryData::Editor::~Editor ( )
override

Definition at line 171 of file OdometryData.cpp.

◆ Editor() [3/4]

yarp::dev::OdometryData::Editor::Editor ( const Editor rhs)
delete

◆ Editor() [4/4]

yarp::dev::OdometryData::Editor::Editor ( Editor &&  rhs)
delete

Member Function Documentation

◆ begin()

void yarp::dev::OdometryData::Editor::begin ( )
inline

Definition at line 133 of file OdometryData.h.

◆ clean()

void yarp::dev::OdometryData::Editor::clean ( )

Definition at line 469 of file OdometryData.cpp.

◆ did_set_base_vel_theta()

bool yarp::dev::OdometryData::Editor::did_set_base_vel_theta ( )
virtual

Definition at line 379 of file OdometryData.cpp.

◆ did_set_base_vel_x()

bool yarp::dev::OdometryData::Editor::did_set_base_vel_x ( )
virtual

Definition at line 323 of file OdometryData.cpp.

◆ did_set_base_vel_y()

bool yarp::dev::OdometryData::Editor::did_set_base_vel_y ( )
virtual

Definition at line 351 of file OdometryData.cpp.

◆ did_set_odom_theta()

bool yarp::dev::OdometryData::Editor::did_set_odom_theta ( )
virtual

Definition at line 295 of file OdometryData.cpp.

◆ did_set_odom_vel_theta()

bool yarp::dev::OdometryData::Editor::did_set_odom_vel_theta ( )
virtual

Definition at line 463 of file OdometryData.cpp.

◆ did_set_odom_vel_x()

bool yarp::dev::OdometryData::Editor::did_set_odom_vel_x ( )
virtual

Definition at line 407 of file OdometryData.cpp.

◆ did_set_odom_vel_y()

bool yarp::dev::OdometryData::Editor::did_set_odom_vel_y ( )
virtual

Definition at line 435 of file OdometryData.cpp.

◆ did_set_odom_x()

bool yarp::dev::OdometryData::Editor::did_set_odom_x ( )
virtual

Definition at line 239 of file OdometryData.cpp.

◆ did_set_odom_y()

bool yarp::dev::OdometryData::Editor::did_set_odom_y ( )
virtual

Definition at line 267 of file OdometryData.cpp.

◆ edit()

bool yarp::dev::OdometryData::Editor::edit ( OdometryData obj,
bool  dirty = true 
)

Definition at line 179 of file OdometryData.cpp.

◆ end()

void yarp::dev::OdometryData::Editor::end ( )
inline

Definition at line 144 of file OdometryData.h.

◆ get_base_vel_theta()

double yarp::dev::OdometryData::Editor::get_base_vel_theta ( ) const

Definition at line 367 of file OdometryData.cpp.

◆ get_base_vel_x()

double yarp::dev::OdometryData::Editor::get_base_vel_x ( ) const

Definition at line 311 of file OdometryData.cpp.

◆ get_base_vel_y()

double yarp::dev::OdometryData::Editor::get_base_vel_y ( ) const

Definition at line 339 of file OdometryData.cpp.

◆ get_odom_theta()

double yarp::dev::OdometryData::Editor::get_odom_theta ( ) const

Definition at line 283 of file OdometryData.cpp.

◆ get_odom_vel_theta()

double yarp::dev::OdometryData::Editor::get_odom_vel_theta ( ) const

Definition at line 451 of file OdometryData.cpp.

◆ get_odom_vel_x()

double yarp::dev::OdometryData::Editor::get_odom_vel_x ( ) const

Definition at line 395 of file OdometryData.cpp.

◆ get_odom_vel_y()

double yarp::dev::OdometryData::Editor::get_odom_vel_y ( ) const

Definition at line 423 of file OdometryData.cpp.

◆ get_odom_x()

double yarp::dev::OdometryData::Editor::get_odom_x ( ) const

Definition at line 227 of file OdometryData.cpp.

◆ get_odom_y()

double yarp::dev::OdometryData::Editor::get_odom_y ( ) const

Definition at line 255 of file OdometryData.cpp.

◆ isValid()

bool yarp::dev::OdometryData::Editor::isValid ( ) const

Definition at line 191 of file OdometryData.cpp.

◆ operator=() [1/2]

Editor& yarp::dev::OdometryData::Editor::operator= ( const Editor rhs)
delete

◆ operator=() [2/2]

Editor& yarp::dev::OdometryData::Editor::operator= ( Editor &&  rhs)
delete

◆ read()

bool yarp::dev::OdometryData::Editor::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::PortReader.

Definition at line 475 of file OdometryData.cpp.

◆ set_base_vel_theta()

void yarp::dev::OdometryData::Editor::set_base_vel_theta ( const double  base_vel_theta)

Definition at line 357 of file OdometryData.cpp.

◆ set_base_vel_x()

void yarp::dev::OdometryData::Editor::set_base_vel_x ( const double  base_vel_x)

Definition at line 301 of file OdometryData.cpp.

◆ set_base_vel_y()

void yarp::dev::OdometryData::Editor::set_base_vel_y ( const double  base_vel_y)

Definition at line 329 of file OdometryData.cpp.

◆ set_odom_theta()

void yarp::dev::OdometryData::Editor::set_odom_theta ( const double  odom_theta)

Definition at line 273 of file OdometryData.cpp.

◆ set_odom_vel_theta()

void yarp::dev::OdometryData::Editor::set_odom_vel_theta ( const double  odom_vel_theta)

Definition at line 441 of file OdometryData.cpp.

◆ set_odom_vel_x()

void yarp::dev::OdometryData::Editor::set_odom_vel_x ( const double  odom_vel_x)

Definition at line 385 of file OdometryData.cpp.

◆ set_odom_vel_y()

void yarp::dev::OdometryData::Editor::set_odom_vel_y ( const double  odom_vel_y)

Definition at line 413 of file OdometryData.cpp.

◆ set_odom_x()

void yarp::dev::OdometryData::Editor::set_odom_x ( const double  odom_x)

Definition at line 217 of file OdometryData.cpp.

◆ set_odom_y()

void yarp::dev::OdometryData::Editor::set_odom_y ( const double  odom_y)

Definition at line 245 of file OdometryData.cpp.

◆ start_editing()

void yarp::dev::OdometryData::Editor::start_editing ( )

Definition at line 203 of file OdometryData.cpp.

◆ state()

OdometryData & yarp::dev::OdometryData::Editor::state ( )

Definition at line 197 of file OdometryData.cpp.

◆ stop_editing()

void yarp::dev::OdometryData::Editor::stop_editing ( )

Definition at line 209 of file OdometryData.cpp.

◆ will_set_base_vel_theta()

bool yarp::dev::OdometryData::Editor::will_set_base_vel_theta ( )
virtual

Definition at line 373 of file OdometryData.cpp.

◆ will_set_base_vel_x()

bool yarp::dev::OdometryData::Editor::will_set_base_vel_x ( )
virtual

Definition at line 317 of file OdometryData.cpp.

◆ will_set_base_vel_y()

bool yarp::dev::OdometryData::Editor::will_set_base_vel_y ( )
virtual

Definition at line 345 of file OdometryData.cpp.

◆ will_set_odom_theta()

bool yarp::dev::OdometryData::Editor::will_set_odom_theta ( )
virtual

Definition at line 289 of file OdometryData.cpp.

◆ will_set_odom_vel_theta()

bool yarp::dev::OdometryData::Editor::will_set_odom_vel_theta ( )
virtual

Definition at line 457 of file OdometryData.cpp.

◆ will_set_odom_vel_x()

bool yarp::dev::OdometryData::Editor::will_set_odom_vel_x ( )
virtual

Definition at line 401 of file OdometryData.cpp.

◆ will_set_odom_vel_y()

bool yarp::dev::OdometryData::Editor::will_set_odom_vel_y ( )
virtual

Definition at line 429 of file OdometryData.cpp.

◆ will_set_odom_x()

bool yarp::dev::OdometryData::Editor::will_set_odom_x ( )
virtual

Definition at line 233 of file OdometryData.cpp.

◆ will_set_odom_y()

bool yarp::dev::OdometryData::Editor::will_set_odom_y ( )
virtual

Definition at line 261 of file OdometryData.cpp.

◆ write()

bool yarp::dev::OdometryData::Editor::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::PortWriter.

Definition at line 725 of file OdometryData.cpp.


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