yarp::dev::Map2DLocationData Class Reference

#include <yarp/dev/Map2DLocationData.h>

Inheritance diagram for yarp::dev::Map2DLocationData:

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

Public Member Functions
	Map2DLocationData ()=default
	Map2DLocationData (const std::string &map_id, const double x, const double y, const double theta, const std::string &description)
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
std::string	map_id {}
	name of the map
double	x {0.0}
	x position of the location [m], expressed in the map reference frame
double	y {0.0}
	y position of the location [m], expressed in the map reference frame
double	theta {0.0}
	orientation [deg] in the map reference frame
std::string	description {}
	user defined string

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 21 of file Map2DLocationData.h.

Member Typedef Documentation

unwrapped

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

Definition at line 73 of file Map2DLocationData.h.

Constructor & Destructor Documentation

Map2DLocationData() [1/2]

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

default

Map2DLocationData() [2/2]

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

Definition at line 16 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

reader

an 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 Map2DLocationData.cpp.

read() [2/2]

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

overridevirtual

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

Definition at line 31 of file Map2DLocationData.cpp.

toString()

std::string yarp::dev::Map2DLocationData::toString

(

)

const

Definition at line 105 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.

Definition at line 68 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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 92 of file Map2DLocationData.cpp.

Member Data Documentation

description

std::string yarp::dev::Map2DLocationData::description {}

user defined string

Definition at line 45 of file Map2DLocationData.h.

map_id

std::string yarp::dev::Map2DLocationData::map_id {}

name of the map

Definition at line 29 of file Map2DLocationData.h.

theta

double yarp::dev::Map2DLocationData::theta {0.0}

orientation [deg] in the map reference frame

Definition at line 41 of file Map2DLocationData.h.

x

double yarp::dev::Map2DLocationData::x {0.0}

x position of the location [m], expressed in the map reference frame

Definition at line 33 of file Map2DLocationData.h.

y

double yarp::dev::Map2DLocationData::y {0.0}

y position of the location [m], expressed in the map reference frame

Definition at line 37 of file Map2DLocationData.h.

---

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

• src/libYARP_dev/src/idl_generated_code/yarp/dev/Map2DLocationData.h
• src/libYARP_dev/src/idl_generated_code/yarp/dev/Map2DLocationData.cpp