apollo::planning::StageResult类 参考

#include <process_result.h>

apollo::planning::StageResult 的协作图:

Public 成员函数
	StageResult (const StageStatusType &stage_status=StageStatusType::READY, const common::Status &task_status=common::Status::OK())
const common::Status &	GetTaskStatus () const
	Get the task execution result.
const StageStatusType &	GetStageStatus () const
	Get the stage status.
const StageResult &	SetTaskStatus (const common::Status &status)
	Set the task execution result.
const StageResult &	SetStageStatus (const StageStatusType &stage_status)
	Set the stage status.
const StageResult &	SetStageStatus (const StageStatusType &stage_status, const std::string &message)
	Set the stage status.
bool	HasError () const
	Check if StageResult contains error.
bool	IsTaskError () const

详细描述

在文件 process_result.h 第 52 行定义.

构造及析构函数说明

StageResult()

apollo::planning::StageResult::StageResult	(	const StageStatusType &	stage_status = StageStatusType::READY,
		const common::Status &	task_status = common::Status::OK()
	)

在文件 process_result.cc 第 30 行定义.

    : task_status_(task_status), stage_status_(stage_status) {}

成员函数说明

GetStageStatus()

const StageStatusType & apollo::planning::StageResult::GetStageStatus

(

)

const

Get the stage status.

返回

The stage status.

在文件 process_result.cc 第 38 行定义.

                                                         {
  return stage_status_;
}

GetTaskStatus()

const common::Status & apollo::planning::StageResult::GetTaskStatus

(

)

const

Get the task execution result.

返回

The execution result of task.

在文件 process_result.cc 第 34 行定义.

                                                     {
  return task_status_;
}

HasError()

bool apollo::planning::StageResult::HasError

(

)

const

Check if StageResult contains error.

返回

True if there is error contained.

在文件 process_result.cc 第 60 行定义.

                                 {
  return stage_status_ == StageStatusType::ERROR;
}

IsTaskError()

bool apollo::planning::StageResult::IsTaskError

(

)

const

在文件 process_result.cc 第 64 行定义.

{ return !task_status_.ok(); }

SetStageStatus() [1/2]

const StageResult & apollo::planning::StageResult::SetStageStatus

(

const StageStatusType &

stage_status

)

Set the stage status.

参数

stage_status

The stage status.

在文件 process_result.cc 第 47 行定义.

                                         {
  stage_status_ = stage_status;
  return *this;
}

SetStageStatus() [2/2]

const StageResult & apollo::planning::StageResult::SetStageStatus	(	const StageStatusType &	stage_status,
		const std::string &	message
	)

Set the stage status.

参数

stage_status	The stage status.
message	Stage message.

在文件 process_result.cc 第 53 行定义.

                                                                   {
  stage_status_ = stage_status;
  task_status_ = common::Status(task_status_.code(), message);
  return *this;
}

SetTaskStatus()

const StageResult & apollo::planning::StageResult::SetTaskStatus

(

const common::Status &

status

)

Set the task execution result.

参数

status

The execution result of task.

在文件 process_result.cc 第 42 行定义.

                                                                        {
  task_status_ = status;
  return *this;
}

---

该类的文档由以下文件生成:

• modules/planning/planning_interface_base/scenario_base/process_result.h
• modules/planning/planning_interface_base/scenario_base/process_result.cc