Class Task::Description¶
Defined in File Task.hpp
Nested Relationships¶
This class is a nested type of Class Task.
Nested Types¶
Inheritance Relationships¶
Derived Types¶
public rmf_task::requests::ChargeBattery::Description
(Class ChargeBattery::Description)public rmf_task::requests::Clean::Description
(Class Clean::Description)public rmf_task::requests::Delivery::Description
(Class Delivery::Description)public rmf_task::requests::Loop::Description
(Class Loop::Description)
Class Documentation¶
-
class
rmf_task::Task
::
Description
An abstract interface to define the specifics of this task. This implemented description will differentiate this task from others.
Subclassed by rmf_task::requests::ChargeBattery::Description, rmf_task::requests::Clean::Description, rmf_task::requests::Delivery::Description, rmf_task::requests::Loop::Description
Public Functions
-
virtual ConstModelPtr
make_model
(rmf_traffic::Time earliest_start_time, const Parameters ¶meters) const = 0 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 = 0 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
-
virtual
~Description
() = default
-
struct
Info
Public Members
-
std::string
category
-
std::string
detail
-
std::string
-
virtual ConstModelPtr