LocalGuidance
A library that generates velocity references to follow a path.
navigation_common::PathSegmentLocalGuidance Class Reference

#include <PathSegmentLocalGuidance.hpp>

Inheritance diagram for navigation_common::PathSegmentLocalGuidance:
Inheritance graph

Public Types

using PathSegmentLocalGuidancePtr = std::shared_ptr< PathSegmentLocalGuidance >
 
- Public Types inherited from navigation_common::PathSegmentBase
using PathSegmentBasePtr = std::shared_ptr< PathSegmentBase >
 

Public Member Functions

 PathSegmentLocalGuidance ()=default
 
 PathSegmentLocalGuidance (const PoseStampedPtr &goal, const std::string local_guidance_mode, const bool &pass_through_goal)
 
 PathSegmentLocalGuidance (const navigation_msgs::PathSegmentLocalGuidance &msg)
 
virtual ~PathSegmentLocalGuidance () override=default
 
void fromRos (const navigation_msgs::PathSegmentLocalGuidance &msg)
 
navigation_msgs::PathSegmentLocalGuidance toRos () const
 
PathSegmentBasePtr getDeepCopy () const override
 
- Public Member Functions inherited from navigation_common::PathSegmentBase
 PathSegmentBase ()
 
 PathSegmentBase (PoseStampedPtr goal)
 
 PathSegmentBase (const PoseStamped &goal)
 
 PathSegmentBase (const PathSegmentBasePtr &pathSegmentBase)
 
virtual ~PathSegmentBase ()=default
 

Public Attributes

std::string local_guidance_mode_
 local guidance mode More...
 
bool pass_through_goal_
 Indicates if the gaol of this segment should be "passed through" the robot, i.e. the robot should reach its position and orientation. More...
 
- Public Attributes inherited from navigation_common::PathSegmentBase
PoseStampedPtr goal_
 Goal. More...
 

Additional Inherited Members

- Protected Member Functions inherited from navigation_common::PathSegmentBase
PathSegmentBasePtr getDeepCopyBase () const
 

Member Typedef Documentation

Constructor & Destructor Documentation

navigation_common::PathSegmentLocalGuidance::PathSegmentLocalGuidance ( )
default

Constructor.

navigation_common::PathSegmentLocalGuidance::PathSegmentLocalGuidance ( const PoseStampedPtr goal,
const std::string  local_guidance_mode,
const bool &  pass_through_goal 
)

Constructor.

Parameters
goalgoal.
local_guidance_modemode to be used from local_guidance_ros on this segment.
pass_through_goalspecifies if goal of this segment must be passed through by the robot.
navigation_common::PathSegmentLocalGuidance::PathSegmentLocalGuidance ( const navigation_msgs::PathSegmentLocalGuidance msg)
explicit

Constructor.

Parameters
msgros msg.
virtual navigation_common::PathSegmentLocalGuidance::~PathSegmentLocalGuidance ( )
overridevirtualdefault

Destructor.

Member Function Documentation

void navigation_common::PathSegmentLocalGuidance::fromRos ( const navigation_msgs::PathSegmentLocalGuidance msg)

Imports a ros msg.

Parameters
msgros msg.
PathSegmentBasePtr navigation_common::PathSegmentLocalGuidance::getDeepCopy ( ) const
overridevirtual

Create a deep copy of this path segment.

Returns
new path segment.

Reimplemented from navigation_common::PathSegmentBase.

navigation_msgs::PathSegmentLocalGuidance navigation_common::PathSegmentLocalGuidance::toRos ( ) const

Exports a ros msg.

Returns
ros msg.

Member Data Documentation

std::string navigation_common::PathSegmentLocalGuidance::local_guidance_mode_

local guidance mode

bool navigation_common::PathSegmentLocalGuidance::pass_through_goal_

Indicates if the gaol of this segment should be "passed through" the robot, i.e. the robot should reach its position and orientation.


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