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

#include <yarp/dev/Map2DLocationData.h>

+ Inheritance diagram for yarp::dev::Map2DLocationData:

Classes

class  Editor
 

Public Types

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

Public Member Functions

 Map2DLocationData ()
 
 Map2DLocationData (const std::string &map_id, const double x, const double y, const double 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

std::string map_id
 
double x
 
double y
 
double theta
 

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 Map2DLocationData.h.

Member Typedef Documentation

◆ unwrapped

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

Definition at line 60 of file Map2DLocationData.h.

Constructor & Destructor Documentation

◆ Map2DLocationData() [1/2]

yarp::dev::Map2DLocationData::Map2DLocationData ( )

Definition at line 20 of file Map2DLocationData.cpp.

◆ Map2DLocationData() [2/2]

yarp::dev::Map2DLocationData::Map2DLocationData ( const std::string &  map_id,
const double  x,
const double  y,
const double  theta 
)

Definition at line 30 of file Map2DLocationData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::Map2DLocationData::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.

Reimplemented in yarp::dev::Nav2D::Map2DLocation.

Definition at line 61 of file Map2DLocationData.cpp.

◆ read() [2/2]

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

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

Reimplemented in yarp::dev::Nav2D::Map2DLocation.

Definition at line 43 of file Map2DLocationData.cpp.

◆ toString()

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

Definition at line 99 of file Map2DLocationData.cpp.

◆ write() [1/2]

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

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

Reimplemented in yarp::dev::Nav2D::Map2DLocation.

Definition at line 71 of file Map2DLocationData.cpp.

◆ write() [2/2]

bool yarp::dev::Map2DLocationData::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.

Reimplemented in yarp::dev::Nav2D::Map2DLocation.

Definition at line 89 of file Map2DLocationData.cpp.

Member Data Documentation

◆ map_id

std::string yarp::dev::Map2DLocationData::map_id

Definition at line 30 of file Map2DLocationData.h.

◆ theta

double yarp::dev::Map2DLocationData::theta

Definition at line 33 of file Map2DLocationData.h.

◆ x

double yarp::dev::Map2DLocationData::x

Definition at line 31 of file Map2DLocationData.h.

◆ y

double yarp::dev::Map2DLocationData::y

Definition at line 32 of file Map2DLocationData.h.

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