Class ParticipantDescription

Class Documentation

class rmf_traffic::schedule::ParticipantDescription

Public Types

enum Rx

Enumeration for responsiveness.

Values:

enumerator Invalid

This responsiveness type is illegal and will always be rejected by the schedule verifier. Having this movement type implies a major bug in the code and should be reported immediately.

enumerator Unresponsive

The participant will not respond to any conflicts.

enumerator Responsive

The participant will try to respond to conflicts.

Public Functions

ParticipantDescription(std::string name, std::string owner, Rx responsiveness, Profile profile)

Constructor

Parameters

  • [in] name: The name of the object participating in the schedule.

  • [in] owner: The name of the “owner” of this participant. This does not currently have a formal definition, but for most vehicles it should be the name of the fleet that the vehicle belongs to.

  • [in] responsiveness: What category of responsiveness this participant has. A Responsive participant might be able to react to a conflict or a request for accommodations.

bool operator==(const ParticipantDescription &rhs) const

Equality operator.

bool operator!=(const ParticipantDescription &rhs) const

Inequality operator.

ParticipantDescription &name(std::string value)

Set the name of the participant.

const std::string &name() const

Get the name of the participant.

ParticipantDescription &owner(std::string value)

Set the name of the “owner” of the participant.

const std::string &owner() const

Get the name of the “owner” of the participant.

ParticipantDescription &responsiveness(Rx value)

Set the responsiveness of the participant.

Rx responsiveness() const

Get the responsiveness of the participant.

ParticipantDescription &profile(Profile new_profile)

Set the profile of the participant.

const Profile &profile() const

Get the profile of the participant.