apollo::cyber::ParameterServer Class Reference

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. More...

#include <parameter_server.h>

Collaboration diagram for apollo::cyber::ParameterServer:

Public Types
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 Member Functions
	ParameterServer (const std::shared_ptr< Node > &node)
	Construct a new ParameterServer object. More...
void	SetParameter (const Parameter &parmeter)
	Set the Parameter object. More...
bool	GetParameter (const std::string &parameter_name, Parameter *parameter)
	Get the Parameter object. More...
void	ListParameters (std::vector< Parameter > *parameters)
	get all the parameters More...

Detailed Description

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.

Warning

You should only have one ParameterServer works

Member Typedef Documentation

BoolResult

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

NodeName

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

Param

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

ParamName

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

Params

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

Constructor & Destructor Documentation

ParameterServer()

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

explicit

Construct a new ParameterServer object.

Parameters

node	shared_ptr of the node handler

Member Function Documentation

GetParameter()

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

Get the Parameter object.

Parameters

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

Returns

true get parameter success

false parameter not exists

ListParameters()

void apollo::cyber::ParameterServer::ListParameters

(

std::vector< Parameter > *

parameters

)

get all the parameters

Parameters

parameters

result Paramter vector

SetParameter()

void apollo::cyber::ParameterServer::SetParameter

(

const Parameter &

parmeter

)

Set the Parameter object.

Parameters

parmeter

parameter to be set

---

The documentation for this class was generated from the following file:

• cyber/parameter/parameter_server.h