nav2_bt_navigator::NavigatorMuxer Class Reference

A class to control the state of the BT navigator by allowing only a single plugin to be processed at a time. More...

#include <nav2_bt_navigator/include/nav2_bt_navigator/navigator.hpp>

Collaboration diagram for nav2_bt_navigator::NavigatorMuxer:

Public Member Functions
	NavigatorMuxer ()
	A Navigator Muxer constructor.
bool	isNavigating ()
	Get the navigator muxer state. More...
void	startNavigating (const std::string &navigator_name)
	Start navigating with a given navigator. More...
void	stopNavigating (const std::string &navigator_name)
	Stop navigating with a given navigator. More...

Protected Attributes
std::string	current_navigator_
std::mutex	mutex_

Detailed Description

A class to control the state of the BT navigator by allowing only a single plugin to be processed at a time.

Definition at line 50 of file navigator.hpp.

Member Function Documentation

isNavigating()

bool nav2_bt_navigator::NavigatorMuxer::isNavigating ( )

inline

Get the navigator muxer state.

Returns

bool If a navigator is in progress

Definition at line 63 of file navigator.hpp.

Referenced by nav2_bt_navigator::Navigator< ActionT >::onGoalReceived().

Here is the caller graph for this function:

startNavigating()

void nav2_bt_navigator::NavigatorMuxer::startNavigating ( const std::string &  navigator_name )

inline

Start navigating with a given navigator.

Parameters

string

Name of the navigator to start

Definition at line 73 of file navigator.hpp.

Referenced by nav2_bt_navigator::Navigator< ActionT >::onGoalReceived().

Here is the caller graph for this function:

stopNavigating()

void nav2_bt_navigator::NavigatorMuxer::stopNavigating ( const std::string &  navigator_name )

inline

Stop navigating with a given navigator.

Parameters

string

Name of the navigator ending task

Definition at line 90 of file navigator.hpp.

Referenced by nav2_bt_navigator::Navigator< ActionT >::onCompletion().

Here is the caller graph for this function:

---

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

• nav2_bt_navigator/include/nav2_bt_navigator/navigator.hpp