Skip to content

Commit

Permalink
added docs to saveLayers
Browse files Browse the repository at this point in the history
  • Loading branch information
amock committed Nov 19, 2024
1 parent c087a33 commit 2b95a06
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion mesh_map/include/mesh_map/mesh_map.h
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,14 @@ class MeshMap
mesh_map::AbstractLayer::Ptr layer(const std::string& layer_name);

/**
* @brief calls 'saveLayer' on every active layer
* @brief calls 'saveLayer' on every active layer. Every layer itself writes its costs
* to the working file / part to a dataset named after the layer-name.
*
* Example:
* - Working file: "my_map.h5"
* - Working mesh part: "my_mesh_part"
*
* A BorderLayer of name 'border' would write the costs to "my_map.h5/my_mesh_part/channels/border"
*/
void saveLayers();

Expand Down

0 comments on commit 2b95a06

Please sign in to comment.