List of all members | Classes | Public Member Functions
Navigator Class Reference

#include <armarx/navigation/client/Navigator.h>

Classes

struct  InjectedServices
 

Public Member Functions

void moveTo (const core::Pose &pose, core::NavigationFrame frame)
 
void moveTo (const PathBuilder &builder, core::NavigationFrame frame)
 
void moveTo (const std::vector< core::Pose > &waypoints, core::NavigationFrame frame)
 
void moveToAlternatives (const std::vector< core::TargetAlternative > &targets, core::NavigationFrame frame)
 
void moveToLocation (const std::string &location, const std::optional< std::string > &providerName)
 
void moveTowards (const core::Direction &direction, core::NavigationFrame frame)
 
 Navigator (const InjectedServices &services)
 
void onGoalReached (const std::function< void(const core::GoalReachedEvent &)> &callback)
 
void onGoalReached (const std::function< void(void)> &callback)
 
void onWaypointReached (const std::function< void(int)> &callback)
 
void pause ()
 
void resume ()
 
void setVelocityFactor (float velocityFactor)
 
void stop ()
 
void update (const std::vector< core::Pose > &waypoints, core::NavigationFrame frame)
 
StopEvent waitForStop (std::int64_t timeoutMs=-1)
 

Detailed Description

Definition at line 128 of file Navigator.h.

Constructor & Destructor Documentation

◆ Navigator()

Navigator ( const InjectedServices & services)

Definition at line 25 of file Navigator.cpp.

Member Function Documentation

◆ moveTo() [1/3]

void moveTo ( const core::Pose & pose,
core::NavigationFrame frame )

Definition at line 42 of file Navigator.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ moveTo() [2/3]

void moveTo ( const PathBuilder & builder,
core::NavigationFrame frame )

Definition at line 63 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ moveTo() [3/3]

void moveTo ( const std::vector< core::Pose > & waypoints,
core::NavigationFrame frame )

Definition at line 49 of file Navigator.cpp.

◆ moveToAlternatives()

void moveToAlternatives ( const std::vector< core::TargetAlternative > & targets,
core::NavigationFrame frame )

Definition at line 81 of file Navigator.cpp.

◆ moveToLocation()

void moveToLocation ( const std::string & location,
const std::optional< std::string > & providerName )

Definition at line 121 of file Navigator.cpp.

◆ moveTowards()

void moveTowards ( const core::Direction & direction,
core::NavigationFrame frame )

Definition at line 106 of file Navigator.cpp.

◆ onGoalReached() [1/2]

void onGoalReached ( const std::function< void(const core::GoalReachedEvent &)> & callback)

Definition at line 176 of file Navigator.cpp.

◆ onGoalReached() [2/2]

void onGoalReached ( const std::function< void(void)> & callback)

Definition at line 169 of file Navigator.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onWaypointReached()

void onWaypointReached ( const std::function< void(int)> & callback)

Definition at line 181 of file Navigator.cpp.

◆ pause()

void pause ( )

Definition at line 145 of file Navigator.cpp.

◆ resume()

void resume ( )

Definition at line 153 of file Navigator.cpp.

◆ setVelocityFactor()

void setVelocityFactor ( float velocityFactor)

Definition at line 137 of file Navigator.cpp.

◆ stop()

void stop ( )

Definition at line 161 of file Navigator.cpp.

+ Here is the caller graph for this function:

◆ update()

void update ( const std::vector< core::Pose > & waypoints,
core::NavigationFrame frame )

Definition at line 97 of file Navigator.cpp.

◆ waitForStop()

StopEvent waitForStop ( std::int64_t timeoutMs = -1)

Definition at line 186 of file Navigator.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ cv

std::condition_variable cv

Definition at line 179 of file Navigator.h.

◆ event

std::optional<StopEvent> event

Definition at line 180 of file Navigator.h.

◆ m

std::mutex m

Definition at line 178 of file Navigator.h.

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