apollo::cyber::plugin_manager::PluginDescription类 参考

#include <plugin_description.h>

apollo::cyber::plugin_manager::PluginDescription 的协作图:

Public 成员函数
	PluginDescription ()
	PluginDescription (const std::string &name)
	PluginDescription (const std::string &name, const std::string &description_index_path, const std::string &description_path, const std::string &actual_description_path, const std::string &library_path, const std::string &actual_library_path)
bool	ParseFromIndexFile (const std::string &file_path)
	parse plugin description metadata from plugin index file
bool	ParseFromDescriptionFile (const std::string &file_path)
	parse plugin description metadata from plugin description file

Public 属性
std::string	name_
std::string	description_index_path_
std::string	description_path_
std::string	actual_description_path_
std::string	library_path_
std::string	actual_library_path_
std::map< std::string, std::string >	class_name_base_class_name_map_

详细描述

在文件 plugin_description.h 第 25 行定义.

构造及析构函数说明

PluginDescription() [1/3]

apollo::cyber::plugin_manager::PluginDescription::PluginDescription

(

)

在文件 plugin_description.cc 第 34 行定义.

{}

PluginDescription() [2/3]

apollo::cyber::plugin_manager::PluginDescription::PluginDescription ( const std::string &  name )

explicit

在文件 plugin_description.cc 第 36 行定义.

: name_(name) {}

PluginDescription() [3/3]

apollo::cyber::plugin_manager::PluginDescription::PluginDescription	(	const std::string &	name,
		const std::string &	description_index_path,
		const std::string &	description_path,
		const std::string &	actual_description_path,
		const std::string &	library_path,
		const std::string &	actual_library_path
	)

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

    : name_(name),
      description_index_path_(description_index_path),
      description_path_(description_path),
      actual_description_path_(actual_description_path),
      library_path_(library_path),
      actual_library_path_(actual_library_path) {}

成员函数说明

ParseFromDescriptionFile()

bool apollo::cyber::plugin_manager::PluginDescription::ParseFromDescriptionFile

(

const std::string &

file_path

)

parse plugin description metadata from plugin description file

参数

file_path

plugin description file path

返回

true if parse success

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

                                                                           {
  if (this->description_path_.empty()) {
    this->description_path_ = file_path;
  }
 
  if (!apollo::cyber::common::GetFilePathWithEnv(
          this->description_path_, "APOLLO_PLUGIN_DESCRIPTION_PATH",
          &this->actual_description_path_)) {
    AWARN << "plugin index[" << file_path << "] name[" << this->name_
          << "] invalid, description[" << this->description_path_
          << "] file not found";
    return false;
  }
 
  tinyxml2::XMLDocument doc;
  if (doc.LoadFile(this->actual_description_path_.c_str()) !=
      tinyxml2::XML_SUCCESS) {
    AWARN << "plugin description[" << file_path << "] name[" << this->name_
          << "] invalid, parse description file failed";
    return false;
  }
  const tinyxml2::XMLElement* root = doc.RootElement();
  this->library_path_ = root->Attribute("path");
 
  std::string plugin_name =
      std::regex_replace(this->library_path_, std::regex("/"), "__");
  if (this->name_.empty()) {
    this->name_ = plugin_name;
  }
 
  // process class name and base class name from description file, this will be
  // used to build index fo lazy load
  for (const tinyxml2::XMLElement* class_element =
           root->FirstChildElement("class");
       class_element != nullptr;
       class_element = class_element->NextSiblingElement("class")) {
    std::string class_name = class_element->Attribute("type");
    std::string base_class_name = class_element->Attribute("base_class");
 
    if (this->class_name_base_class_name_map_.find(class_name) !=
        this->class_name_base_class_name_map_.end()) {
      AWARN << "plugin description[" << file_path << "] name[" << this->name_
            << "] invalid, class name[" << class_name << "] duplicated";
      continue;
    }
 
    if (class_name.empty() || base_class_name.empty()) {
      AWARN << "plugin description[" << file_path << "] name[" << this->name_
            << "] invalid, class name[" << class_name << "] base class name["
            << base_class_name << "] invalid";
      continue;
    }
    this->class_name_base_class_name_map_[class_name] = base_class_name;
  }
 
  if (!apollo::cyber::common::GetFilePathWithEnv(this->library_path_,
                                                 "APOLLO_PLUGIN_LIB_PATH",
                                                 &this->actual_library_path_)) {
    AWARN << "plugin description[" << file_path << "] name[" << this->name_
          << "] invalid, library[" << this->library_path_ << "] file not found";
    return false;
  }
 
  return true;
}

ParseFromIndexFile()

bool apollo::cyber::plugin_manager::PluginDescription::ParseFromIndexFile

(

const std::string &

file_path

)

parse plugin description metadata from plugin index file

参数

file_path

plugin index file path

返回

true if parse success

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

                                                                     {
  this->description_index_path_ = file_path;
  this->name_ = apollo::cyber::common::GetFileName(file_path);
 
  if (!apollo::cyber::common::GetContent(file_path, &this->description_path_)) {
    AWARN << "plugin index[" << file_path << "] name[" << this->name_
          << "] invalid, read index file failed";
    return false;
  }
  return ParseFromDescriptionFile(this->description_path_);
}

类成员变量说明

actual_description_path_

std::string apollo::cyber::plugin_manager::PluginDescription::actual_description_path_

在文件 plugin_description.h 第 30 行定义.

actual_library_path_

std::string apollo::cyber::plugin_manager::PluginDescription::actual_library_path_

在文件 plugin_description.h 第 32 行定义.

class_name_base_class_name_map_

std::map<std::string, std::string> apollo::cyber::plugin_manager::PluginDescription::class_name_base_class_name_map_

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

description_index_path_

std::string apollo::cyber::plugin_manager::PluginDescription::description_index_path_

在文件 plugin_description.h 第 28 行定义.

description_path_

std::string apollo::cyber::plugin_manager::PluginDescription::description_path_

在文件 plugin_description.h 第 29 行定义.

library_path_

std::string apollo::cyber::plugin_manager::PluginDescription::library_path_

在文件 plugin_description.h 第 31 行定义.

name_

std::string apollo::cyber::plugin_manager::PluginDescription::name_

在文件 plugin_description.h 第 27 行定义.

---

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

• cyber/plugin_manager/plugin_description.h
• cyber/plugin_manager/plugin_description.cc