YARP
Yet Another Robot Platform

map2DServer deprecated: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device. More...

#include <map2DServer/Map2DServer.h>

+ Inheritance diagram for Map2DServer:

Public Member Functions

 Map2DServer ()
 Map2DServer. More...
 
 ~Map2DServer ()
 
bool saveMaps (std::string filename)
 
bool loadMaps (std::string filename)
 
bool load_locations_and_areas (std::string locations_file)
 
bool save_locations_and_areas (std::string locations_file)
 
bool open (yarp::os::Searchable &params) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
yarp::os::Bottle getOptions ()
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 ~DeviceDriver () override=default
 Destructor. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 

Detailed Description

map2DServer deprecated: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device.

Map2DServer

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
name - string - /mapServer/rpc No Full name of the rpc port opened by the Map2DServer device.
mapCollection - string - - No The name of .ini file containing a map collection.

Definition at line 61 of file Map2DServer.h.

Constructor & Destructor Documentation

◆ Map2DServer()

Map2DServer::Map2DServer ( )

Map2DServer.

Definition at line 39 of file Map2DServer.cpp.

◆ ~Map2DServer()

Map2DServer::~Map2DServer ( )
default

Member Function Documentation

◆ close()

bool Map2DServer::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 1126 of file Map2DServer.cpp.

◆ getOptions()

yarp::os::Bottle Map2DServer::getOptions ( )

◆ load_locations_and_areas()

bool Map2DServer::load_locations_and_areas ( std::string  locations_file)

Definition at line 1348 of file Map2DServer.cpp.

◆ loadMaps()

bool Map2DServer::loadMaps ( std::string  filename)

Definition at line 847 of file Map2DServer.cpp.

◆ open()

bool Map2DServer::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 909 of file Map2DServer.cpp.

◆ save_locations_and_areas()

bool Map2DServer::save_locations_and_areas ( std::string  locations_file)

Definition at line 1405 of file Map2DServer.cpp.

◆ saveMaps()

bool Map2DServer::saveMaps ( std::string  filename)

Definition at line 820 of file Map2DServer.cpp.


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