Class Event::Snapshot¶
Defined in File Event.hpp
Nested Relationships¶
This class is a nested type of Class Event.
Inheritance Relationships¶
Base Type¶
public rmf_task::Event::State
(Class Event::State)
Class Documentation¶
-
class
rmf_task::Event
::
Snapshot
: public rmf_task::Event::State A snapshot of the state of an event. This snapshot can be read while the original event is arbitrarily changed, and there is no risk of a race condition, as long as the snapshot is not being created while the event is changing.
Public Functions
-
virtual uint64_t
id
() const final The ID of this event, which is unique within its phase.
-
virtual Status
status
() const final The current Status of this event.
-
virtual VersionedString::View
name
() const final The “name” of this event. Ideally a short, simple piece of text that helps a human being intuit what this event is expecting at a glance.
-
virtual VersionedString::View
detail
() const final A detailed explanation of this event.
-
virtual std::vector<ConstStatePtr>
dependencies
() const final Get more granular dependencies of this event, if any exist.
Public Static Functions
-
static ConstSnapshotPtr
make
(const State &other) Make a snapshot of the current state of an Event.
-
virtual uint64_t