yarp::dev::Map2DLocationData::Editor Class Reference

#include <yarp/dev/Map2DLocationData.h>

Inheritance diagram for yarp::dev::Map2DLocationData::Editor:

Public Member Functions
	Editor ()
	Editor (Map2DLocationData &obj)
	~Editor () override
	Editor (const Editor &rhs)=delete
	Editor (Editor &&rhs)=delete
Editor &	operator= (const Editor &rhs)=delete
Editor &	operator= (Editor &&rhs)=delete
bool	edit (Map2DLocationData &obj, bool dirty=true)
bool	isValid () const
Map2DLocationData &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_map_id (const std::string &map_id)
const std::string &	get_map_id () const
virtual bool	will_set_map_id ()
virtual bool	did_set_map_id ()
void	set_x (const double x)
double	get_x () const
virtual bool	will_set_x ()
virtual bool	did_set_x ()
void	set_y (const double y)
double	get_y () const
virtual bool	will_set_y ()
virtual bool	did_set_y ()
void	set_theta (const double theta)
double	get_theta () const
virtual bool	will_set_theta ()
virtual bool	did_set_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::WireLink &	yarp ()
	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 62 of file Map2DLocationData.h.

Constructor & Destructor Documentation

Editor() [1/4]

yarp::dev::Map2DLocationData::Editor::Editor

(

)

Definition at line 107 of file Map2DLocationData.cpp.

Editor() [2/4]

yarp::dev::Map2DLocationData::Editor::Editor

(

Map2DLocationData &

obj

)

Definition at line 117 of file Map2DLocationData.cpp.

~Editor()

yarp::dev::Map2DLocationData::Editor::~Editor ( )

override

Definition at line 126 of file Map2DLocationData.cpp.

Editor() [3/4]

yarp::dev::Map2DLocationData::Editor::Editor ( const Editor &  rhs )

delete

Editor() [4/4]

yarp::dev::Map2DLocationData::Editor::Editor ( Editor &&  rhs )

delete

Member Function Documentation

begin()

void yarp::dev::Map2DLocationData::Editor::begin ( )

inline

Definition at line 96 of file Map2DLocationData.h.

clean()

void yarp::dev::Map2DLocationData::Editor::clean

(

)

Definition at line 284 of file Map2DLocationData.cpp.

did_set_map_id()

bool yarp::dev::Map2DLocationData::Editor::did_set_map_id ( )

virtual

Definition at line 194 of file Map2DLocationData.cpp.

did_set_theta()

bool yarp::dev::Map2DLocationData::Editor::did_set_theta ( )

virtual

Definition at line 278 of file Map2DLocationData.cpp.

did_set_x()

bool yarp::dev::Map2DLocationData::Editor::did_set_x ( )

virtual

Definition at line 222 of file Map2DLocationData.cpp.

did_set_y()

bool yarp::dev::Map2DLocationData::Editor::did_set_y ( )

virtual

Definition at line 250 of file Map2DLocationData.cpp.

edit()

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

Definition at line 134 of file Map2DLocationData.cpp.

end()

void yarp::dev::Map2DLocationData::Editor::end ( )

inline

Definition at line 107 of file Map2DLocationData.h.

get_map_id()

const std::string & yarp::dev::Map2DLocationData::Editor::get_map_id

(

)

const

Definition at line 182 of file Map2DLocationData.cpp.

get_theta()

double yarp::dev::Map2DLocationData::Editor::get_theta

(

)

const

Definition at line 266 of file Map2DLocationData.cpp.

get_x()

double yarp::dev::Map2DLocationData::Editor::get_x

(

)

const

Definition at line 210 of file Map2DLocationData.cpp.

get_y()

double yarp::dev::Map2DLocationData::Editor::get_y

(

)

const

Definition at line 238 of file Map2DLocationData.cpp.

isValid()

bool yarp::dev::Map2DLocationData::Editor::isValid

(

)

const

Definition at line 146 of file Map2DLocationData.cpp.

operator=() [1/2]

Editor& yarp::dev::Map2DLocationData::Editor::operator= ( const Editor &  rhs )

delete

operator=() [2/2]

Editor& yarp::dev::Map2DLocationData::Editor::operator= ( Editor &&  rhs )

delete

read()

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

Definition at line 290 of file Map2DLocationData.cpp.

set_map_id()

void yarp::dev::Map2DLocationData::Editor::set_map_id

(

const std::string &

map_id

)

Definition at line 172 of file Map2DLocationData.cpp.

set_theta()

void yarp::dev::Map2DLocationData::Editor::set_theta

(

const double

theta

)

Definition at line 256 of file Map2DLocationData.cpp.

set_x()

void yarp::dev::Map2DLocationData::Editor::set_x

(

const double

x

)

Definition at line 200 of file Map2DLocationData.cpp.

set_y()

void yarp::dev::Map2DLocationData::Editor::set_y

(

const double

y

)

Definition at line 228 of file Map2DLocationData.cpp.

start_editing()

void yarp::dev::Map2DLocationData::Editor::start_editing

(

)

Definition at line 158 of file Map2DLocationData.cpp.

state()

Map2DLocationData & yarp::dev::Map2DLocationData::Editor::state

(

)

Definition at line 152 of file Map2DLocationData.cpp.

stop_editing()

void yarp::dev::Map2DLocationData::Editor::stop_editing

(

)

Definition at line 164 of file Map2DLocationData.cpp.

will_set_map_id()

bool yarp::dev::Map2DLocationData::Editor::will_set_map_id ( )

virtual

Definition at line 188 of file Map2DLocationData.cpp.

will_set_theta()

bool yarp::dev::Map2DLocationData::Editor::will_set_theta ( )

virtual

Definition at line 272 of file Map2DLocationData.cpp.

will_set_x()

bool yarp::dev::Map2DLocationData::Editor::will_set_x ( )

virtual

Definition at line 216 of file Map2DLocationData.cpp.

will_set_y()

bool yarp::dev::Map2DLocationData::Editor::will_set_y ( )

virtual

Definition at line 244 of file Map2DLocationData.cpp.

write()

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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::PortWriter.

Definition at line 438 of file Map2DLocationData.cpp.

---

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