Class Viewer¶
Defined in File Viewer.hpp
Nested Relationships¶
Nested Types¶
Inheritance Relationships¶
Derived Types¶
public rmf_traffic::schedule::ItineraryViewer
(Class ItineraryViewer)public rmf_traffic::schedule::Snapshot
(Class Snapshot)
Class Documentation¶
-
class
rmf_traffic::schedule
::
Viewer
¶ A pure abstract interface class that allows users to query for itineraries that are in a schedule.
This class cannot be instantiated directly. To get a Viewer, you must instantiate an rmf_traffic::schedule::Database or an rmf_traffic::schedule::Mirror object.
Subclassed by rmf_traffic::schedule::ItineraryViewer, rmf_traffic::schedule::Snapshot
Public Functions
-
virtual View
query
(const Query ¶meters) const = 0¶ Query this Viewer to get a View of the Trajectories inside of it that match the Query parameters.
-
virtual View
query
(const Query::Spacetime &spacetime, const Query::Participants &participants) const = 0¶ Alternative signature for query()
-
virtual const std::unordered_set<ParticipantId> &
participant_ids
() const = 0¶ Get the set of active participant IDs.
-
virtual std::shared_ptr<const ParticipantDescription>
get_participant
(ParticipantId participant_id) const = 0¶ Get the information of the specified participant if it is available. If a participant with the specified ID is not registered with the schedule, then this will return a nullptr.
-
virtual
~Viewer
() = default¶
-
class
View
¶ A read-only view of some Trajectories in a Database or Mirror.
It is undefined behavior to modify a Database or patch a Mirror while reading Trajectories from this view. The user of this class is responsible for managing access to reads vs access to writes.
Public Types
-
using
base_iterator
= rmf_traffic::detail::bidirectional_iterator<E, I, F>¶
-
using
const_iterator
= base_iterator<const Element, IterImpl, View>¶
-
using
iterator
= const_iterator¶
Public Functions
-
const_iterator
begin
() const¶ Returns an iterator to the first element of the View.
-
const_iterator
end
() const¶ Returns an iterator to the element following the last element of the View.
-
using
-
virtual View