Class Writer::Registration¶
Defined in File Writer.hpp
Nested Relationships¶
This class is a nested type of Class Writer.
Class Documentation¶
-
class
rmf_traffic::schedule::Writer
::
Registration
Information resulting from registering a participant.
Public Functions
-
Registration
(ParticipantId id, ItineraryVersion version, PlanId plan_id, StorageId storage_base) Constructor
- Parameters
[in] id
: The ID for the registered participant[in] version
: The last itinerary version for the registered participant[in] plan_id
: The last plan_id for the registered participant[in] storage_base
: The next storage base that the registered participant should use
-
ParticipantId
id
() const The ID of the registered participant.
-
ItineraryVersion
last_itinerary_version
() const The last itinerary version of the registered participant. New Participants will begin by adding up from this version when issuing schedule updates.
This value might vary for systems that enforce participant uniqueness. If this participant was registered in the past and is now being re-registered, then the version number will pick up where it previously left off.
-
PlanId
last_plan_id
() const The last Route ID of the registered participant. New Participants will begin by adding up from this Route ID when issuing new schedule updates.
Similar to last_itinerary_version, this value might vary for systems that enforce participant uniqueness.
-
StorageId
next_storage_base
() const The next storage base that the participant should use.
-