Added comment about size of the returning submap.

plkms · Mar 24, 2016 · e93d7aa · e93d7aa
1 parent 3791422
commit e93d7aa
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/grid_map_core/include/grid_map_core/GridMap.hpp b/grid_map_core/include/grid_map_core/GridMap.hpp
@@ -268,6 +268,8 @@ class GridMap
   /*!
    * Gets a submap from the map. The requested submap is specified with the requested
    * location and length.
+   * Note: The returned submap may not have the requested length due to the borders
+   * of the map and discretization.
    * @param[in] position the requested position of the submap (usually the center).
    * @param[in] length the requested length of the submap.
    * @param[out] isSuccess true if successful, false otherwise.
@@ -278,6 +280,8 @@ class GridMap
   /*!
    * Gets a submap from the map. The requested submap is specified with the requested
    * location and length.
+   * Note: The returned submap may not have the requested length due to the borders
+   * of the map and discretization.
    * @param[in] position the requested position of the submap (usually the center).
    * @param[in] length the requested length of the submap.
    * @param[out] indexInSubmap the index of the requested position in the submap.