apollo::dreamview::UpdaterManager类 参考

Management for all data updater. 更多...

#include <updater_manager.h>

apollo::dreamview::UpdaterManager 的协作图:

Public 成员函数
	UpdaterManager ()
virtual	~UpdaterManager ()
void	RegisterUpdater (std::string path_name, UpdaterBase *updater)
	Register data updater by websocket path name.
bool	Start (const std::string &path_name, const double &time_interval_ms, const std::string &channel_name="", nlohmann::json *subscribe_param=nullptr)
	Start a updater implemetnent.
bool	Stop (const std::string &path_name, const std::string &channel_name)
	Stop updater publish data.
UpdaterBase *	GetUpdater (const std::string &path_name)
	Get registered updater
bool	IsChannelInUpdater (const std::string &path_name, const std::string &message_type, const std::string &channel_name)
	Check if the channel belongs to an updater.

详细描述

Management for all data updater.

在文件 updater_manager.h 第 42 行定义.

构造及析构函数说明

UpdaterManager()

apollo::dreamview::UpdaterManager::UpdaterManager ( )

inline

在文件 updater_manager.h 第 44 行定义.

{}

~UpdaterManager()

virtual apollo::dreamview::UpdaterManager::~UpdaterManager ( )

inlinevirtual

在文件 updater_manager.h 第 45 行定义.

{}

成员函数说明

GetUpdater()

UpdaterBase * apollo::dreamview::UpdaterManager::GetUpdater

(

const std::string &

path_name

)

Get registered updater

参数

path_name

The path name of the data updater.

在文件 updater_manager.cc 第 56 行定义.

                                                                  {
  if (updater_map_.find(path_name) == updater_map_.end()) {
    return nullptr;
  }
  return updater_map_[path_name];
}

IsChannelInUpdater()

bool apollo::dreamview::UpdaterManager::IsChannelInUpdater	(	const std::string &	path_name,
		const std::string &	message_type,
		const std::string &	channel_name
	)

Check if the channel belongs to an updater.

参数

path_name	The path name of the data updater.
message_type	The type of message in channel.
channel_name	The name of channel.

在文件 updater_manager.cc 第 63 行定义.

                                                                       {
  UpdaterBase* updater = GetUpdater(path_name);
  UpdaterWithChannelsBase* updater_with_channels =
      dynamic_cast<UpdaterWithChannelsBase*>(updater);
  if (updater_with_channels == nullptr) {
    return false;
  }
 
  return updater_with_channels->IsChannelInUpdater(message_type, channel_name);
}

RegisterUpdater()

void apollo::dreamview::UpdaterManager::RegisterUpdater	(	std::string	path_name,
		UpdaterBase *	updater
	)

Register data updater by websocket path name.

参数

path_name	The path name of the data updater.
updater	The data updater.

在文件 updater_manager.cc 第 51 行定义.

                                                           {
  updater_map_[path_name] = updater;
}

Start()

bool apollo::dreamview::UpdaterManager::Start	(	const std::string &	path_name,
		const double &	time_interval_ms,
		const std::string &	channel_name = "",
		nlohmann::json *	subscribe_param = nullptr
	)

Start a updater implemetnent.

参数

path_name	The path name of the data updater.
time_interval_ms	Data update frequency, If field time_interval_ms equals to 0, it is considered a single subscribe and will not start timer
subscribe_param	bring extra params for some updater.

在文件 updater_manager.cc 第 23 行定义.

                                                          {
  auto iter = updater_map_.find(path_name);
  if (iter == updater_map_.end()) {
    AERROR << "Related data updater for " << path_name
           << " is not exists, failed to start!";
    return false;
  }
  UpdaterBase* updater = iter->second;
  updater->StartStream(time_interval_ms, channel_name, subscribe_param);
  return true;
}

Stop()

bool apollo::dreamview::UpdaterManager::Stop	(	const std::string &	path_name,
		const std::string &	channel_name
	)

Stop updater publish data.

参数

path_name

The path name of the data updater.

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

                                                         {
  auto iter = updater_map_.find(path_name);
  if (iter == updater_map_.end()) {
    AERROR << "Related data updater for " << path_name
           << " is not exists,failed to stop!";
    return false;
  }
  UpdaterBase* updater = iter->second;
  updater->StopStream(channel_name);
  return true;
}

---

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

• modules/dreamview_plus/backend/updater/updater_manager.h
• modules/dreamview_plus/backend/updater/updater_manager.cc