YARP
Yet Another Robot Platform
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
 
Editoroperator= (const Editor &rhs)=delete
 
Editoroperator= (Editor &&rhs)=delete
 
bool edit (Map2DPathData &obj, bool dirty=true)
 
bool isValid () const
 
Map2DPathDatastate ()
 
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::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 54 of file Map2DPathData.h.

Constructor & Destructor Documentation

◆ Editor() [1/4]

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

Definition at line 77 of file Map2DPathData.cpp.

◆ Editor() [2/4]

yarp::dev::Map2DPathData::Editor::Editor ( Map2DPathData obj)

Definition at line 87 of file Map2DPathData.cpp.

◆ ~Editor()

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

Definition at line 96 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 88 of file Map2DPathData.h.

◆ clean()

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

Definition at line 180 of file Map2DPathData.cpp.

◆ did_set_waypoints()

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

Definition at line 174 of file Map2DPathData.cpp.

◆ edit()

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

Definition at line 104 of file Map2DPathData.cpp.

◆ end()

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

Definition at line 99 of file Map2DPathData.h.

◆ get_waypoints()

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

Definition at line 162 of file Map2DPathData.cpp.

◆ isValid()

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

Definition at line 116 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
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 186 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 142 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 152 of file Map2DPathData.cpp.

◆ start_editing()

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

Definition at line 128 of file Map2DPathData.cpp.

◆ state()

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

Definition at line 122 of file Map2DPathData.cpp.

◆ stop_editing()

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

Definition at line 134 of file Map2DPathData.cpp.

◆ will_set_waypoints()

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

Definition at line 168 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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::PortWriter.

Definition at line 289 of file Map2DPathData.cpp.


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