Class Event::State¶
Defined in File Event.hpp
Nested Relationships¶
This class is a nested type of Class Event.
Inheritance Relationships¶
Derived Types¶
public rmf_task::Event::Snapshot
(Class Event::Snapshot)public rmf_task::events::SimpleEventState
(Class SimpleEventState)
Class Documentation¶
-
class
rmf_task::Event
::
State
The interface to an active event.
Subclassed by rmf_task::Event::Snapshot, rmf_task::events::SimpleEventState
Public Functions
-
virtual uint64_t
id
() const = 0 The ID of this event, which is unique within its phase.
-
virtual Status
status
() const = 0 The current Status of this event.
-
bool
finished
() const A convenience function which returns true if the event’s status is any of Skipped, Canceled, Killed, or Completed.
-
virtual VersionedString::View
name
() const = 0 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 = 0 A detailed explanation of this event.
-
virtual std::vector<ConstStatePtr>
dependencies
() const = 0 Get more granular dependencies of this event, if any exist.
-
virtual
~State
() = default
-
virtual uint64_t