Class RestoreBackup

Defined in File RestoreBackup.hpp

Nested Relationships

Nested Types

Class RestoreBackup::Active

Inheritance Relationships

Base Type

public rmf_task::Phase (Class Phase)

Class Documentation

class RestoreBackup : public rmf_task::Phase 

Public Types

using ActivePtr = std::shared_ptr<Active>

class Active : public rmf_task::Phase::Active 

This is a special phase type designated for restoring the backup of a task.

This phase type uses a reserved phase ID of 0.

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.

void parsing_failed(const std::string &error_message): Call this function if the parsing fails.

void restoration_failed(const std::string &error_message): Call this function if the restoration fails for some reason besides parsing

void restoration_succeeded(): Call this function if the parsing succeeds.

Log &update_log(): Get the log to pass in some other kind of message.

Public Static Functions

static ActivePtr make(const std::string &backup_state_str, rmf_traffic::Duration estimated_remaining_time): Make an active RestoreBackup phase.