Class Clean::Description¶
Defined in File Clean.hpp
Nested Relationships¶
This class is a nested type of Class Clean.
Inheritance Relationships¶
Base Type¶
public rmf_task::Task::Description
(Class Task::Description)
Class Documentation¶
-
class
rmf_task::requests::Clean
::
Description
: public rmf_task::Task::Description Public Functions
-
virtual Task::ConstModelPtr
make_model
(rmf_traffic::Time earliest_start_time, const Parameters ¶meters) const final Generate a Model for the task based on the unique traits of this description
- Parameters
[in] earliest_start_time
: The earliest time this task should begin execution. This is usually the requested start time for the task.[in] parameters
: The parameters that describe this AGV
-
virtual Info
generate_info
(const State &initial_state, const Parameters ¶meters) const final Generate a plain text info description for the task, given the predicted initial state and the task planning parameters.
- Parameters
[in] initial_state
: The predicted initial state for the task[in] parameters
: The task planning parameters
-
std::size_t
start_waypoint
() const Get the start waypoint in this request.
-
std::size_t
end_waypoint
() const Get the end waypoint in this request.
Public Static Functions
-
static std::shared_ptr<Description>
make
(std::size_t start_waypoint, std::size_t end_waypoint, const rmf_traffic::Trajectory &cleaning_path) Generate the description for this request.
-
virtual Task::ConstModelPtr