apollo::cyber::ParameterServer类 参考

Parameter Service is a very important function of auto-driving. 更多...

#include <parameter_server.h>

apollo::cyber::ParameterServer 的协作图:

Public 类型
using	Param = apollo::cyber::proto::Param
using	NodeName = apollo::cyber::proto::NodeName
using	ParamName = apollo::cyber::proto::ParamName
using	BoolResult = apollo::cyber::proto::BoolResult
using	Params = apollo::cyber::proto::Params

Public 成员函数
	ParameterServer (const std::shared_ptr< Node > &node)
	Construct a new ParameterServer object
void	SetParameter (const Parameter &parmeter)
	Set the Parameter object
bool	GetParameter (const std::string &parameter_name, Parameter *parameter)
	Get the Parameter object
void	ListParameters (std::vector< Parameter > *parameters)
	get all the parameters

详细描述

Parameter Service is a very important function of auto-driving.

If you want to set a key-value, and hope other nodes to get the value, Routing, sensor internal/external references are set by Parameter Service ParameterServer can set a parameter, and then you can get/list paramter(s) by start a ParameterClient to send responding request

警告

You should only have one ParameterServer works

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

成员类型定义说明

BoolResult

using apollo::cyber::ParameterServer::BoolResult = apollo::cyber::proto::BoolResult

在文件 parameter_server.h 第 49 行定义.

NodeName

using apollo::cyber::ParameterServer::NodeName = apollo::cyber::proto::NodeName

在文件 parameter_server.h 第 47 行定义.

Param

using apollo::cyber::ParameterServer::Param = apollo::cyber::proto::Param

在文件 parameter_server.h 第 46 行定义.

ParamName

using apollo::cyber::ParameterServer::ParamName = apollo::cyber::proto::ParamName

在文件 parameter_server.h 第 48 行定义.

Params

using apollo::cyber::ParameterServer::Params = apollo::cyber::proto::Params

在文件 parameter_server.h 第 50 行定义.

构造及析构函数说明

ParameterServer()

apollo::cyber::ParameterServer::ParameterServer ( const std::shared_ptr< Node > &  node )

explicit

Construct a new ParameterServer object

参数

node	shared_ptr of the node handler

在文件 parameter_server.cc 第 25 行定义.

    : node_(node) {
  auto name = node_->Name();
  get_parameter_service_ = node_->CreateService<ParamName, Param>(
      FixParameterServiceName(name, GET_PARAMETER_SERVICE_NAME),
      [this](const std::shared_ptr<ParamName>& request,
             std::shared_ptr<Param>& response) {
        std::lock_guard<std::mutex> lock(param_map_mutex_);
        if (param_map_.find(request->value()) != param_map_.end()) {
          response->CopyFrom(param_map_[request->value()]);
        } else {
          AINFO << "GetParameterService: [" << request->value() << "] not set";
        }
      });
 
  set_parameter_service_ = node_->CreateService<Param, BoolResult>(
      FixParameterServiceName(name, SET_PARAMETER_SERVICE_NAME),
      [this](const std::shared_ptr<Param>& request,
             std::shared_ptr<BoolResult>& response) {
        std::lock_guard<std::mutex> lock(param_map_mutex_);
        param_map_[request->name()] = *request;
        response->set_value(true);
      });
 
  list_parameters_service_ = node_->CreateService<NodeName, Params>(
      FixParameterServiceName(name, LIST_PARAMETERS_SERVICE_NAME),
      [this](const std::shared_ptr<NodeName>& request,
             std::shared_ptr<Params>& response) {
        std::lock_guard<std::mutex> lock(param_map_mutex_);
        for (auto& item : param_map_) {
          auto param = response->add_param();
          param->CopyFrom(item.second);
        }
      });
}

成员函数说明

GetParameter()

bool apollo::cyber::ParameterServer::GetParameter	(	const std::string &	parameter_name,
		Parameter *	parameter
	)

Get the Parameter object

参数

parameter_name	name of the parameer want to get
parameter	pointer to store parameter want to get

返回

true get parameter success

false parameter not exists

在文件 parameter_server.cc 第 66 行定义.

                                                         {
  std::lock_guard<std::mutex> lock(param_map_mutex_);
  auto ite = param_map_.find(parameter_name);
  if (ite == param_map_.end()) {
    return false;
  }
  parameter->FromProtoParam(ite->second);
  return true;
}

ListParameters()

void apollo::cyber::ParameterServer::ListParameters

(

std::vector< Parameter > *

parameters

)

get all the parameters

参数

parameters

result Paramter vector

在文件 parameter_server.cc 第 77 行定义.

                                                                     {
  std::lock_guard<std::mutex> lock(param_map_mutex_);
  for (auto& item : param_map_) {
    Parameter parameter;
    parameter.FromProtoParam(item.second);
    parameters->emplace_back(parameter);
  }
}

SetParameter()

void apollo::cyber::ParameterServer::SetParameter

(

const Parameter &

parmeter

)

Set the Parameter object

参数

parmeter

parameter to be set

在文件 parameter_server.cc 第 61 行定义.

                                                             {
  std::lock_guard<std::mutex> lock(param_map_mutex_);
  param_map_[parameter.Name()] = parameter.ToProtoParam();
}

---

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

• cyber/parameter/parameter_server.h
• cyber/parameter/parameter_server.cc