Class Phase

Nested Relationships

Nested Types

Inheritance Relationships

Derived Type

Class Documentation

class rmf_task::Phase

Subclassed by rmf_task::phases::RestoreBackup

Public Types

using ConstTagPtr = std::shared_ptr<const Tag>
using ConstCompletedPtr = std::shared_ptr<const Completed>
using ConstActivePtr = std::shared_ptr<const Active>
using ConstSnapshotPtr = std::shared_ptr<const Snapshot>
class Active

Subclassed by rmf_task::Phase::Snapshot, rmf_task::phases::RestoreBackup::Active

Public Functions

virtual ConstTagPtr tag() const = 0

Tag of the phase.

virtual Event::ConstStatePtr final_event() const = 0

The Event that needs to finish for this phase to be complete.

virtual rmf_traffic::Duration estimate_remaining_time() const = 0

The estimated finish time for this phase.

virtual ~Active() = default
class Completed

Information about a phase that has been completed.

Public Functions

Completed(ConstSnapshotPtr snapshot_, rmf_traffic::Time start_, rmf_traffic::Time finish_)

Constructor.

const ConstSnapshotPtr &snapshot() const

The final log of the phase.

rmf_traffic::Time start_time() const

The actual time that the phase started.

rmf_traffic::Time finish_time() const

The actual time that the phase finished.

class Pending

Public Functions

Pending(ConstTagPtr tag)

Constructor.

const ConstTagPtr &tag() const

Tag of the phase.

Pending &will_be_skipped(bool value)

Change whether this pending phase will be skipped.

bool will_be_skipped() const

Check if this phase is set to be skipped.

class Snapshot : public rmf_task::Phase::Active

Public Functions

virtual ConstTagPtr tag() const final

Tag of the phase.

virtual Event::ConstStatePtr final_event() const final

The Event that needs to finish for this phase to be complete.

virtual rmf_traffic::Duration estimate_remaining_time() const final

The estimated finish time for this phase.

Public Static Functions

static ConstSnapshotPtr make(const Active &active)

Make a snapshot of an Active phase.

class Tag

Basic static information about a phase. This information should go unchanged from the Pending state, through the Active state, and into the Completed state.

Public Types

using Id = uint64_t

Public Functions

Tag(Id id_, Header header_)

Constructor

Parameters

  • [in] id_: ID of the phase. This phase ID must be unique within its Task instance.

  • [in] header_: Header of the phase.

Id id() const

Unique ID of the phase.

const Header &header() const

Header of the phase, containing human-friendly high-level information about the phase.