Class Task::Builder

• Defined in File Task.hpp

Nested Relationships

This class is a nested type of Class Task.

Class Documentation

class Builder

Public Functions

Builder()

Get the builder ready.

Builder &add_phase(Phase::ConstDescriptionPtr description, std::vector<Phase::ConstDescriptionPtr> cancellation_sequence)

Add a phase to the sequence.

Parameters:

• description – [in] A description of the phase

• cancellation_sequence – [in] This phase sequence will be run if the task is cancelled during this phase.

std::shared_ptr<Description> build(std::string category, std::string detail)

Generate a TaskDescription instance from the phases that have been given to the builder.

Parameters:

• category – [in] Task category information that will go into the Task::Tag

• detail – [in] Any detailed information that will go into the Task::Tag