YARP
Yet Another Robot Platform
yarp::dev::Nav2D::INavigation2DExtraActions Class Referenceabstract

#include <yarp/dev/INavigation2D.h>

+ Inheritance diagram for yarp::dev::Nav2D::INavigation2DExtraActions:

Public Member Functions

virtual bool gotoTargetByLocationName (std::string location_or_area_name)=0
 Ask the robot to reach a previously stored location/area. More...
 
virtual bool checkInsideArea (std::string area_name)=0
 Check if the robot is currently inside the specified area. More...
 
virtual bool checkInsideArea (Nav2D::Map2DArea area)=0
 Check if the robot is currently inside the specified area. More...
 
virtual bool checkNearToLocation (Nav2D::Map2DLocation loc, double linear_tolerance, double angular_tolerance=std::numeric_limits< double >::infinity())=0
 Check if the robot is currently near to the specified area. More...
 
virtual bool checkNearToLocation (std::string location_name, double linear_tolerance, double angular_tolerance=std::numeric_limits< double >::infinity())=0
 Check if the robot is currently near to the specified area. More...
 
virtual bool getNameOfCurrentTarget (std::string &location_name)=0
 Gets the name of the current target, if available (set by gotoTargetByLocationName) More...
 
virtual bool storeCurrentPosition (std::string location_name)=0
 Store the current location of the robot. More...
 
virtual ~INavigation2DExtraActions ()
 Destructor. More...
 

Detailed Description

Definition at line 206 of file INavigation2D.h.

Constructor & Destructor Documentation

◆ ~INavigation2DExtraActions()

virtual yarp::dev::Nav2D::INavigation2DExtraActions::~INavigation2DExtraActions ( )
inlinevirtual

Destructor.

Definition at line 265 of file INavigation2D.h.

Member Function Documentation

◆ checkInsideArea() [1/2]

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::checkInsideArea ( Nav2D::Map2DArea  area)
pure virtual

Check if the robot is currently inside the specified area.

Parameters
areathe area to be checked
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ checkInsideArea() [2/2]

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::checkInsideArea ( std::string  area_name)
pure virtual

Check if the robot is currently inside the specified area.

Parameters
area_namethe name of an area previously saved
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ checkNearToLocation() [1/2]

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::checkNearToLocation ( Nav2D::Map2DLocation  loc,
double  linear_tolerance,
double  angular_tolerance = std::numeric_limits< double >::infinity() 
)
pure virtual

Check if the robot is currently near to the specified area.

Parameters
locthe location to be checked
linear_tolerancelinear tolerance [m]
angular_tolerance[deg 0-360]
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ checkNearToLocation() [2/2]

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::checkNearToLocation ( std::string  location_name,
double  linear_tolerance,
double  angular_tolerance = std::numeric_limits< double >::infinity() 
)
pure virtual

Check if the robot is currently near to the specified area.

Parameters
location_namethe name of the location: it will be searched in the server
linear_tolerancelinear tolerance [m]
angular_tolerance[deg]
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ getNameOfCurrentTarget()

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::getNameOfCurrentTarget ( std::string &  location_name)
pure virtual

Gets the name of the current target, if available (set by gotoTargetByLocationName)

Parameters
location_namethe name of the current target
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ gotoTargetByLocationName()

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::gotoTargetByLocationName ( std::string  location_or_area_name)
pure virtual

Ask the robot to reach a previously stored location/area.

Parameters
location_namethe name of a location/area previously saved
Returns
true/false

Implemented in Navigation2D_nwc_yarp.

◆ storeCurrentPosition()

virtual bool yarp::dev::Nav2D::INavigation2DExtraActions::storeCurrentPosition ( std::string  location_name)
pure virtual

Store the current location of the robot.

Parameters
location_namethe name of the location
Returns
true/false

Implemented in Navigation2D_nwc_yarp.


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