26 target_frame_id(
"map"),
27 targetAllowedDistance(0.5),
28 targetIsRelative(false),
29 targetDesiredRelSpeed(.05),
30 targetIsIntermediaryWaypoint(false)
38 s +=
mrpt::format(
"target_coords = (%.03f,%.03f,%.03f deg)\n", target_coords.x, target_coords.y, target_coords.phi);
39 s +=
mrpt::format(
"target_frame_id = \"%s\"\n", target_frame_id.c_str());
40 s +=
mrpt::format(
"targetAllowedDistance = %.03f\n", targetAllowedDistance);
41 s +=
mrpt::format(
"targetIsRelative = %s\n", targetIsRelative ?
"YES" :
"NO");
42 s +=
mrpt::format(
"targetIsIntermediaryWaypoint = %s\n", targetIsIntermediaryWaypoint ?
"YES" :
"NO");
43 s +=
mrpt::format(
"targetDesiredRelSpeed = %.02f\n", targetDesiredRelSpeed);
62 s+=
"navparams. Single target:\n";
63 s+= target.getAsText();
70 return (rhs !=
nullptr) && (this->target == rhs->target);
87 mrpt::utils::COutputLogger(
"MRPT_navigator"),
104 this->setVerbosityLevel(mrpt::utils::LVL_DEBUG);
212 MRPT_LOG_INFO(
"[CAbstractNavigator::navigationStep()] Navigation stopped.");
233 MRPT_LOG_ERROR(
"[CAbstractNavigator::navigationStep()] Stoping Navigation due to a NAV_ERROR state!");
254 if (ev.event_noargs !=
nullptr) {
255 (
m_robot.*(ev.event_noargs))();
257 else if (ev.event_wp_reached) {
260 else if (ev.event_new_wp) {
263 else if (ev.event_cannot_get_closer_target) {
269 MRPT_LOG_WARN(
"sendCannotGetCloserToBlockedTargetEvent() told me to abort navigation.");
315 ASSERT_(
params->target.targetDesiredRelSpeed >= .0 &&
params->target.targetDesiredRelSpeed <= 1.0);
355 const double MIN_TIME_BETWEEN_POSE_UPDATES = 20e-3;
359 if (last_call_age < MIN_TIME_BETWEEN_POSE_UPDATES)
361 MRPT_LOG_THROTTLE_DEBUG_FMT(5.0,
"updateCurrentPoseAndSpeeds: ignoring call, since last call was only %f ms ago.", last_call_age*1e3);
378 MRPT_LOG_ERROR(
"ERROR calling m_robot.getCurrentPoseAndSpeeds, stopping robot and finishing navigation");
379 throw std::runtime_error(
"ERROR calling m_robot.getCurrentPoseAndSpeeds, stopping robot and finishing navigation");
389 if (changed_frame_id)
428 dist_to_target_for_sending_event(0),
429 alarm_seems_not_approaching_target_timeout(30),
430 dist_check_target_is_blocked(0.6),
431 hysteresis_check_target_is_blocked(3)
443 MRPT_SAVE_CONFIG_VAR_COMMENT(dist_to_target_for_sending_event,
"Default value=0, means use the `targetAllowedDistance` passed by the user in the navigation request.");
445 MRPT_SAVE_CONFIG_VAR_COMMENT(dist_check_target_is_blocked,
"When closer than this distance, check if the target is blocked to abort navigation with an error. [Default=0.6 m]");
446 MRPT_SAVE_CONFIG_VAR_COMMENT(hysteresis_check_target_is_blocked,
"How many steps should the condition for dist_check_target_is_blocked be fulfilled to raise an event");
451 return typeid(
a) ==
typeid(
b) &&
a.isEqual(
b);
456 return (targetDist < m_navigationParams->target.targetAllowedDistance);
474 MRPT_LOG_INFO(
"[CAbstractNavigator::navigationStep()] Starting Navigation. Watchdog initiated...\n");
518 MRPT_LOG_DEBUG(
"[CAbstractNavigator::performNavigationStepNavigating] Enqueuing NavigationEndEvent (reason: targetDist<dist_to_target_for_sending_event).");
536 MRPT_LOG_DEBUG(
"[CAbstractNavigator::performNavigationStepNavigating] Enqueuing NavigationEndEvent (reason: checkHasReachedTarget()=true).");
554 MRPT_LOG_WARN(
"Timeout approaching the target. Aborting navigation.");
578 MRPT_LOG_THROTTLE_WARN(5.0,
"Target seems to be blocked by obstacles. Invoking sendCannotGetCloserToBlockedTargetEvent().");
595 if (call_virtual_nav_method) {
599 catch (std::exception &e)
620 MRPT_LOG_ERROR(
"[CAbstractNavigator::navigationStep] Untyped exception!");
633 event_noargs(nullptr),
634 event_wp_reached(false),
636 event_cannot_get_closer_target(false)
const double PREVIOUS_POSES_MAX_AGE
#define MRPT_SAVE_CONFIG_VAR_COMMENT(variableName, __comment)
#define MRPT_LOAD_CONFIG_VAR_CS(variableName, variableType)
Shortcut for MRPT_LOAD_CONFIG_VAR() for config file object named c and section string named s
#define MRPT_LOG_WARN(_STRING)
#define MRPT_LOG_THROTTLE_WARN(_PERIOD_SECONDS, _STRING)
#define MRPT_LOG_THROTTLE_DEBUG_FMT(_PERIOD_SECONDS, _FMT_STRING,...)
#define MRPT_LOG_ERROR(_STRING)
#define MRPT_LOG_DEBUG(_STRING)
#define MRPT_LOG_INFO(_STRING)
#define MRPT_LOG_ERROR_FMT(_FMT_STRING,...)
Virtual base for velocity commands of different kinematic models of planar mobile robot.
mrpt::poses::CPose2DInterpolator m_latestOdomPoses
Latest robot poses (updated in CAbstractNavigator::navigationStep() )
std::list< TPendingEvent > m_pending_events
Events generated during navigationStep(), enqueued to be called at the end of the method execution to...
mrpt::synch::CCriticalSectionRecursive m_nav_cs
mutex for all navigation methods
virtual bool checkHasReachedTarget(const double targetDist) const
Default implementation: check if target_dist is below the accepted distance.
CRobot2NavInterface & m_robot
The navigator-robot interface.
std::string m_last_curPoseVelUpdate_pose_frame_id
@ ERR_CANNOT_REACH_TARGET
TState m_navigationState
Current internal state of navigator:
virtual void onNavigateCommandReceived()
Called after each call to CAbstractNavigator::navigate()
void dispatchPendingNavEvents()
virtual void doEmergencyStop(const std::string &msg)
Stops the robot and set navigation state to error.
virtual void resume()
Continues with suspended navigation.
virtual ~CAbstractNavigator()
dtor
mrpt::utils::CTimeLogger m_timlog_delays
Time logger to collect delay-related stats.
virtual void cancel()
Cancel current navegation.
virtual void suspend()
Suspend current navegation.
virtual void navigate(const TNavigationParams *params)
Navigation request to a single target location.
mrpt::system::TTimeStamp m_badNavAlarm_lastMinDistTime
TErrorReason m_navErrorReason
TNavigationParams * m_navigationParams
Current navigation parameters.
bool m_navigationEndEventSent
Will be false until the navigation end is sent, and it is reset with each new command.
virtual void navigationStep()
This method must be called periodically in order to effectively run the navigation.
virtual void processNavigateCommand(const TNavigationParams *params)
Does the job of navigate(), except the call to onNavigateCommandReceived()
virtual bool changeSpeedsNOP()
Default: forward call to m_robot.changeSpeedsNOP(). Can be overriden.
TRobotPoseVel m_curPoseVel
Current robot pose (updated in CAbstractNavigator::navigationStep() )
virtual bool stop(bool isEmergencyStop)
Default: forward call to m_robot.stop(). Can be overriden.
virtual bool checkCollisionWithLatestObstacles(const mrpt::math::TPose2D &relative_robot_pose) const
Checks whether the robot shape, when placed at the given pose (relative to the current pose),...
void internal_onStartNewNavigation()
Called before starting a new navigation.
virtual void resetNavError()
Resets a NAV_ERROR state back to IDLE
virtual void onStartNewNavigation()=0
Called whenever a new navigation has been started.
double m_badNavAlarm_minDistTarget
For sending an alarm (error event) when it seems that we are not approaching toward the target in a w...
virtual bool changeSpeeds(const mrpt::kinematics::CVehicleVelCmd &vel_cmd)
Default: forward call to m_robot.changeSpeed(). Can be overriden.
virtual void saveConfigFile(mrpt::utils::CConfigFileBase &c) const
Saves all current options to a config file.
virtual void performNavigationStepNavigating(bool call_virtual_nav_method=true)
Factorization of the part inside navigationStep(), for the case of state being NAVIGATING.
void setFrameTF(mrpt::poses::FrameTransformer< 2 > *frame_tf)
Sets a user-provided frame transformer object; used only if providing targets in a frame ID different...
TState m_lastNavigationState
Last internal state of navigator:
virtual void loadConfigFile(const mrpt::utils::CConfigFileBase &c)
Loads all params from a file.
TAbstractNavigatorParams params_abstract_navigator
virtual void updateCurrentPoseAndSpeeds()
Call to the robot getCurrentPoseAndSpeeds() and updates members m_curPoseVel accordingly.
bool m_rethrow_exceptions
int m_counter_check_target_is_blocked
mrpt::poses::CPose2DInterpolator m_latestPoses
TState
The different states for the navigation system.
@ NAV_ERROR
In this case, use getErrorReason()
CAbstractNavigator(CRobot2NavInterface &robot_interface_impl)
ctor
virtual void performNavigationStep()=0
To be implemented in derived classes.
mrpt::poses::FrameTransformer< 2 > * m_frame_tf
Optional, user-provided frame transformer.
double m_last_curPoseVelUpdate_robot_time
The pure virtual interface between a real or simulated robot and any CAbstractNavigator-derived class...
virtual void sendWaySeemsBlockedEvent()
Callback: No progression made towards target for a predefined period of time.
virtual void sendNewWaypointTargetEvent(int waypoint_index)
Callback: Heading towards a new intermediary/final waypoint in waypoint list navigation.
virtual void sendCannotGetCloserToBlockedTargetEvent(bool &do_abort_nav)
Callback: Target seems to be blocked by an obstacle.
virtual bool stop(bool isEmergencyStop=true)=0
Stop the robot right now.
virtual void sendNavigationEndDueToErrorEvent()
Callback: Error asking sensory data from robot or sending motor commands.
virtual bool changeSpeeds(const mrpt::kinematics::CVehicleVelCmd &vel_cmd)=0
Sends a velocity command to the robot.
virtual bool stopWatchdog()
Stop the watchdog timer.
virtual double getNavigationTime()
Returns the number of seconds ellapsed since the constructor of this class was invoked,...
virtual bool getCurrentPoseAndSpeeds(mrpt::math::TPose2D &curPose, mrpt::math::TTwist2D &curVelGlobal, mrpt::system::TTimeStamp ×tamp, mrpt::math::TPose2D &curOdometry, std::string &frame_id)=0
Get the current pose and velocity of the robot.
virtual void sendNavigationStartEvent()
Callback: Start of navigation command.
virtual bool startWatchdog(float T_ms)
Start the watchdog timer of the robot platform, if any, for maximum expected delay between consecutiv...
virtual void sendNavigationEndEvent()
Callback: End of navigation command (reach of single goal, or final waypoint of waypoint list)
virtual bool changeSpeedsNOP()
Just like changeSpeeds(), but will be called when the last velocity command is still the preferred so...
virtual void sendWaypointReachedEvent(int waypoint_index, bool reached_nSkipped)
Callback: Reached an intermediary waypoint in waypoint list navigation.
void insert(mrpt::system::TTimeStamp t, const pose_t &p)
Inserts a new pose in the sequence.
iterator erase(iterator element_to_erase)
void clear()
Clears the current sequence of poses.
reverse_iterator rbegin()
void setInterpolationMethod(TInterpolatorMethod method)
Change the method used to interpolate the robot path. The default method at construction is "imSpline...
A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.
This class allows loading and storing values and vectors of different types from a configuration text...
This class implements a config file-like interface over a memory-stored string list.
void getContent(std::string &str) const
Return the current contents of the virtual "config file".
#define INVALID_TIMESTAMP
Represents an invalid timestamp, where applicable.
GLubyte GLubyte GLubyte a
GLenum const GLfloat * params
GLsizei const GLchar ** string
double BASE_IMPEXP timeDifference(const mrpt::system::TTimeStamp t_first, const mrpt::system::TTimeStamp t_later)
Returns the time difference from t1 to t2 (positive if t2 is posterior to t1), in seconds.
mrpt::system::TTimeStamp BASE_IMPEXP getCurrentTime()
Returns the current (UTC) system time.
bool NAV_IMPEXP operator==(const CAbstractNavigator::TNavigationParamsBase &, const CAbstractNavigator::TNavigationParamsBase &)
void delete_safe(T *&ptr)
Calls "delete" to free an object only if the pointer is not NULL, then set the pointer to NULL.
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
std::string BASE_IMPEXP format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
double phi
Orientation (rads)
2D segment, consisting of two points.
double distance(const TPoint2D &point) const
Distance to point.
void rotate(const double ang)
Transform the (vx,vy) components for a counterclockwise rotation of ang radians.
TAbstractNavigatorParams()
double dist_check_target_is_blocked
(Default value=0.6) When closer than this distance, check if the target is blocked to abort navigatio...
int hysteresis_check_target_is_blocked
virtual void loadFromConfigFile(const mrpt::utils::CConfigFileBase &c, const std::string &s) MRPT_OVERRIDE
This method load the options from a ".ini"-like file or memory-stored string list.
double dist_to_target_for_sending_event
Default value=0, means use the "targetAllowedDistance" passed by the user in the navigation request.
virtual void saveToConfigFile(mrpt::utils::CConfigFileBase &c, const std::string &s) const MRPT_OVERRIDE
This method saves the options to a ".ini"-like file or memory-stored string list.
double alarm_seems_not_approaching_target_timeout
navigator timeout (seconds) [Default=30 sec]
std::string error_msg
Human friendly description of the error.
Base for all high-level navigation commands.
The struct for configuring navigation requests.
virtual bool isEqual(const TNavigationParamsBase &o) const MRPT_OVERRIDE
virtual TNavigationParams * clone() const
TargetInfo target
Navigation target.
virtual std::string getAsText() const MRPT_OVERRIDE
Gets navigation params as a human-readable format.
bool event_cannot_get_closer_target
functor_event_void_t event_noargs
event w/o arguments
mrpt::math::TPose2D rawOdometry
raw odometry (frame does not match to "pose", but is expected to be smoother in the short term).
mrpt::system::TTimeStamp timestamp
mrpt::math::TTwist2D velLocal
std::string pose_frame_id
map frame ID for pose
mrpt::math::TTwist2D velGlobal
Individual target info in CAbstractNavigator::TNavigationParamsBase and derived classes.
std::string target_frame_id
(Default="map") Frame ID in which target is given. Optional, use only for submapping applications.
mrpt::math::TPose2D target_coords
Coordinates of desired target location. Heading may be ignored by some reactive implementations.
bool operator==(const TargetInfo &o) const
double targetDesiredRelSpeed
(Default=.05) Desired relative speed (wrt maximum speed), in range [0,1], of the vehicle at target....
float targetAllowedDistance
(Default=0.5 meters) Allowed distance to target in order to end the navigation.
std::string getAsText() const
Gets navigation params as a human-readable format.
bool targetIsIntermediaryWaypoint
bool targetIsRelative
(Default=false) Whether the target coordinates are in global coordinates (false) or are relative to t...
A safe way to call enter() and leave() of a mrpt::utils::CTimeLogger upon construction and destructio...