yarp::dev::Map2DPathData::Editor Class Reference

#include <yarp/dev/Map2DPathData.h>

Inheritance diagram for yarp::dev::Map2DPathData::Editor:

Public Member Functions
	Editor ()
	Editor (Map2DPathData &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 (Map2DPathData &obj, bool dirty=true)
bool	isValid () const
Map2DPathData &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_waypoints (const std::vector< yarp::dev::Nav2D::Map2DLocation > &waypoints)
void	set_waypoints (size_t index, const yarp::dev::Nav2D::Map2DLocation &elem)
const std::vector< yarp::dev::Nav2D::Map2DLocation > &	get_waypoints () const
virtual bool	will_set_waypoints ()
virtual bool	did_set_waypoints ()
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 57 of file Map2DPathData.h.

Constructor & Destructor Documentation

Editor() [1/4]

yarp::dev::Map2DPathData::Editor::Editor

(

)

Definition at line 80 of file Map2DPathData.cpp.

Editor() [2/4]

yarp::dev::Map2DPathData::Editor::Editor

(

Map2DPathData &

obj

)

Definition at line 90 of file Map2DPathData.cpp.

~Editor()

yarp::dev::Map2DPathData::Editor::~Editor ( )

override

Definition at line 99 of file Map2DPathData.cpp.

Editor() [3/4]

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

delete

Editor() [4/4]

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

delete

Member Function Documentation

begin()

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

inline

Definition at line 91 of file Map2DPathData.h.

clean()

void yarp::dev::Map2DPathData::Editor::clean

(

)

Definition at line 183 of file Map2DPathData.cpp.

did_set_waypoints()

bool yarp::dev::Map2DPathData::Editor::did_set_waypoints ( )

virtual

Definition at line 177 of file Map2DPathData.cpp.

edit()

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

Definition at line 107 of file Map2DPathData.cpp.

end()

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

inline

Definition at line 102 of file Map2DPathData.h.

get_waypoints()

const std::vector< yarp::dev::Nav2D::Map2DLocation > & yarp::dev::Map2DPathData::Editor::get_waypoints

(

)

const

Definition at line 165 of file Map2DPathData.cpp.

isValid()

bool yarp::dev::Map2DPathData::Editor::isValid

(

)

const

Definition at line 119 of file Map2DPathData.cpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

read()

bool yarp::dev::Map2DPathData::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 189 of file Map2DPathData.cpp.

set_waypoints() [1/2]

void yarp::dev::Map2DPathData::Editor::set_waypoints

(

const std::vector< yarp::dev::Nav2D::Map2DLocation > &

waypoints

)

Definition at line 145 of file Map2DPathData.cpp.

set_waypoints() [2/2]

void yarp::dev::Map2DPathData::Editor::set_waypoints	(	size_t	index,
		const yarp::dev::Nav2D::Map2DLocation &	elem
	)

Definition at line 155 of file Map2DPathData.cpp.

start_editing()

void yarp::dev::Map2DPathData::Editor::start_editing

(

)

Definition at line 131 of file Map2DPathData.cpp.

state()

Map2DPathData & yarp::dev::Map2DPathData::Editor::state

(

)

Definition at line 125 of file Map2DPathData.cpp.

stop_editing()

void yarp::dev::Map2DPathData::Editor::stop_editing

(

)

Definition at line 137 of file Map2DPathData.cpp.

will_set_waypoints()

bool yarp::dev::Map2DPathData::Editor::will_set_waypoints ( )

virtual

Definition at line 171 of file Map2DPathData.cpp.

write()

bool yarp::dev::Map2DPathData::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 292 of file Map2DPathData.cpp.

---

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

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