#include <yarp/dev/INavigation2D.h>
|
| virtual yarp::dev::ReturnValue | gotoTargetByLocationName (std::string location_or_area_name)=0 |
| | Ask the robot to reach a previously stored location/area.
|
| |
| virtual yarp::dev::ReturnValue | checkInsideArea (std::string area_name, bool &is_inside)=0 |
| | Check if the robot is currently inside the specified area.
|
| |
| virtual yarp::dev::ReturnValue | checkInsideArea (Nav2D::Map2DArea area, bool &is_inside)=0 |
| | Check if the robot is currently inside the specified area.
|
| |
| virtual yarp::dev::ReturnValue | findCurrentArea (std::string &area_name, Nav2D::Map2DArea &area)=0 |
| | Check if the robot is inside any of the currently stored areas.
|
| |
| virtual yarp::dev::ReturnValue | checkNearToLocation (Nav2D::Map2DLocation loc, bool &is_near, double linear_tolerance, double angular_tolerance=std::numeric_limits< double >::infinity())=0 |
| | Check if the robot is currently near to the specified area.
|
| |
| virtual yarp::dev::ReturnValue | checkNearToLocation (std::string location_name, bool &is_near, double linear_tolerance, double angular_tolerance=std::numeric_limits< double >::infinity())=0 |
| | Check if the robot is currently near to the specified area.
|
| |
| virtual yarp::dev::ReturnValue | getNameOfCurrentTarget (std::string &location_name)=0 |
| | Gets the name of the current target, if available (set by gotoTargetByLocationName)
|
| |
| virtual yarp::dev::ReturnValue | storeCurrentPosition (std::string location_name)=0 |
| | Store the current location of the robot.
|
| |
| virtual | ~INavigation2DExtraActions () |
| | Destructor.
|
| |
Definition at line 214 of file INavigation2D.h.
◆ ~INavigation2DExtraActions()
| virtual yarp::dev::Nav2D::INavigation2DExtraActions::~INavigation2DExtraActions |
( |
| ) |
|
|
inlinevirtual |
◆ checkInsideArea() [1/2]
Check if the robot is currently inside the specified area.
- Parameters
-
| area | the area to be checked |
- Returns
- is_inside true if the robot is inside the area.
-
a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ checkInsideArea() [2/2]
| virtual yarp::dev::ReturnValue yarp::dev::Nav2D::INavigation2DExtraActions::checkInsideArea |
( |
std::string |
area_name, |
|
|
bool & |
is_inside |
|
) |
| |
|
pure virtual |
Check if the robot is currently inside the specified area.
- Parameters
-
| area_name | the name of an area previously saved |
- Returns
- is_inside true if the robot is inside the area.
-
a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ checkNearToLocation() [1/2]
| virtual yarp::dev::ReturnValue yarp::dev::Nav2D::INavigation2DExtraActions::checkNearToLocation |
( |
Nav2D::Map2DLocation |
loc, |
|
|
bool & |
is_near, |
|
|
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
-
| loc | the location to be checked |
- Returns
- is_near true if the robot is near to the area.
- Parameters
-
| linear_tolerance | linear tolerance [m] |
| angular_tolerance | [deg 0-360] |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ checkNearToLocation() [2/2]
| virtual yarp::dev::ReturnValue yarp::dev::Nav2D::INavigation2DExtraActions::checkNearToLocation |
( |
std::string |
location_name, |
|
|
bool & |
is_near, |
|
|
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_name | the name of the location: it will be searched in the server |
- Returns
- is_near true if the robot is near to the area.
- Parameters
-
| linear_tolerance | linear tolerance [m] |
| angular_tolerance | [deg] |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ findCurrentArea()
Check if the robot is inside any of the currently stored areas.
If yes, it returns its data.
- Parameters
-
| [out] | area_name | name of the area (if found), empty string otherwise |
| [out] | area | data of the area (if found), empty data otherwise |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ getNameOfCurrentTarget()
| virtual yarp::dev::ReturnValue 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_name | the name of the current target |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ gotoTargetByLocationName()
| virtual yarp::dev::ReturnValue 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_name | the name of a location/area previously saved |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
◆ storeCurrentPosition()
| virtual yarp::dev::ReturnValue yarp::dev::Nav2D::INavigation2DExtraActions::storeCurrentPosition |
( |
std::string |
location_name | ) |
|
|
pure virtual |
Store the current location of the robot.
- Parameters
-
| location_name | the name of the location |
- Returns
- a ReturnValue, convertible to true/false
Implemented in Navigation2D_nwc_yarp.
The documentation for this class was generated from the following file: