Class Change

Nested Relationships

Nested Types

Class Documentation

class rmf_traffic::schedule::Change

A class that describes a change within the schedule.

class Add

The API for an Add change.

Public Functions

Add(PlanId plan, std::vector<Item> additions)

Add a set of routes.

const std::vector<Item> &items() const

A reference to the Trajectory that was inserted.

PlanId plan_id() const

The plan ID that these routes are being added for.

struct Item

A description of an addition.

Public Members

RouteId route_id

The ID of the route being added, relative to the plan it belongs to.

StorageId storage_id

The storage ID of the route.

ConstRoutePtr route

The information for the route being added.

class Cull

A class that describes a culling.

Public Functions

Cull(Time time)

Constructor

Parameters

  • [in] time: The time before which all routes should be culled

Time time() const
class Delay

The API for a Delay change.

Public Functions

Delay(Duration duration)

Add a delay

Parameters

  • [in] duration: The duration of that delay.

Duration duration() const

The duration of the delay.

class Erase

A class that describes an erasing change.

Public Functions

Erase(std::vector<StorageId> ids)

Constructor

Parameters

  • [in] id: The ID of the route that should be erased

const std::vector<StorageId> &ids() const
class Progress

A class that provides an update on itinerary progression.

Public Functions

Progress(ProgressVersion version, std::vector<CheckpointId> checkpoints)

Constructor.

ProgressVersion version() const
const std::vector<CheckpointId> &checkpoints() const
class RegisterParticipant

A class that describes a participant registration.

Public Functions

RegisterParticipant(ParticipantId id, ParticipantDescription description)

Constructor

Parameters

  • [in] id: The ID of the participant

  • [in] description: The description of the participant

ParticipantId id() const

The ID for the participant.

const ParticipantDescription &description() const

The description of the participant.

class UnregisterParticipant

A class that specifies a participant to unregister.

Public Functions

UnregisterParticipant(ParticipantId id)

Constructor

Parameters

  • [in] id: The ID of the participant that is being unregistered.

ParticipantId id() const

The ID for the participant.

class UpdateParticipantInfo

A class that describes update in the participant info.

Public Functions

UpdateParticipantInfo(ParticipantId id, ParticipantDescription desc)

Constructor

Parameters

  • [in] id: The ID of the participant that is being unregistered.

ParticipantId id() const

The ID for the participant.

ParticipantDescription description() const

Description for participants.