Class Clean

Nested Relationships

Nested Types

Class Documentation

class Clean

A class that generates a Request which requires an AGV to perform a cleaning operation at a location

Public Static Functions

static ConstRequestPtr make(std::size_t start_waypoint, std::size_t end_waypoint, const rmf_traffic::Trajectory &cleaning_path, const std::string &id, rmf_traffic::Time earliest_start_time, ConstPriorityPtr priority = nullptr, bool automatic = false)

Generate a clean request

Parameters:

  • start_waypoint – [in] The graph index for the location where the AGV should begin its cleaning operation

  • end_waypoint – [in] The graph index for the location where the AGV ends up after its cleaning operation

  • cleaning_path – [in] A trajectory that describes the motion of the AGV during the cleaning operation. This is used to determine the process duration and expected battery drain

  • id – [in] A unique id for this request

  • earliest_start_time – [in] The desired start time for this request

  • priority – [in] The priority for this request

  • automatic – [in] True if this request is auto-generated

static ConstRequestPtr make(std::size_t start_waypoint, std::size_t end_waypoint, const rmf_traffic::Trajectory &cleaning_path, const std::string &id, rmf_traffic::Time earliest_start_time, const std::string &requester, rmf_traffic::Time request_time, ConstPriorityPtr priority = nullptr, bool automatic = false)

Generate a clean request.

Parameters:

  • start_waypoint – [in] The graph index for the location where the AGV should begin its cleaning operation.

  • end_waypoint – [in] The graph index for the location where the AGV ends up after its cleaning operation.

  • cleaning_path – [in] A trajectory that describes the motion of the AGV during the cleaning operation. This is used to determine the process duration and expected battery drain.

  • id – [in] A unique id for this request.

  • earliest_start_time – [in] The desired start time for this request.

  • requester – [in] The entity that issued this request.

  • request_time – [in] The time this request was generated or submitted.

  • priority – [in] The priority for this request.

  • automatic – [in] True if this request is auto-generated, default value as false.

class Description : public rmf_task::Task::Description

Public Functions

virtual Task::ConstModelPtr make_model(rmf_traffic::Time earliest_start_time, const Parameters &parameters) const final

Generate a Model for the task based on the unique traits of this description

Parameters:

  • earliest_start_time – [in] The earliest time this task should begin execution. This is usually the requested start time for the task.

  • parameters – [in] The parameters that describe this AGV

virtual Info generate_info(const State &initial_state, const Parameters &parameters) const final

Generate a plain text info description for the task, given the predicted initial state and the task planning parameters.

Parameters:

  • initial_state – [in] The predicted initial state for the task

  • parameters – [in] 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.