FlowComponent.h

Go to the documentation of this file.

/*
 *    Copyright (C) 2016-2026 Grok Image Compression Inc.
 *
 *    This source code is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This source code is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#pragma once
 
#include "grk_taskflow.h"

class FlowComponent : public tf::Taskflow
{
public:
  void addTo(tf::Taskflow& composition)
  {
    compositionTask_ = composition.composed_of(*this);
  }

  void precede(FlowComponent& successor)
  {
    compositionTask_.precede(successor.compositionTask_);
  }

  void precede(tf::Task& successor)
  {
    compositionTask_.precede(successor);
  }
 
  tf::Task& getCompositionTask(void)
  {
    return compositionTask_;
  }

  void conditional_precede(FlowComponent* root, FlowComponent* successor,
                           std::function<int()> condition_lambda)
  {
    auto condition = root->emplace(condition_lambda).name("condition");
    auto noop = root->emplace([]() {}).name("noop");
 
    precede(condition);
    condition.precede(successor->getCompositionTask(), noop);
  }

  FlowComponent* name(const std::string& name)
  {
    if(!name.empty())
    {
      compositionTask_.name(name);
    }
    else
    {
      compositionTask_.name("UnnamedFlowComponent");
    }
    return this;
  }

  tf::Task& nextTask()
  {
    auto task = placeholder();
    componentTasks_.emplace_back(std::move(task));
    return componentTasks_.back();
  }
 
private:
  std::vector<tf::Task> componentTasks_;

  tf::Task compositionTask_;
};