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...
 
const yarp::os::WireLinkyarp () const
 Get YARP state associated with this object (const version). 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 96 of file OdometryData.h.

Constructor & Destructor Documentation

◆ Editor() [1/4]

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

Definition at line 149 of file OdometryData.cpp.

◆ Editor() [2/4]

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

Definition at line 159 of file OdometryData.cpp.

◆ ~Editor()

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

Definition at line 168 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 130 of file OdometryData.h.

◆ clean()

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

Definition at line 466 of file OdometryData.cpp.

◆ did_set_base_vel_theta()

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

Definition at line 376 of file OdometryData.cpp.

◆ did_set_base_vel_x()

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

Definition at line 320 of file OdometryData.cpp.

◆ did_set_base_vel_y()

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

Definition at line 348 of file OdometryData.cpp.

◆ did_set_odom_theta()

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

Definition at line 292 of file OdometryData.cpp.

◆ did_set_odom_vel_theta()

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

Definition at line 460 of file OdometryData.cpp.

◆ did_set_odom_vel_x()

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

Definition at line 404 of file OdometryData.cpp.

◆ did_set_odom_vel_y()

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

Definition at line 432 of file OdometryData.cpp.

◆ did_set_odom_x()

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

Definition at line 236 of file OdometryData.cpp.

◆ did_set_odom_y()

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

Definition at line 264 of file OdometryData.cpp.

◆ edit()

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

Definition at line 176 of file OdometryData.cpp.

◆ end()

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

Definition at line 141 of file OdometryData.h.

◆ get_base_vel_theta()

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

Definition at line 364 of file OdometryData.cpp.

◆ get_base_vel_x()

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

Definition at line 308 of file OdometryData.cpp.

◆ get_base_vel_y()

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

Definition at line 336 of file OdometryData.cpp.

◆ get_odom_theta()

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

Definition at line 280 of file OdometryData.cpp.

◆ get_odom_vel_theta()

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

Definition at line 448 of file OdometryData.cpp.

◆ get_odom_vel_x()

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

Definition at line 392 of file OdometryData.cpp.

◆ get_odom_vel_y()

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

Definition at line 420 of file OdometryData.cpp.

◆ get_odom_x()

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

Definition at line 224 of file OdometryData.cpp.

◆ get_odom_y()

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

Definition at line 252 of file OdometryData.cpp.

◆ isValid()

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

Definition at line 188 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 472 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 354 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 298 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 326 of file OdometryData.cpp.

◆ set_odom_theta()

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

Definition at line 270 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 438 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 382 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 410 of file OdometryData.cpp.

◆ set_odom_x()

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

Definition at line 214 of file OdometryData.cpp.

◆ set_odom_y()

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

Definition at line 242 of file OdometryData.cpp.

◆ start_editing()

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

Definition at line 200 of file OdometryData.cpp.

◆ state()

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

Definition at line 194 of file OdometryData.cpp.

◆ stop_editing()

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

Definition at line 206 of file OdometryData.cpp.

◆ will_set_base_vel_theta()

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

Definition at line 370 of file OdometryData.cpp.

◆ will_set_base_vel_x()

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

Definition at line 314 of file OdometryData.cpp.

◆ will_set_base_vel_y()

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

Definition at line 342 of file OdometryData.cpp.

◆ will_set_odom_theta()

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

Definition at line 286 of file OdometryData.cpp.

◆ will_set_odom_vel_theta()

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

Definition at line 454 of file OdometryData.cpp.

◆ will_set_odom_vel_x()

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

Definition at line 398 of file OdometryData.cpp.

◆ will_set_odom_vel_y()

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

Definition at line 426 of file OdometryData.cpp.

◆ will_set_odom_x()

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

Definition at line 230 of file OdometryData.cpp.

◆ will_set_odom_y()

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

Definition at line 258 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 722 of file OdometryData.cpp.


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