abstract_task.h

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
// software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
// derivative works of the software or any portion of the software, and you may copy and distribute such modifications
// or works. Modified works should carry a notice stating that you changed the software and should note the date and
// nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
// source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
// EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
// WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
// CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
// THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
// are solely responsible for determining the appropriateness of using and distributing the software and you assume
// all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
// with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of
// operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
// damage to property. The software developed by NIST employees is not subject to copyright protection within the
// United States.
 
 
 
#ifndef HEDGEHOG_ABSTRACT_TASK_H
#define HEDGEHOG_ABSTRACT_TASK_H
 
#include <memory>
#include <string>
#include <ostream>
#include <utility>
 
#include "../../behavior/copyable.h"
#include "../../behavior/cleanable.h"
#include "../../behavior/task_node.h"
#include "../../behavior/multi_execute.h"
#include "../../behavior/input_output/multi_receivers.h"
#include "../../behavior/input_output/task_multi_senders.h"
 
#include "../../core/nodes/core_task.h"
 
namespace hh {
 
template<size_t Separator, class ...AllTypes>
class AbstractTask
    : public behavior::TaskNode,
      public behavior::CanTerminate,
      public behavior::Cleanable,
      public behavior::Copyable<AbstractTask<Separator, AllTypes...>>,
      public tool::BehaviorMultiReceiversTypeDeducer_t<tool::Inputs<Separator, AllTypes...>>,
      public tool::BehaviorMultiExecuteTypeDeducer_t<tool::Inputs<Separator, AllTypes...>>,
      public tool::BehaviorTaskMultiSendersTypeDeducer_t<tool::Outputs<Separator, AllTypes...>> {
 private:
  std::shared_ptr<hh::core::CoreTask<Separator, AllTypes...>> const coreTask_ = nullptr; 
 public:
  AbstractTask() : AbstractTask("Task", 1, false) {};
 
  explicit AbstractTask(std::string const &name, size_t const numberThreads = 1, bool const automaticStart = false)
      : behavior::TaskNode(std::make_shared<core::CoreTask<Separator, AllTypes...>>(this,
                                                                                    name,
                                                                                    numberThreads,
                                                                                    automaticStart)),
        behavior::Copyable<AbstractTask<Separator, AllTypes...>>(numberThreads),
        tool::BehaviorTaskMultiSendersTypeDeducer_t<tool::Outputs<Separator, AllTypes...>>(
            (std::dynamic_pointer_cast<hh::core::CoreTask<Separator, AllTypes...>>(this->core()))),
        coreTask_(std::dynamic_pointer_cast<core::CoreTask<Separator, AllTypes...>>(this->core())) {
    if (numberThreads == 0) { throw std::runtime_error("A task needs at least one thread."); }
    if (coreTask_ == nullptr) { throw std::runtime_error("The core used by the task should be a CoreTask."); }
  }
 
  explicit AbstractTask(std::shared_ptr<hh::core::CoreTask<Separator, AllTypes...>> coreTask)
      : behavior::TaskNode(std::move(coreTask)),
        behavior::Copyable<AbstractTask<Separator, AllTypes...>>(
            std::dynamic_pointer_cast<core::CoreTask<Separator, AllTypes...>>(this->core())->numberThreads()),
        tool::BehaviorTaskMultiSendersTypeDeducer_t<tool::Outputs<Separator, AllTypes...>>(
            std::dynamic_pointer_cast<hh::core::CoreTask<Separator, AllTypes...>>(this->core())),
        coreTask_(std::dynamic_pointer_cast<core::CoreTask<Separator, AllTypes...>>(this->core())) {
  }
 
  ~AbstractTask() override = default;
 
  [[nodiscard]] size_t graphId() const { return coreTask_->graphId(); }
 
  [[nodiscard]] bool canTerminate() const override {
    return !coreTask_->hasNotifierConnected() && coreTask_->receiversEmpty();
  }
 
 protected:
  std::shared_ptr<hh::core::CoreTask<Separator, AllTypes...>> const &coreTask() const { return coreTask_; }
 
  int deviceId() { return coreTask_->deviceId(); }
};
}
#endif //HEDGEHOG_ABSTRACT_TASK_H