apollo::cyber::ParameterClient类 参考

Parameter Client is used to set/get/list parameter(s) by sending a request to ParameterServer 更多...

#include <parameter_client.h>

apollo::cyber::ParameterClient 的协作图:

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
using	GetParameterClient = Client< ParamName, Param >
using	SetParameterClient = Client< Param, BoolResult >
using	ListParametersClient = Client< NodeName, Params >

Public 成员函数
	ParameterClient (const std::shared_ptr< Node > &node, const std::string &service_node_name)
	Construct a new ParameterClient object
bool	GetParameter (const std::string &param_name, Parameter *parameter)
	Get the Parameter object
bool	SetParameter (const Parameter &parameter)
	Set the Parameter object
bool	ListParameters (std::vector< Parameter > *parameters)
	Get all the Parameter objects

详细描述

Parameter Client is used to set/get/list parameter(s) by sending a request to ParameterServer

在文件 parameter_client.h 第 39 行定义.

成员类型定义说明

BoolResult

using apollo::cyber::ParameterClient::BoolResult = apollo::cyber::proto::BoolResult

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

GetParameterClient

using apollo::cyber::ParameterClient::GetParameterClient = Client<ParamName, Param>

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

ListParametersClient

using apollo::cyber::ParameterClient::ListParametersClient = Client<NodeName, Params>

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

NodeName

using apollo::cyber::ParameterClient::NodeName = apollo::cyber::proto::NodeName

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

Param

using apollo::cyber::ParameterClient::Param = apollo::cyber::proto::Param

在文件 parameter_client.h 第 41 行定义.

ParamName

using apollo::cyber::ParameterClient::ParamName = apollo::cyber::proto::ParamName

在文件 parameter_client.h 第 43 行定义.

Params

using apollo::cyber::ParameterClient::Params = apollo::cyber::proto::Params

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

SetParameterClient

using apollo::cyber::ParameterClient::SetParameterClient = Client<Param, BoolResult>

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

构造及析构函数说明

ParameterClient()

apollo::cyber::ParameterClient::ParameterClient	(	const std::shared_ptr< Node > &	node,
		const std::string &	service_node_name
	)

Construct a new ParameterClient object

参数

node	shared_ptr of the node handler
service_node_name	node name which provide a param services

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

    : node_(node) {
  get_parameter_client_ = node_->CreateClient<ParamName, Param>(
      FixParameterServiceName(service_node_name, GET_PARAMETER_SERVICE_NAME));
 
  set_parameter_client_ = node_->CreateClient<Param, BoolResult>(
      FixParameterServiceName(service_node_name, SET_PARAMETER_SERVICE_NAME));
 
  list_parameters_client_ = node_->CreateClient<NodeName, Params>(
      FixParameterServiceName(service_node_name, LIST_PARAMETERS_SERVICE_NAME));
}

成员函数说明

GetParameter()

bool apollo::cyber::ParameterClient::GetParameter	(	const std::string &	param_name,
		Parameter *	parameter
	)

Get the Parameter object

参数

param_name
parameter	the pointer to store

返回

true

false call service fail or timeout

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

                                                         {
  auto request = std::make_shared<ParamName>();
  request->set_value(param_name);
  auto response = get_parameter_client_->SendRequest(request);
  if (response == nullptr) {
    AERROR << "Call " << get_parameter_client_->ServiceName() << " failed";
    return false;
  }
  if (response->type() == ParamType::NOT_SET) {
    AWARN << "Parameter " << param_name << " not exists yet.";
    return false;
  }
  parameter->FromProtoParam(*response);
  return true;
}

ListParameters()

bool apollo::cyber::ParameterClient::ListParameters

(

std::vector< Parameter > *

parameters

)

Get all the Parameter objects

参数

parameters

pointer of vector to store all the parameters

返回

true

false call service fail or timeout

在文件 parameter_client.cc 第 65 行定义.

                                                                     {
  auto request = std::make_shared<NodeName>();
  request->set_value(node_->Name());
  auto response = list_parameters_client_->SendRequest(request);
  if (response == nullptr) {
    AERROR << "Call " << list_parameters_client_->ServiceName() << " failed";
    return false;
  }
  for (auto& param : response->param()) {
    Parameter parameter;
    parameter.FromProtoParam(param);
    parameters->emplace_back(parameter);
  }
  return true;
}

SetParameter()

bool apollo::cyber::ParameterClient::SetParameter

(

const Parameter &

parameter

)

Set the Parameter object

参数

parameter

parameter to be set

返回

true set parameter success

false 1. call service timeout

1. parameter not exists The corresponding log will be recorded at the same time

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

                                                             {
  auto request = std::make_shared<Param>(parameter.ToProtoParam());
  auto response = set_parameter_client_->SendRequest(request);
  if (response == nullptr) {
    AERROR << "Call " << set_parameter_client_->ServiceName() << " failed";
    return false;
  }
  return response->value();
}

---

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

• cyber/parameter/parameter_client.h
• cyber/parameter/parameter_client.cc