armarx::navigation::client Namespace Reference

This file is part of ArmarX. More...

Namespaces

 detail
 

Classes

class  ComponentPlugin
 
class  ComponentPluginUser
 
struct  Config
 
class  EventSubscriptionInterface
 
struct  GeneralConfig
 
class  IceNavigator
 
class  MemoryPolling
 
class  MemorySubscriber
 
class  NavigationStackConfig
 
class  Navigator
 
interface  NavigatorInterface
 
class  PathBuilder
 
class  SimpleEventHandler
 
class  StopEvent
 
struct  WaypointTarget
 

Typedefs

using GlobalPlanningFailedCallback = std::function< void(const core::GlobalPlanningFailedEvent &)>
 
using GlobalTrajectoryUpdatedCallback = std::function< void(const global_planning::GlobalPlannerResult &)>
 
using LocalPlanningFailedCallback = std::function< void(const core::LocalPlanningFailedEvent &)>
 
using LocalTrajectoryUpdatedCallback = std::function< void(const local_planning::LocalPlannerResult &)>
 
using OnGoalReachedCallback = std::function< void(const core::GoalReachedEvent &)>
 
using OnInternalErrorCallback = std::function< void(const core::InternalErrorEvent &)>
 
using OnMovementStartedCallback = std::function< void(const core::MovementStartedEvent &)>
 
using OnSafetyStopTriggeredCallback = std::function< void(const core::SafetyStopTriggeredEvent &)>
 
using OnSafetyThrottlingTriggeredCallback = std::function< void(const core::SafetyThrottlingTriggeredEvent &)>
 
using OnUserAbortTriggeredCallback = std::function< void(const core::UserAbortTriggeredEvent &)>
 
using OnWaypointReachedCallback = std::function< void(const core::WaypointReachedEvent &)>
 
using TrajectoryControllerUpdatedCallback = std::function< void(const traj_ctrl::local::TrajectoryControllerResult &)>
 
using WaypointTargets = std::vector< WaypointTarget >
 

Enumerations

enum  GlobalPlanningStrategy { Free, Point2Point }
 

Functions

std::vector< Eigen::Matrix4f > convert (const std::vector< armarx::navigation::core::Pose > &ps)
 
client::GlobalPlanningStrategy defrost (const client::detail::GlobalPlanningStrategy &strategy)
 
WaypointTarget defrost (const client::detail::Waypoint &waypoint)
 
WaypointTargets defrost (const client::detail::Waypoints &waypoints)
 
client::detail::GlobalPlanningStrategy freeze (const client::GlobalPlanningStrategy &strategy)
 
client::detail::Waypoint freeze (const client::WaypointTarget &target)
 
client::detail::Waypoints freeze (const client::WaypointTargets &targets)
 
template<typename AronEventT , typename EventT >
auto fromAron (const armem::wm::EntityInstance &entity, EventT &bo)
 
std::ostream & operator<< (std::ostream &str, const WaypointTarget &res)
 
void validate (const std::vector< WaypointTarget > &path)
 

Detailed Description

This file is part of ArmarX.

ArmarX is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

ArmarX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author
Fabian Reister ( fabian dot reister at kit dot edu )
Date
2021

ArmarX is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

ArmarX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author
Fabian Reister ( fabian dot reister at kit dot edu )
Christian R. G. Dreher ( c dot dreher at kit dot edu )
Date
2021

Typedef Documentation

◆ GlobalPlanningFailedCallback

Definition at line 21 of file EventSubscriptionInterface.h.

◆ GlobalTrajectoryUpdatedCallback

Definition at line 15 of file EventSubscriptionInterface.h.

◆ LocalPlanningFailedCallback

using LocalPlanningFailedCallback = std::function<void(const core::LocalPlanningFailedEvent&)>

Definition at line 23 of file EventSubscriptionInterface.h.

◆ LocalTrajectoryUpdatedCallback

Definition at line 17 of file EventSubscriptionInterface.h.

◆ OnGoalReachedCallback

using OnGoalReachedCallback = std::function<void(const core::GoalReachedEvent&)>

Definition at line 27 of file EventSubscriptionInterface.h.

◆ OnInternalErrorCallback

using OnInternalErrorCallback = std::function<void(const core::InternalErrorEvent&)>

Definition at line 34 of file EventSubscriptionInterface.h.

◆ OnMovementStartedCallback

using OnMovementStartedCallback = std::function<void(const core::MovementStartedEvent&)>

Definition at line 25 of file EventSubscriptionInterface.h.

◆ OnSafetyStopTriggeredCallback

Definition at line 32 of file EventSubscriptionInterface.h.

◆ OnSafetyThrottlingTriggeredCallback

Definition at line 30 of file EventSubscriptionInterface.h.

◆ OnUserAbortTriggeredCallback

using OnUserAbortTriggeredCallback = std::function<void(const core::UserAbortTriggeredEvent&)>

Definition at line 33 of file EventSubscriptionInterface.h.

◆ OnWaypointReachedCallback

using OnWaypointReachedCallback = std::function<void(const core::WaypointReachedEvent&)>

Definition at line 28 of file EventSubscriptionInterface.h.

◆ TrajectoryControllerUpdatedCallback

◆ WaypointTargets

using WaypointTargets = std::vector<WaypointTarget>

Definition at line 81 of file ice_conversions.h.

Enumeration Type Documentation

◆ GlobalPlanningStrategy

Enumerator
Free 
Point2Point 

Definition at line 27 of file types.h.

Function Documentation

◆ convert()

std::vector<Eigen::Matrix4f> armarx::navigation::client::convert ( const std::vector< armarx::navigation::core::Pose > &  ps)

Definition at line 12 of file IceNavigator.cpp.

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

◆ defrost() [1/3]

Definition at line 16 of file ice_conversions.cpp.

+ Here is the caller graph for this function:

◆ defrost() [2/3]

WaypointTarget defrost ( const client::detail::Waypoint waypoint)

Definition at line 37 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ defrost() [3/3]

WaypointTargets defrost ( const client::detail::Waypoints waypoints)

Definition at line 63 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ freeze() [1/3]

Definition at line 77 of file ice_conversions.cpp.

+ Here is the caller graph for this function:

◆ freeze() [2/3]

Definition at line 98 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ freeze() [3/3]

Definition at line 107 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ fromAron()

auto fromAron ( const armem::wm::EntityInstance entity,
EventT &  bo 
)

Definition at line 67 of file MemoryPolling.cpp.

+ Here is the call graph for this function:

◆ operator<<()

std::ostream& armarx::navigation::client::operator<< ( std::ostream &  str,
const WaypointTarget res 
)
inline

Definition at line 49 of file ice_conversions.h.

+ Here is the call graph for this function:

◆ validate()

void armarx::navigation::client::validate ( const std::vector< WaypointTarget > &  path)
inline

Definition at line 70 of file ice_conversions.h.

+ Here is the caller graph for this function: