action.h 3.06 KB
Newer Older
1
/*
2
 * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

27 28
#ifndef EMBB_TASKS_ACTION_H_
#define EMBB_TASKS_ACTION_H_
29 30

#include <embb/base/function.h>
31 32
#include <embb/tasks/task_context.h>
#include <embb/tasks/execution_policy.h>
33 34

namespace embb {
35
namespace tasks {
36 37 38 39

/**
  * A function to be spawned as a Task.
  *
40
  * \ingroup CPP_TASKS
41 42 43 44 45 46 47 48
  */
class Action {
 public:
  /**
    * Constructs an empty Action.
    */
  Action()
    : function_()
49
    , execution_policy_() {
50 51 52 53
    // empty
  }

  /**
54 55 56
    * Constructs an Action from a function object.
    *
    * \tparam Function Function object
57 58 59
    */
  template <typename Function>
  Action(
60
    Function func                      /**< [in] Function object */
61 62
    )
    : function_(func)
63
    , execution_policy_() {
64 65 66 67
    // empty
  }

  /**
68 69 70
    * Constructs an Action from a function object and an Affinity.
    *
    * \tparam Function Function object
71 72 73
    */
  template <typename Function>
  Action(
74
    Function func,                     /**< [in] Function object */
75
    ExecutionPolicy execution_policy   /**< [in] Execution policy */
76 77
    )
    : function_(func)
78
    , execution_policy_(execution_policy) {
79 80 81 82 83 84 85 86 87 88 89 90 91 92
    // empty
  }

  /**
    * Executes the Action in a given TaskContext.
    */
  void operator() (
    TaskContext & context              /**< [in, out] Context the operator
                                            is executed in */
    ) {
    function_(context);
  }

  /**
93 94
    * Returns the ExecutionPolicy specified during creation.
    * \return The ExecutionPolicy of the Action
95 96
    * \waitfree
    */
97 98
  ExecutionPolicy GetExecutionPolicy() const {
    return execution_policy_;
99 100 101 102
  }

 private:
  embb::base::Function<void, TaskContext &> function_;
103
  ExecutionPolicy execution_policy_;
104 105
};

106
} // namespace tasks
107 108
} // namespace embb

109
#endif // EMBB_TASKS_ACTION_H_