Nav2 Navigation Stack - humble  humble
ROS 2 Navigation Stack
Public Types | Public Member Functions | List of all members
nav2_route::GraphFileSaver Class Referenceabstract

A plugin interface to parse a file into the graph. More...

#include <nav2_route/include/nav2_route/interfaces/graph_file_saver.hpp>

Inheritance diagram for nav2_route::GraphFileSaver:
Inheritance graph
[legend]

Public Types

using Ptr = std::shared_ptr< GraphFileSaver >
 

Public Member Functions

 GraphFileSaver ()=default
 Constructor.
 
virtual ~GraphFileSaver ()=default
 Virtual destructor.
 
virtual void configure (const rclcpp_lifecycle::LifecycleNode::SharedPtr node)=0
 Configure the graph file saver, but do not store the node. More...
 
virtual bool saveGraphToFile (Graph &graph, std::string filepath)=0
 Method to save the graph to the filepath. More...
 

Detailed Description

A plugin interface to parse a file into the graph.

Definition at line 33 of file graph_file_saver.hpp.

Member Function Documentation

◆ configure()

virtual void nav2_route::GraphFileSaver::configure ( const rclcpp_lifecycle::LifecycleNode::SharedPtr  node)
pure virtual

Configure the graph file saver, but do not store the node.

Parameters
parentpointer to user's node

◆ saveGraphToFile()

virtual bool nav2_route::GraphFileSaver::saveGraphToFile ( Graph &  graph,
std::string  filepath 
)
pure virtual

Method to save the graph to the filepath.

Parameters
graphThe graph to save
filepathThe path to save the file to
Returns
true if graph was successfully saved

Implemented in nav2_route::GeoJsonGraphFileSaver.


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