QtTaskTree::Storage Class

詳細な説明

Storage クラステンプレートは、カスタム型StorageStruct のオブジェクトを動的に作成および破棄する役割を担います。作成と破棄は、実行中のタスクツリーによって管理されます。Storage オブジェクトがGroup 要素内に配置されている場合、実行中のタスクツリーは、グループが開始され、グループのセットアップハンドラが呼び出される前に、StorageStruct オブジェクトを作成します。 その後、このグループ内のハンドラが呼び出されるたびに、タスクツリーは以前に作成されたStorageStruct オブジェクトのインスタンスをアクティブ化します。これには、Storageオブジェクトが配置されたグループ内（ネストされたグループ内も含む）の、すべてのタスクおよびグループのセットアップハンドラとdoneハンドラが含まれます。 Storageオブジェクトのコピーがラムダキャプチャを介してハンドラに渡されると、ハンドラはStorage::operator->()、Storage::operator*()、またはactiveStorage()メソッドを介して、実行中のタスクツリーによってアクティブ化されたインスタンスにアクセスできます。2つのハンドラが同じStorageオブジェクトをキャプチャしている場合、一方のハンドラがそこにカスタムデータを格納し、もう一方のハンドラが後でそれを読み取ることができます。 グループの処理が完了すると、グループのdoneハンドラが呼び出された後に、以前に作成されたStorageStruct オブジェクトのインスタンスが破棄されます。

タスク間のデータ交換の例：

const Storage<QString> storage;

const auto onFirstDone = [storage](const FirstWorker &task) {
    // Assings QString, taken from the first task result, to the active QString instance
    // of the Storage object.
    *storage = task.getResultAsString();
};

const auto onSecondSetup = [storage](SecondWorker &task) {
    // Reads QString from the active QString instance of the Storage object and use it to
    // configure the second task before start.
    task.configureWithString(*storage);
};

const Group root {
    // The running task tree creates QString instance when root in entered
    storage,
    // The done handler of the first task stores the QString in the storage
    FirstWorkerTask(..., onFirstDone),
    // The setup handler of the second task reads the QString from the storage
    SecondWorkerTask(onSecondSetup, ...)
};

ルートグループはタスクを順次実行するため、onFirstDone ハンドラは常にonSecondSetup ハンドラよりも先に呼び出されます。つまり、onSecondSetup ハンドラの本体内でstorage から読み込まれるQString データは、onFirstDone ハンドラによってすでに設定済みとなります。sequential 実行モードでは、常にこの挙動を信頼できます。

Storageの内部構造は、そのすべてのコピー間で共有されます。そのため、ハンドラのラムダキャプチャ内にあるStorageオブジェクトのコピーは、依然として同じStorageインスタンスを参照しています。Group 要素内に複数のStorageオブジェクトを配置することは可能ですが、それらが同じStorageオブジェクトのコピーを含まないことが条件となります。そうでない場合、実行時にエラーメッセージを含むアサートがトリガーされます。 ただし、同じレシピ内の異なるGroup 要素に、同一のStorageオブジェクトのコピーを配置することは可能です。この場合、実行中のタスクツリーはStorageStruct オブジェクトの複数のインスタンス（コピーごとに1つずつ）を作成し、ストレージのシャドウイングが行われます。ストレージのシャドウイングは、ネストされたコードブロック内でのC++変数のシャドウイングと同様の仕組みで機能します：

Storage<QString> storage;

const Group root {
    storage,                            // Top copy, 1st instance of StorageStruct
    onGroupSetup([storage] { ... }),    // Top copy is active
    Group {
        storage,                        // Nested copy, 2nd instance of StorageStruct,
                                        // shadows Top copy
        onGroupSetup([storage] { ... }) // Nested copy is active
    },
    Group {
        onGroupSetup([storage] { ... }) // Top copy is active
    }
};

また、Storageオブジェクトは、実行されるタスクツリーへの初期データの渡しや、タスクツリーが終了する前に最終データを読み出すためにも使用できます。これを行うには、それぞれonStorageSetup()またはonStorageDone()を使用します。