Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Member Functions | Public Attributes | List of all members
nav2_smac_planner::NodeBasic< NodeT > Class Template Reference

NodeBasic implementation for priority queue insertion. More...

#include <nav2_smac_planner/include/nav2_smac_planner/node_basic.hpp>

Collaboration diagram for nav2_smac_planner::NodeBasic< NodeT >:
Collaboration graph
[legend]

Public Member Functions

 NodeBasic (const uint64_t new_index)
 A constructor for nav2_smac_planner::NodeBasic. More...
 
void populateSearchNode (NodeT *&node)
 Take a NodeBasic and populate it with any necessary state cached in the queue for NodeT. More...
 
void processSearchNode ()
 Take a NodeBasic and populate it with any necessary state cached in the queue for NodeTs. More...
 
void processSearchNode ()
 
void processSearchNode ()
 
void populateSearchNode (Node2D *&node)
 
void populateSearchNode (NodeHybrid *&node)
 
void populateSearchNode (NodeLattice *&node)
 

Public Attributes

NodeT::Coordinates pose
 
NodeT * graph_node_ptr
 
MotionPrimitiveprim_ptr
 
uint64_t index
 
unsigned int motion_index
 
bool backward
 
TurnDirection turn_dir
 

Detailed Description

template<typename NodeT>
class nav2_smac_planner::NodeBasic< NodeT >

NodeBasic implementation for priority queue insertion.

Definition at line 33 of file node_basic.hpp.

Constructor & Destructor Documentation

◆ NodeBasic()

template<typename NodeT >
nav2_smac_planner::NodeBasic< NodeT >::NodeBasic ( const uint64_t  new_index)
inlineexplicit

A constructor for nav2_smac_planner::NodeBasic.

Parameters
indexThe index of this node for self-reference

Definition at line 40 of file node_basic.hpp.

Member Function Documentation

◆ populateSearchNode()

template<typename NodeT >
void nav2_smac_planner::NodeBasic< NodeT >::populateSearchNode ( NodeT *&  node)

Take a NodeBasic and populate it with any necessary state cached in the queue for NodeT.

Parameters
nodeNodeT ptr to populate metadata into NodeBasic

Referenced by nav2_smac_planner::AStarAlgorithm< NodeT >::addNode().

Here is the caller graph for this function:

◆ processSearchNode()

template<typename Node2D >
void nav2_smac_planner::NodeBasic< Node2D >::processSearchNode

Take a NodeBasic and populate it with any necessary state cached in the queue for NodeTs.

Parameters
nodeSearch node (basic) object to initialize internal node with state

Definition at line 21 of file node_basic.cpp.

Referenced by nav2_smac_planner::AStarAlgorithm< NodeT >::getNextNode().

Here is the caller graph for this function:

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