process_result.h

浏览该文件的文档.

/******************************************************************************
 * Copyright 2023 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.
 *****************************************************************************/
 
#pragma once
 
#include <string>
 
#include "modules/common/status/status.h"
 
namespace apollo {
namespace planning {
 
enum class StageStatusType {
  ERROR = 1,
  READY = 2,
  RUNNING = 3,
  FINISHED = 4,
};
 
enum class ScenarioStatusType {
  STATUS_UNKNOWN = 0,
  STATUS_PROCESSING = 1,
  STATUS_DONE = 2,
};
 
class StageResult {
 public:
  StageResult(const StageStatusType& stage_status = StageStatusType::READY,
              const common::Status& task_status = common::Status::OK());
  const common::Status& GetTaskStatus() const;
  const StageStatusType& GetStageStatus() const;
  const StageResult& SetTaskStatus(const common::Status& status);
  const StageResult& SetStageStatus(const StageStatusType& stage_status);
  const StageResult& SetStageStatus(const StageStatusType& stage_status,
                                    const std::string& message);
  bool HasError() const;
  bool IsTaskError() const;
 
 private:
  common::Status task_status_;
  StageStatusType stage_status_;
};
 
class ScenarioResult {
 public:
  ScenarioResult(const ScenarioStatusType& scenario_status =
                     ScenarioStatusType::STATUS_UNKNOWN,
                 const StageStatusType& stage_status = StageStatusType::READY,
                 const common::Status& task_status = common::Status::OK());
  const common::Status& GetTaskStatus() const;
  const StageStatusType& GetStageStatus() const;
  const ScenarioStatusType& GetScenarioStatus() const;
  const ScenarioResult& SetStageResult(const StageResult& stage_result);
  const ScenarioResult& SetStageResult(const StageStatusType& stage_status,
                                       const std::string& message);
  const ScenarioResult& SetScenarioStatus(
      const ScenarioStatusType& scenario_status);
 
 private:
  ScenarioStatusType scenario_status_;
  StageResult stage_result_;
};
 
}  // namespace planning
}  // namespace apollo