apollo::dreamview::HMI类 参考

#include <hmi.h>

类 apollo::dreamview::HMI 继承关系图:

apollo::dreamview::HMI 的协作图:

Public 类型
using	DvCallback = std::function< nlohmann::json(const std::string &function_name, const nlohmann::json &param_json)>
using	DvCallback = std::function< nlohmann::json(const std::string &function_name, const nlohmann::json &param_json)>

Public 成员函数
	HMI (WebSocketHandler *websocket, MapService *map_service)
void	Start (DvCallback callback_api)
void	Stop ()
bool	UpdateScenarioSetToStatus (const std::string &scenario_set_id, const std::string &scenario_set_name)
bool	UpdateDynamicModelToStatus (const std::string &dynamic_model_name)
bool	UpdateRecordToStatus ()
bool	UpdateVehicleToStatus ()
bool	UpdateCameraChannelToStatus (const std::string &channel_name)
bool	UpdatePointChannelToStatus (const std::string &channel_name)
	HMI (WebSocketHandler *websocket, MapService *map_service, WebSocketHandler *hmi_websocket)
void	Start (DvCallback callback_api)
void	StartStream (const double &time_interval_ms, const std::string &channel_name="", nlohmann::json *subscribe_param=nullptr) override
	Start data flow.
void	PublishMessage (const std::string &channel_name="") override
	Publish Message to dreamview frontend.
void	Stop ()
void	StopStream (const std::string &channel_name="") override
	Stop data flow.
void	OnTimer (const std::string &channel_name="")
bool	UpdateDynamicModelToStatus (const std::string &dynamic_model_name)
bool	UpdateMapToStatus (const std::string &map_name="")
bool	UpdateRecordToStatus ()
bool	UpdateVehicleToStatus ()
bool	UpdateCameraChannelToStatus (const std::string &channel_name)
bool	UpdatePointChannelToStatus (const std::string &channel_name)
bool	isProcessRunning (const std::string &process_name)
Public 成员函数 继承自 apollo::dreamview::UpdaterBase
	UpdaterBase ()
	Updaterbase
virtual	~UpdaterBase ()

详细描述

在文件 hmi.h 第 34 行定义.

成员类型定义说明

DvCallback [1/2]

using apollo::dreamview::HMI::DvCallback = std::function<nlohmann::json( const std::string &function_name, const nlohmann::json &param_json)>

在文件 hmi.h 第 36 行定义.

DvCallback [2/2]

using apollo::dreamview::HMI::DvCallback = std::function<nlohmann::json( const std::string &function_name, const nlohmann::json &param_json)>

在文件 hmi.h 第 37 行定义.

构造及析构函数说明

HMI() [1/2]

apollo::dreamview::HMI::HMI	(	WebSocketHandler *	websocket,
		MapService *	map_service
	)

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

    : hmi_worker_(new HMIWorker()),
      monitor_log_buffer_(apollo::common::monitor::MonitorMessageItem::HMI),
      websocket_(websocket),
      map_service_(map_service) {
  if (websocket_) {
    RegisterMessageHandlers();
  }
}

HMI() [2/2]

apollo::dreamview::HMI::HMI	(	WebSocketHandler *	websocket,
		MapService *	map_service,
		WebSocketHandler *	hmi_websocket
	)

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

    : monitor_log_buffer_(apollo::common::monitor::MonitorMessageItem::HMI),
      hmi_worker_(new HMIWorker(monitor_log_buffer_)),
      websocket_(websocket),
      map_service_(map_service),
      hmi_ws_(hmi_websocket) {
  if (websocket_) {
    RegisterDBMessageHandlers();
    RegisterMessageHandlers();
  }
}

成员函数说明

isProcessRunning()

bool apollo::dreamview::HMI::isProcessRunning

(

const std::string &

process_name

)

在文件 hmi.cc 第 770 行定义.

                                                        {
  return hmi_worker_->isProcessRunning(process_name);
}

OnTimer()

void apollo::dreamview::HMI::OnTimer

(

const std::string &

channel_name = ""

)

在文件 hmi.cc 第 732 行定义.

{ PublishMessage(); }

PublishMessage()

void apollo::dreamview::HMI::PublishMessage ( const std::string &  channel_name = "" )

overridevirtual

Publish Message to dreamview frontend.

实现了 apollo::dreamview::UpdaterBase.

在文件 hmi.cc 第 734 行定义.

                                                      {
  StreamData response;
  response.set_action("stream");
  response.set_data_name("hmistatus");
  std::string hmi_status_str;
  hmi_worker_->GetStatus().SerializeToString(&hmi_status_str);
  std::vector<uint8_t> byte_data(hmi_status_str.begin(), hmi_status_str.end());
  response.set_data(&(byte_data[0]), byte_data.size());
  response.set_type("hmistatus");
  std::string response_str;
  response.SerializeToString(&response_str);
  hmi_ws_->BroadcastBinaryData(response_str);
}

Start() [1/2]

void apollo::dreamview::HMI::Start

(

DvCallback

callback_api

)

在文件 hmi.cc 第 52 行定义.

{ hmi_worker_->Start(callback_api); }

Start() [2/2]

void apollo::dreamview::HMI::Start

(

DvCallback

callback_api

)

StartStream()

void apollo::dreamview::HMI::StartStream ( const double &  time_interval_ms, const std::string &  channel_name = "", nlohmann::json *  subscribe_param = nullptr  )

overridevirtual

Start data flow.

参数

time_interval_ms	Data stream sending frequency. 0 means single subscribe
subscribe_param	subscribe some updater may need extra params

实现了 apollo::dreamview::UpdaterBase.

在文件 hmi.cc 第 55 行定义.

                                                     {
  AINFO << "Start HMIStatus updater timer with data sending frequency: "
        << time_interval_ms;
  time_interval_ms_ = time_interval_ms;
  if (time_interval_ms_ > 0) {
    timer_.reset(new cyber::Timer(
        time_interval_ms, [this]() { this->OnTimer(); }, false));
    timer_->Start();
  } else {
    this->OnTimer();
  }
}

Stop() [1/2]

void apollo::dreamview::HMI::Stop

(

)

在文件 hmi.cc 第 54 行定义.

{ hmi_worker_->Stop(); }

Stop() [2/2]

void apollo::dreamview::HMI::Stop

(

)

StopStream()

void apollo::dreamview::HMI::StopStream ( const std::string &  channel_name = "" )

overridevirtual

Stop data flow.

实现了 apollo::dreamview::UpdaterBase.

在文件 hmi.cc 第 74 行定义.

                                                  {
  AINFO << "HMIStatus updater timer has been stopped";
  if (timer_) {
    timer_->Stop();
  }
}

UpdateCameraChannelToStatus() [1/2]

bool apollo::dreamview::HMI::UpdateCameraChannelToStatus

(

const std::string &

channel_name

)

在文件 hmi.cc 第 251 行定义.

                                                                   {
  hmi_worker_->UpdateCameraSensorChannelToStatus(channel_name);
  return true;
}

UpdateCameraChannelToStatus() [2/2]

bool apollo::dreamview::HMI::UpdateCameraChannelToStatus

(

const std::string &

channel_name

)

UpdateDynamicModelToStatus() [1/2]

bool apollo::dreamview::HMI::UpdateDynamicModelToStatus

(

const std::string &

dynamic_model_name

)

在文件 hmi.cc 第 243 行定义.

                                                                        {
  return hmi_worker_->UpdateDynamicModelToStatus(dynamic_model_name);
}

UpdateDynamicModelToStatus() [2/2]

bool apollo::dreamview::HMI::UpdateDynamicModelToStatus

(

const std::string &

dynamic_model_name

)

UpdateMapToStatus()

bool apollo::dreamview::HMI::UpdateMapToStatus

(

const std::string &

map_name = ""

)

在文件 hmi.cc 第 752 行定义.

                                                     {
  return hmi_worker_->UpdateMapToStatus(map_name);
}

UpdatePointChannelToStatus() [1/2]

bool apollo::dreamview::HMI::UpdatePointChannelToStatus

(

const std::string &

channel_name

)

在文件 hmi.cc 第 256 行定义.

                                                                  {
  hmi_worker_->UpdatePointCloudChannelToStatus(channel_name);
  return true;
}

UpdatePointChannelToStatus() [2/2]

bool apollo::dreamview::HMI::UpdatePointChannelToStatus

(

const std::string &

channel_name

)

UpdateRecordToStatus() [1/2]

bool apollo::dreamview::HMI::UpdateRecordToStatus

(

)

在文件 hmi.cc 第 247 行定义.

{ return hmi_worker_->LoadRecords(); }

UpdateRecordToStatus() [2/2]

bool apollo::dreamview::HMI::UpdateRecordToStatus

(

)

UpdateScenarioSetToStatus()

bool apollo::dreamview::HMI::UpdateScenarioSetToStatus	(	const std::string &	scenario_set_id,
		const std::string &	scenario_set_name
	)

在文件 hmi.cc 第 237 行定义.

                                                                        {
  return hmi_worker_->UpdateScenarioSetToStatus(scenario_set_id,
                                                scenario_set_name);
}

UpdateVehicleToStatus() [1/2]

bool apollo::dreamview::HMI::UpdateVehicleToStatus

(

)

在文件 hmi.cc 第 249 行定义.

{ return hmi_worker_->ReloadVehicles(); }

UpdateVehicleToStatus() [2/2]

bool apollo::dreamview::HMI::UpdateVehicleToStatus

(

)

---

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

• modules/dreamview/backend/hmi/hmi.h
• modules/dreamview_plus/backend/hmi/hmi.h
• modules/dreamview/backend/hmi/hmi.cc
• modules/dreamview_plus/backend/hmi/hmi.cc