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 moveToLocation (const std::string &location)
 
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 stop ()
 
void update (const std::vector< core::Pose > &waypoints, core::NavigationFrame frame)
 
StopEvent waitForStop (std::int64_t timeoutMs=-1)
 

Detailed Description

Definition at line 115 of file Navigator.h.

Constructor & Destructor Documentation

◆ Navigator()

Navigator ( const InjectedServices &  services)

Definition at line 18 of file Navigator.cpp.

Member Function Documentation

◆ moveTo() [1/3]

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

Definition at line 36 of file Navigator.cpp.

◆ moveTo() [2/3]

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

Definition at line 59 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 44 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ moveToLocation()

void moveToLocation ( const std::string &  location)

Definition at line 99 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ moveTowards()

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

Definition at line 85 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ onGoalReached() [1/2]

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

Definition at line 150 of file Navigator.cpp.

◆ onGoalReached() [2/2]

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

Definition at line 142 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 156 of file Navigator.cpp.

◆ pause()

void pause ( )

Definition at line 115 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ resume()

void resume ( )

Definition at line 124 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ stop()

void stop ( )

Definition at line 133 of file Navigator.cpp.

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

◆ update()

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

Definition at line 76 of file Navigator.cpp.

+ Here is the call graph for this function:

◆ waitForStop()

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

Definition at line 162 of file Navigator.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ cv

std::condition_variable cv

Definition at line 160 of file Navigator.h.

◆ event

std::optional<StopEvent> event

Definition at line 161 of file Navigator.h.

◆ m

std::mutex m

Definition at line 159 of file Navigator.h.

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