Placement surface configuration information. More...
#include <PlacementSurface.h>
Public Member Functions | |
| const std::string & | getNavFrameID () const |
| Navigation frame ID value accessor. | |
| PlacementSurface (const std::string &name="", const std::string &frame_id="", const std::string &nav_frame_id="", const geometry::Pose &pose=geometry::Pose(), const double width=0, const double depth=0, const double height=0) | |
| Create a new PlacementSurface. | |
| void | setNavFrameID (const std::string &nav_frame_id) |
| Navigation frame ID value mutator. | |
Private Attributes | |
| std::string | nav_frame_id_ |
Detailed Description
Placement surface configuration information.
A placement surface represents a section of a Surface that objects can be placed on. For example, the Surface object "Shelving Unit" might have multiple placement surfaces representing each shelf.
Definition at line 34 of file PlacementSurface.h.
Constructor & Destructor Documentation
| PlacementSurface::PlacementSurface | ( | const std::string & | name = "", |
| const std::string & | frame_id = "", |
||
| const std::string & | nav_frame_id = "", |
||
| const geometry::Pose & | pose = geometry::Pose(), |
||
| const double | width = 0, |
||
| const double | depth = 0, |
||
| const double | height = 0 |
||
| ) |
Create a new PlacementSurface.
Create a new empty PlacementSurface with the given name, frame ID, Pose (in reference to the surfaces' frame ID) and dimensions.
- Parameters:
-
name The name of the PlacementSurface (defaults to the empty string). frame_id The frame ID of the PlacementSurface (defaults to the empty string). nav_frame_id The navigation frame ID of the PlacementSurface (defaults to the empty string). pose The Pose of the PlacementSurface with respect to the Surface (defaults to 0 Pose). width The width of the PlacementSurface (along the x-axis) (defaults to 0). depth The width of the PlacementSurface (along the y-axis) (defaults to 0). height The height of the PlacementSurface (along the z-axis) (defaults to 0).
Definition at line 18 of file PlacementSurface.cpp.
Member Function Documentation
| const string & PlacementSurface::getNavFrameID | ( | ) | const |
Navigation frame ID value accessor.
Get the navigation frame ID value of this Object.
- Returns:
- The navigation frame ID value of this Object.
Definition at line 24 of file PlacementSurface.cpp.
| void PlacementSurface::setNavFrameID | ( | const std::string & | nav_frame_id | ) |
Navigation frame ID value mutator.
Set the navigation frame ID value of this Object.
- Parameters:
-
nav_frame_id The new navigation frame ID value of this Object.
Definition at line 29 of file PlacementSurface.cpp.
Member Data Documentation
std::string rail::spatial_temporal_learning::worldlib::world::PlacementSurface::nav_frame_id_ [private] |
The navigation frame ID.
Definition at line 75 of file PlacementSurface.h.
The documentation for this class was generated from the following files: