armarx::navigation::client Namespace Reference

This file is part of ArmarX. More...

Namespaces

namespace  detail
 

Classes

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

Typedefs

using GlobalPlanningFailedCallback
 
using GlobalTrajectoryUpdatedCallback
 
using LocalPlanningFailedCallback = std::function<void(const core::LocalPlanningFailedEvent&)>
 
using LocalTrajectoryUpdatedCallback
 
using NavigatorHandlePtr = std::unique_ptr<core::NavigatorInterface>
 
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
 
using OnSafetyThrottlingTriggeredCallback
 
using OnUserAbortTriggeredCallback = std::function<void(const core::UserAbortTriggeredEvent&)>
 
using OnWaypointReachedCallback = std::function<void(const core::WaypointReachedEvent&)>
 
using TrajectoryControllerUpdatedCallback
 
using WaypointTargets = std::vector<WaypointTarget>
 

Enumerations

enum class  GlobalPlanningStrategy { Free , Point2Point }
 

Functions

client::GlobalPlanningStrategy defrost (const client::detail::GlobalPlanningStrategy &strategy)
 
core::TargetAlternative defrost (const client::detail::TargetAlternative &alternative)
 
std::vector< core::TargetAlternativedefrost (const client::detail::TargetAlternatives &alternatives)
 
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)
 
client::detail::TargetAlternative freeze (const core::TargetAlternative &alternative)
 
client::detail::TargetAlternatives freeze (const std::vector< core::TargetAlternative > &alternatives)
 
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

◆ GlobalTrajectoryUpdatedCallback

Initial value:
std::function<void(const core::GlobalTrajectoryUpdatedEvent&)>
Event describing that the global trajectory was updated.
Definition events.h:114

Definition at line 11 of file EventSubscriptionInterface.h.

◆ LocalPlanningFailedCallback

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

Definition at line 20 of file EventSubscriptionInterface.h.

◆ LocalTrajectoryUpdatedCallback

Initial value:
std::function<void(const core::LocalTrajectoryUpdatedEvent&)>
Event describing that the local trajectory was updated.
Definition events.h:122

Definition at line 13 of file EventSubscriptionInterface.h.

◆ NavigatorHandlePtr

using NavigatorHandlePtr = std::unique_ptr<core::NavigatorInterface>

Definition at line 16 of file IceNavigatorFactory.h.

◆ OnGoalReachedCallback

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

Definition at line 24 of file EventSubscriptionInterface.h.

◆ OnInternalErrorCallback

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

Definition at line 31 of file EventSubscriptionInterface.h.

◆ OnMovementStartedCallback

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

Definition at line 22 of file EventSubscriptionInterface.h.

◆ OnSafetyStopTriggeredCallback

Initial value:
std::function<void(const core::SafetyStopTriggeredEvent&)>
Event describing that for security reasons, the robot was stopped completely.
Definition events.h:88

Definition at line 28 of file EventSubscriptionInterface.h.

◆ OnSafetyThrottlingTriggeredCallback

Initial value:
std::function<void(const core::SafetyThrottlingTriggeredEvent&)>
Event desciribing that a significant safety throttling factor was reached.
Definition events.h:72

Definition at line 26 of file EventSubscriptionInterface.h.

◆ OnUserAbortTriggeredCallback

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

Definition at line 30 of file EventSubscriptionInterface.h.

◆ OnWaypointReachedCallback

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

Definition at line 25 of file EventSubscriptionInterface.h.

◆ TrajectoryControllerUpdatedCallback

◆ WaypointTargets

using WaypointTargets = std::vector<WaypointTarget>

Definition at line 82 of file ice_conversions.h.

Enumeration Type Documentation

◆ GlobalPlanningStrategy

enum class GlobalPlanningStrategy
strong
Enumerator
Free 
Point2Point 

Definition at line 27 of file types.h.

Function Documentation

◆ defrost() [1/5]

Definition at line 22 of file ice_conversions.cpp.

+ Here is the caller graph for this function:

◆ defrost() [2/5]

Definition at line 85 of file ice_conversions.cpp.

◆ defrost() [3/5]

std::vector< core::TargetAlternative > defrost ( const client::detail::TargetAlternatives & alternatives)

Definition at line 94 of file ice_conversions.cpp.

◆ defrost() [4/5]

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

Definition at line 44 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ defrost() [5/5]

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

Definition at line 71 of file ice_conversions.cpp.

◆ freeze() [1/5]

Definition at line 108 of file ice_conversions.cpp.

+ Here is the caller graph for this function:

◆ freeze() [2/5]

Definition at line 129 of file ice_conversions.cpp.

+ Here is the call graph for this function:

◆ freeze() [3/5]

Definition at line 138 of file ice_conversions.cpp.

◆ freeze() [4/5]

Definition at line 152 of file ice_conversions.cpp.

◆ freeze() [5/5]

client::detail::TargetAlternatives freeze ( const std::vector< core::TargetAlternative > & alternatives)

Definition at line 161 of file ice_conversions.cpp.

◆ fromAron()

template<typename AronEventT, typename EventT>
auto fromAron ( const armem::wm::EntityInstance & entity,
EventT & bo )

Definition at line 77 of file MemoryPolling.cpp.

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

◆ operator<<()

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

Definition at line 50 of file ice_conversions.h.

+ Here is the call graph for this function:

◆ validate()

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

Definition at line 71 of file ice_conversions.h.

+ Here is the caller graph for this function: