/******************************************************************************
 * Copyright 2017 The Apollo Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *****************************************************************************/

/**
 * @file speed_optimizer.h
 **/

#ifndef MODULES_PLANNING_TASKS_SPEED_OPTIMIZER_H_
#define MODULES_PLANNING_TASKS_SPEED_OPTIMIZER_H_

#include <string>
#include <vector>

#include "modules/common/status/status.h"
#include "modules/planning/common/speed/speed_data.h"
#include "modules/planning/common/speed_limit.h"
#include "modules/planning/common/speed/st_boundary.h"
#include "modules/planning/tasks/task.h"

namespace apollo {
namespace planning {

class SpeedOptimizer : public Task {
 public:
  explicit SpeedOptimizer(const std::string& name);
  virtual ~SpeedOptimizer() = default;
  apollo::common::Status Execute(
      Frame* frame, ReferenceLineInfo* reference_line_info) override;

 protected:
  virtual apollo::common::Status Process(
      const SLBoundary& adc_sl_boundary, const PathData& path_data,
      const common::TrajectoryPoint& init_point,
      const ReferenceLine& reference_line, PathDecision* const path_decision,
      SpeedData* const speed_data) = 0;

  void RecordSTGraphDebug(const std::vector<StBoundary>& boundaries,
                          const SpeedLimit& speed_limits,
                          const SpeedData& speed_data);

  void RecordDebugInfo(const SpeedData& speed_data);
};

}  // namespace planning
}  // namespace apollo

#endif  // MODULES_PLANNING_TASKS_SPEED_OPTIMIZER_H_