Task placement model information. More...
#include <TaskModel.h>
Public Member Functions | |
| void | addPlacementModel (const PlacementModel &placement_model) |
| PlacementModel adder. | |
| const std::string & | getName () const |
| Name value accessor. | |
| size_t | getNumPlacementModels () const |
| Placement models size accessor. | |
| const PlacementModel & | getPlacementModel (const size_t index) const |
| PlacementModel value accessor (immutable). | |
| PlacementModel & | getPlacementModel (const size_t index) |
| PlacementModel value accessor. | |
| const std::vector < PlacementModel > & | getPlacementModels () const |
| Placement models value accessor. | |
| std::vector< PlacementModel > & | getPlacementModels () |
| Placement models value accessor (immutable). | |
| uint32_t | getTaskID () |
| Task ID value accessor. | |
| void | getUniqueItems (std::vector< world::Item > &items) const |
| Get a unique list of the items in the task. | |
| void | getUniqueSurfaces (std::vector< world::Surface > &surfaces) const |
| Get a unique list of the surfaces in the task. | |
| void | removePlacementModel (const size_t index) |
| PlacementModel remover. | |
| void | setName (const std::string &name) |
| Name value mutator. | |
| void | setTaskID (const uint32_t task_id) |
| Task ID value mutator. | |
| TaskModel (const uint32_t task_id=0, const std::string &name="") | |
| Create a new TaskModel. | |
Private Attributes | |
| std::string | name_ |
| std::vector< PlacementModel > | placement_models_ |
| uint32_t | task_id_ |
Task placement model information.
A task model contains a set of placement models representing the strength of reference frames for a given task.
Definition at line 37 of file TaskModel.h.
| TaskModel::TaskModel | ( | const uint32_t | task_id = 0, |
| const std::string & | name = "" |
||
| ) |
Create a new TaskModel.
Create a new empty TaskModel with the given parameters.
| task_id | A unique identifier for the task (defaults to 0). |
| name | The name of the task (defaults to the empty string). |
Definition at line 20 of file TaskModel.cpp.
| void TaskModel::addPlacementModel | ( | const PlacementModel & | placement_model | ) |
PlacementModel adder.
Add the PlacementModel to this World.
| placement_model | The new PlacementModel to add. |
Definition at line 84 of file TaskModel.cpp.
| const string & TaskModel::getName | ( | ) | const |
Name value accessor.
Get the name value of this TaskModel.
Definition at line 35 of file TaskModel.cpp.
| size_t TaskModel::getNumPlacementModels | ( | ) | const |
Placement models size accessor.
Get the number of placement models of this TaskModel.
Definition at line 55 of file TaskModel.cpp.
| const PlacementModel & TaskModel::getPlacementModel | ( | const size_t | index | ) | const |
PlacementModel value accessor (immutable).
Get the PlacementModel of this TaskModel at the given index.
| i | The index of the PlacementModel to get. |
| std::out_of_range | Thrown if the PlacementModel at the given index does not exist. |
Definition at line 60 of file TaskModel.cpp.
| PlacementModel & TaskModel::getPlacementModel | ( | const size_t | index | ) |
PlacementModel value accessor.
Get the PlacementModel of this TaskModel at the given index.
| i | The index of the PlacementModel to get. |
| std::out_of_range | Thrown if the PlacementModel at the given index does not exist. |
Definition at line 72 of file TaskModel.cpp.
| const vector< PlacementModel > & TaskModel::getPlacementModels | ( | ) | const |
Placement models value accessor.
Get the placement models of this TaskModel.
Definition at line 45 of file TaskModel.cpp.
| vector< PlacementModel > & TaskModel::getPlacementModels | ( | ) |
Placement models value accessor (immutable).
Get the placement models of this TaskModel.
Definition at line 50 of file TaskModel.cpp.
| uint32_t TaskModel::getTaskID | ( | ) |
Task ID value accessor.
Get the task ID value of this TaskModel.
Definition at line 25 of file TaskModel.cpp.
| void TaskModel::getUniqueItems | ( | std::vector< world::Item > & | items | ) | const |
Get a unique list of the items in the task.
Get a unique list of the items in the task. All poses are set to 0 since they are not placed items, simply a list of the items for the task.
| items | The vector to fill with the unique items. |
Definition at line 101 of file TaskModel.cpp.
| void TaskModel::getUniqueSurfaces | ( | std::vector< world::Surface > & | surfaces | ) | const |
Get a unique list of the surfaces in the task.
Get a unique list of the surfaces in the task. All poses are set to 0 since they are not placed surfaces, simply a list of the surfaces for the task.
| surfaces | The vector to fill with the unique surfaces. |
Definition at line 128 of file TaskModel.cpp.
| void TaskModel::removePlacementModel | ( | const size_t | index | ) |
PlacementModel remover.
Remove the PlacementModel at the given index. An invalid index results in no effect.
| i | The index of the PlacementModel pose to remove. |
| std::out_of_range | Thrown if the PlacementModel at the given index does not exist. |
Definition at line 89 of file TaskModel.cpp.
| void TaskModel::setName | ( | const std::string & | name | ) |
Name value mutator.
Set the name value of this TaskModel.
| name | The new name value of this TaskModel. |
Definition at line 40 of file TaskModel.cpp.
| void TaskModel::setTaskID | ( | const uint32_t | task_id | ) |
Task ID value mutator.
Set the task ID value of this TaskModel.
| task_id | The new task ID value of this TaskModel. |
Definition at line 30 of file TaskModel.cpp.
std::string rail::spatial_temporal_learning::worldlib::model::TaskModel::name_ [private] |
The name of the task.
Definition at line 178 of file TaskModel.h.
std::vector<PlacementModel> rail::spatial_temporal_learning::worldlib::model::TaskModel::placement_models_ [private] |
Definition at line 180 of file TaskModel.h.
uint32_t rail::spatial_temporal_learning::worldlib::model::TaskModel::task_id_ [private] |
The ID of the task.
Definition at line 176 of file TaskModel.h.