Class Loop::Description

Nested Relationships

This class is a nested type of Class Loop.

Inheritance Relationships

Base Type

Class Documentation

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 of the loop in this request.

std::size_t finish_waypoint() const

Get the finish waypoint of the loop in this request.

std::size_t num_loops() const

Get the numbert of loops in this request.

Public Static Functions

static Task::ConstDescriptionPtr make(std::size_t start_waypoint, std::size_t finish_waypoint, std::size_t num_loops)

Generate the description for this request.